Database 管理
更新时间:2026-07-24
本页覆盖 Database 的列出、创建、Retention 查看与更新和删除接口,其中查看 Retention 接口同时返回 Table 级设置。公共请求约定、PermissionSpec 和错误处理见数据库资源管理 API。
列出 Database
列出当前访问令牌可见的 Database。
Http
1GET /api/v3/configure/database?format=json
2Authorization: Bearer <token>
Query 参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
format |
string | 否 | 输出格式。省略时按 Accept 协商,未提供 Accept 时默认为 json。 |
响应示例
JSON
1[
2 {"database": "mydb"},
3 {"database": "metrics"}
4]
响应只包含当前令牌有权查看的 Database,不应使用结果差异探测未授权资源。
创建 Database
创建 Database,并可选设置 Database 级 Retention。调用令牌需要目标 Database 的 manage 权限。
Http
1POST /api/v3/configure/database
2Authorization: Bearer <token>
3Content-Type: application/json
请求体
JSON
1{"db": "mydb", "retention_period": "30d"}
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
db |
string | 是 | Database 名称。 |
retention_period |
string | 否 | Retention 时长。省略或 null 表示永久保留。 |
响应
创建成功返回 200 OK,响应体为空。Database 已存在时返回 409。
创建前请确认名称和 Retention。缩短 Retention 会影响历史数据保留范围。
查看 Retention
查看 Database 和 Table 的 Retention 设置及其来源。
Http
1GET /api/v3/configure/retention?db=mydb&format=json
2Authorization: Bearer <token>
Query 参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
db |
string | 否 | 目标 Database。省略时列出当前令牌可见的 Database。 |
format |
string | 否 | 输出格式。 |
响应示例
JSON
1[
2 {"database": "mydb", "table": "", "retention": "30d", "source": "database"},
3 {"database": "mydb", "table": "cpu", "retention": "7d", "source": "table"}
4]
Database 级记录的 table 为空。source 为 database、table 或 none,表示当前有效设置的来源。
更新 Database Retention
更新 Database 级 Retention。调用令牌需要目标 Database 的 manage 权限。
Http
1PUT /api/v3/configure/database
2Authorization: Bearer <token>
3Content-Type: application/json
请求体
JSON
1{"db": "mydb", "retention_period": "7d"}
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
db |
string | 是 | Database 名称。 |
retention_period |
string / null | 否 | 省略表示不更新;null 表示清除并恢复永久保留;其他值表示设置新的 Retention。 |
响应
更新成功返回 200 OK,响应体为空。
缩短 Retention 前请确认业务和合规要求。处于新保留范围之外的数据可能进入删除范围。
删除 Database
永久删除指定 Database 及其中的数据。调用令牌需要目标 Database 的 manage 权限。
Http
1DELETE /api/v3/configure/database?db=mydb&scope=full
2Authorization: Bearer <token>
Query 参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
db |
string | 是 | 要删除的 Database 名称。 |
scope |
string | 是 | 当前仅支持 full,表示永久删除。 |
响应
删除成功返回 200 OK,响应体为空。
该操作不可恢复。自动化程序应对精确 Database 名称设置人工审批或等价保护,不使用模糊匹配执行批量删除。
评价此篇文章
