/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
该接口是查询最新数据,查询最新数据的方式有两种:
- Counter Method:该查询方式是基于data point counter的。
- 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所有的配置。