请求结构

请求结构

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 如下表所示。