請求結構
請求結構
TSDB 實例訪問鏈接
TSDB 實例地址在實例詳情頁可以查到, 例如“ts-xxx.hitsdb.rds.aliyuncs.com:8242”。
通信協議
支持通過 HTTP 通道進行請求通信。
請求方法
TSDB 支持 HTTP POST 方法發送請求。
請求路徑
每個請求必須指定請求的 API 路徑,即通過 API 要執行的具體操作,例如 /api/delete_data
。
請求參數
TSDB 的寫入類請求可以指定請求參數,通過請求參數確定寫入請求的返回內容和寫入超時時間。
請求頭
自引擎版本v2.5.13以來,TSDB開始支持用戶鑒權功能。對于開啟了用戶鑒權功能的實例,發送面向TSDB的查詢或寫入請求時,需要在請求頭指定操作所使用的用戶認證信息。
有關TSDB的用戶鑒權功能,請參見用戶管理。
請求內容
TSDB 的請求需要指定請求內容,通過請求內容確定要訪問的數據和要進行的操作。
請求標準
TSDB 的 HTTP API 本質上是 RESTful 的,也就是說需要 HTTP method/verb 來決定一個操作行為,來遵循 REST 風格。例如,GET 請求應該只返回數據,PUT 或 POST 應該修改數據,DELETE 應該刪除數據。
然而,在某些情況下,如 DELETE 和 PUT 等動詞會被防火墻、代理過濾,或未在客戶端中實現。此外,大多數開發人員習慣于使用 GET 和 POST。因此,TSDB API 支持通過添加查詢字符串參數 method_override 來替代 HTTP methods/verbs。這個參數允許客戶端通過 query string 調用大部分 API,而不是 HTTP Content Body。例如,您可以通過這個查詢字符串來替代 GET 刪除數據/api/delete_meta?m=cpu.usage&method_override=delete
。
HTTP methods/verbs 和對應的 overrides 如下表所示。
HTTP METHOD | 描述 | 替代參數 |
---|---|---|
GET | 獲取數據 | N/A |
POST | 提交數據 | method_override=post |
PUT | 覆蓋數據 | method_override=put |
DELETE | 刪除數據 | method_override=delete |