概述
更新时间:2026-07-24
数据库资源管理 API 用于管理 Database、Table、Retention 和业务访问令牌。当前不提供这些能力的管理 SDK;自动化程序可以直接调用 API,人工操作推荐使用 tsdb-cli。
接口清单
| 资源 | 能力 | Method | URL | 参考 |
|---|---|---|---|---|
| Database | 列出 | GET |
/api/v3/configure/database |
接口说明 |
| Database | 创建 | POST |
/api/v3/configure/database |
接口说明 |
| Database | 更新 Retention | PUT |
/api/v3/configure/database |
接口说明 |
| Database | 删除 | DELETE |
/api/v3/configure/database |
接口说明 |
| Retention | 查看 | GET |
/api/v3/configure/retention |
接口说明 |
| Table | 列出 | GET |
/api/v3/configure/table |
接口说明 |
| Table | 创建 | POST |
/api/v3/configure/table |
接口说明 |
| Table | 更新 Retention | PUT |
/api/v3/configure/table |
接口说明 |
| Table | 删除 | DELETE |
/api/v3/configure/table |
接口说明 |
| Token | 创建 | POST |
/api/v3/configure/token |
接口说明 |
| Token | 重新生成 | PUT |
/api/v3/configure/token |
接口说明 |
| Token | 删除 | DELETE |
/api/v3/configure/token |
接口说明 |
| Token | 列出 | GET |
/api/v3/configure/token |
接口说明 |
所有请求使用集群详情页显示的连接地址,并携带具有相应权限的访问令牌。
公共请求约定
- 推荐使用
Authorization: Bearer <token>请求头。 - 创建或重新生成的令牌明文以
apiv3_开头,并且只返回一次,请立即保存。 - JSON 请求体使用
Content-Type: application/json,字段使用snake_case。 - 列举和查看接口的
format支持pretty、json、json_lines(别名jsonl)、csv和parquet;省略时根据Accept协商,未提供Accept时默认返回 JSON。 - 请求体大小受集群服务限制,默认上限为 10 MiB;gzip 请求按解压后的大小计算,超出限制返回
413。
Retention 格式
Retention 使用时长字符串,支持 h、d、w、mo 和 y 组合,例如 30d、2w3d、1y6mo。数据库级 null 表示永久保留;表级 null 表示清除表级设置并继承数据库。
PermissionSpec
业务 Token 可以使用以下三类权限结构:
JSON
1{"resource":"database","identifiers":["mydb"],"actions":["read","write"]}
2{"resource":"table","identifier":{"db":"mydb","table":"cpu"},"actions":["read","write"]}
3{"resource":"token","actions":["create","read","update","delete"]}
resource |
资源标识 | 支持的 actions |
|---|---|---|
database |
identifiers 为 "*" 或数据库名数组 |
read、write、manage、* |
table |
identifier 包含 db 和 table |
read、write、* |
token |
无资源标识 | create、read、update、delete、* |
创建 Token 时不能授予超出当前调用令牌自身权限的权限。
错误处理
数据库资源管理 API 的错误响应可能是 JSON 错误对象,也可能是纯文本。客户端应先按 HTTP 状态码分类,并同时兼容两种响应体。
| 状态码 | 典型原因 |
|---|---|
400 |
参数缺失、名称或 Retention 格式非法、权限结构非法。 |
401 |
缺少或使用了无效 Token。 |
403 |
权限不足或请求尝试提升权限。 |
404 |
Database、Table 或 Token 不存在,或对调用方不可见。 |
409 |
资源已存在或当前操作冲突。 |
413 |
请求体超过服务限制。 |
415 |
请求体 Content-Type 不受支持。 |
504 |
Catalog 操作超时。 |
删除与 Retention 风险
- 删除数据库或表会删除对应数据,调用前必须核对目标资源。
- 缩短 Retention 会改变历史数据的保留范围。
- 自动化删除应设置人工审批或等价保护,不根据名称模糊匹配批量执行。
评价此篇文章
