API 概述
更新时间:2026-07-24
TSDB 专享版提供三类 API。它们的资源、认证方式和字段风格不同,调用时不要混用。
| API 类型 | 用途 | 路径或协议 | 认证 |
|---|---|---|---|
| 集群生命周期 OpenAPI | 创建、查询、改名、变配、续费、升级、EIP、释放、操作记录和管理员访问令牌 | /v1/dedicated/cluster... |
云账号 AK/SK 签名认证(BCE 签名) |
| 数据读写 API | Line Protocol 写入、HTTP SQL 和 Flight SQL 查询 | /api/v3/write_lp、/api/v3/query_sql、Flight gRPC |
TSDB 访问令牌 |
| 数据库资源管理 API | Database、Table、Retention 和业务 Token 管理 | /api/v3/configure/* |
TSDB 访问令牌及对应权限 |
TSDB 专享版当前不提供集群生命周期管理 SDK。集群生命周期自动化可直接调用 OpenAPI;数据库资源管理可调用 V3 API,也可以使用 tsdb-cli。
Endpoint
- 集群生命周期 OpenAPI Endpoint 为
https://tsdb.{region}.baidubce.com。当前支持北京(bj)和广州(gz)地域:北京使用https://tsdb.bj.baidubce.com,广州使用https://tsdb.gz.baidubce.com。 - 数据读写和数据库资源管理使用集群详情页显示的连接地址。
不要把集群数据地址当作 OpenAPI Endpoint,也不要把 OpenAPI Endpoint 配置为 SDK 的数据连接地址。
集群生命周期 OpenAPI 使用云账号 AK/SK 进行百度智能云 BCE 签名认证。签名请求至少包含 Host、Authorization 和 x-bce-date 请求头;签名字符串的生成规则参见百度智能云 API 鉴权认证机制。以下示例省略了签名值的计算过程:
Http
1GET /v1/dedicated/cluster/create-options?region=bj HTTP/1.1
2Host: tsdb.bj.baidubce.com
3Authorization: bce-auth-v1/<access-key-id>/<timestamp>/<expire-time>/<signed-headers>/<signature>
4x-bce-date: <UTC timestamp>
错误处理
集群生命周期 OpenAPI 错误响应包含 requestId、code 和 message。排查时同时保存 HTTP 状态码和这三个字段。
数据读写与数据库资源管理两类 V3 API 可能返回 JSON 错误对象或纯文本错误。客户端应先根据 HTTP 状态码分类,再兼容解析两种响应体,不要假设所有错误都具有相同 JSON 结构。
生产调用应设置连接和请求超时,并只对明确可重试的失败进行指数退避。创建或变更资源时,不要在未查询订单和资源状态前盲目重试。
评价此篇文章
