API
- TSDBase 提供 https 呼叫API，呼叫方式:
https://tsdbase02.asuswebstorage.com/tsdbase/entry，由 request header
X-Omni-Action 指定操作動作。
- 使用流程:
- 透過 X-Omni-Action: PutEntries 存放資料。
- 透過 X-Omni-Action: Query 讀取資料。
資料型態
| 型態 |
說明 |
| DateTime |
時間字串，格式
yyyy-MM-dd HH:mm:ss。 |
| HASH |
數值字串，僅允許作為 KEY 使用 |
| RANGE |
有限長度字串，僅允許作為 KEY 使用 |
| Number |
數值字串，僅允許作為 Attribute 使用 |
| String |
有限長度字串 |
| Boolean |
布林值，
true|
false，僅允許作為 Attribute 使用 |
| Integer |
4bytes 整數，範圍 -2147483648 ~ 2147483647 |
| Unsigned Integer |
4bytes 無號整數，範圍 0 ~ 2147483647 |
| Long |
長整數，範圍 -9223372036854775807 ~ 9223372036854775807 |
| Unsigned Long |
8bytes 無號長整數，範圍 0 ~ 9223372036854775807 |
| Double |
浮點數，範圍 -1.7976931348623158E+308 ~ 1.7976931348623158+308，僅允許作為 Attribute 使用 |
| Unsigned Double |
無號浮點數，範圍 0 ~ 1.7976931348623158E+308，僅允許作為 Attribute 使用 |
API Request Header
API Response Header
Query Operator
- Query Operator 用於 keyconditions ，可定義每一個 condition 查詢條件。
| 運算條件 |
說明 |
值域型態 |
| = |
等於，型態需與設定欄位相同 |
單一值 |
| BETWEEN |
範圍查詢，包含前後值，型態需與設定欄位相同 |
LIST，size 為 2 |
| <> |
不等於，同部分 SQL 版本支援之
!=
|
單一值 |
| > |
大於，型態需與設定欄位相同 |
單一值 |
| < |
小於，型態需與設定欄位相同 |
單一值 |
| >= |
不小於(大於或等於)，型態需與設定欄位相同 |
單一值 |
| <= |
不大於(小於或等於)，型態需與設定欄位相同 |
單一值 |
| LIKE |
查詢某種 pattern，需用
% 至於前或後或是同時 |
單一值 |
| IN |
查詢內容於列表內 |
List (1至多個) |
| NOT IN |
查詢內容不在列表內 |
List (1至多個) |
範例
{
"schemaname": "schema_template",
"keyconditions" : [ [ "time", "BETWEEN", [ "2016-02-23 14:15:17", "2016-02-23 14:15:18" ] ], [ "name", "=", "tsdBtestAccount" ], [ "status", "IN", ["OPEN","INIT"], [ "alias", "<>", " "] ] ]
}
- PutEntries Action 是用以置放一筆至多筆資料(entries)。
- 無論一筆資料或是多筆資料，TSDBase 處理時間之差異甚微，因此建議善加利用 batch 方式上傳資料。
Request
POST / HTTP/1.1
X-Omni-Sid: {SID}
X-Omni-Action: PutEntries
X-Omni-Service: {Service Name}
Authorization: {Authorization String}
{
"schemaname": "schema_template",
"entries": [{"number":"123","ulong":9223372036854775807,"deleted":true,"test":"2017-11-09 10:10:26","uinteger":2147483647,"double":-1.7976931348623157,"udouble":1.7976931348623157,"integer":-2147483648,"time":"2017-11-09 10:10:26","value":"abc123","long":-9223372036854775807}]
}
Response
HTTP/1.1 200
X-Omni-RequestId:826c8c47b4765eb2b7abb8b553a5a13d
X-Omni-Status:0
X-Omni-Status-Message:SUCCESS
{}
- 用來查詢 schema entries 資料，需透過 keyconditions 指定查詢條件(condition)，condition 包含了 attribute name 與 query operator 與 query
value，例如：[
attrubute_name,
query_operator,
query_value]
對於條件格式的進一步說明，請參考
Query Operator 單元。
- 查詢時可利用 query_attributes 來過濾查詢得出的欄位，透過減量來降低資料傳輸時間。
- 如資料筆數過多影響了查詢效率，可使用 limit 來限制資料筆數。
- 基本查詢: 查詢 key 值，以 query operator
= 指定要某一 attribute (通常為 deviceid, asusaccount 或是 userid)，或以 query operator
BETWEEN 指定查詢時間範圍。
- [小提示] 若查詢結果之資料量過大而導致了 timeout，請延長客戶端 timeout 設定，TSDBase 不會因資料量過大而放棄回應。
- [小叮嚀] 請勿使用 TSDBase API 設計 heartbeat Query 功能，如觸發系統防禦機制，將會導致 SID 被鎖定之後停權。
Request
POST / HTTP/1.1
X-Omni-Sid: {SID}
X-Omni-Action: Query
X-Omni-Service: {Service Name}
Authorization: {Authorization String}
{
"schemaname": "test",
"limit" : 100,
"query_attributes" : ["deleted","time","integer","uinteger","long","ulong","double","udouble","number"],
"keyconditions" : [["time","BETWEEN",["2016-10-01 00:00:00","2017-11-09 10:34:26"]]]
}
Response
HTTP/1.1 200
X-Omni-RequestId: 961da734cef9dd53856b308c083e1a21
X-Omni-Status: 0
X-Omni-Status-Message: SUCCESS
{
"schemaname": "test",
"entries": [{"number":"123","ulong":9223372036854775807,"deleted":true,"uinteger":2147483647,"double":-1.7976931348623157,"udouble":1.7976931348623157,"integer":-2147483648,",time":"2017-11-09 10:10:26","long":-9223372036854775807}]
}