OpenTSDB 開發指南之 Api操作數據

 

 

/api/put

• 請求方式：post
• 請求參數：

參數	說明	example
summary	返回主要摘要	/api/put?summary
details	返回詳細信息	/api/put?details
sync	是否同步，即是否等待數據都寫入成功後才返回結果	/api/put?sync
sync_timeout	返回結果之前的等待時間	/api/put/?sync&sync_timeout=60000

請求body

名稱	類型	描述
metric	String	要存儲指標的名稱
timestamp	Integer	以秒或者毫秒爲單位的時間戳
value	Integer/Float	時序數據庫的值
tags	Map	本條數據的tags

單條數據的寫入例子：

{
    "metric": "sys.cpu.nice",
    "timestamp": 1346846400,
    "value": 18,
    "tags": {
       "host": "web01",
       "dc": "lga"
    }
}

寫入多條數據的例子：

[
    {
        "metric": "sys.cpu.nice",
        "timestamp": 1346846400,
        "value": 18,
        "tags": {
           "host": "web01",
           "dc": "lga"
        }
    },
    {
        "metric": "sys.cpu.nice",
        "timestamp": 1346846400,
        "value": 9,
        "tags": {
           "host": "web02",
           "dc": "lga"
        }
    }
]

Response
tsdb寫入成功默認返回的http狀態碼是204，也就是返回的body爲空。若想要知道更詳細的結果可以在請求路徑上加上summary或者details參數。

 

/api/query

查詢數據的接口，也是用的最多的接口。

• 請求方式：get、post、delete，注意:從opentsdb2.2版本開始，若用delete查詢數據，則在返回數據的同時會刪除數據，第二次就查詢結果則爲空。

參考：https://datamining.blog.csdn.net/article/details/105879150

 

/api/query/last

該接口是查詢最新數據，查詢最新數據的方式有兩種：

1. Counter Method：該查詢方式是基於data point counter的。
2. Back Scan：設定一個掃描的時間，從當前時刻往後掃描。

請求body中的backScan即代表往後掃描24小時，當backScan爲0時表示採用第一種查詢方式。resolveNames=true時，會把數據的metric，tags，tsuid也一起返回回來。

 

{
    "queries": [
        {"metric":"sys.cpu.nice","tags":{"host":"web01","dc":"lga"}}
    ],
    "resolveNames":true,
    "backScan":24
}

 

 

/api/dropcaches

• 請求方式：get、post
• 請求參數：無
  該接口的作用是清理tsdb的內存，主要是清理UID到metric、tags，和metric、tags到UID的映射關係，需要注意的是這個接口並不會清理磁盤上的緩存。

 

/api/config

• 請求方式：get、post
• 請求參數：無
  該接口以key/value的方式返回tsdb所有的配置。