Token 管理

更新时间：2026-07-24

本页覆盖业务访问令牌的创建、重新生成、删除和列出接口。公共请求约定、PermissionSpec 和错误处理见数据库资源管理 API。

创建业务 Token

创建命名业务 Token 并授予 Database、Table 或 Token 管理权限。调用令牌需要 token:create 权限，且不能授予超出自身权限的权限。

Http

1POST /api/v3/configure/token
2Authorization: Bearer <token>
3Content-Type: application/json

请求体

                JSON
                
            

                {
  "token_name": "app_writer",
  "expiry_secs": 7776000,
  "permissions": [
    {
      "resource": "database",
      "identifiers": ["mydb"],
      "actions": ["read", "write"]
    }
  ]
}
            

字段	类型	必填	说明
`token_name`	string	是	Token 名称。
`expiry_secs`	number	否	从创建时间起计算的有效秒数。省略表示永不过期。
`permissions`	array	否	权限列表。空数组或省略表示 deny-all。

响应示例

成功返回 201 Created：

                JSON
                
            

                {
  "id": 3,
  "name": "app_writer",
  "token": "<plain-business-token>",
  "hash": "<token-hash>",
  "created_at": "2026-07-13T08:00:00Z",
  "expiry": "2026-10-11T08:00:00Z",
  "permissions": [
    {"resource": "database", "identifiers": ["mydb"], "actions": ["read", "write"]}
  ]
}
            

明文 token 只在本次成功响应中返回。请立即保存到凭证管理系统，不要写入日志、源码或工单。

重新生成业务 Token

为指定命名 Token 生成新的明文，并可选更新过期时间和权限。调用令牌需要 token:update 权限。

Http

1PUT /api/v3/configure/token
2Authorization: Bearer <token>
3Content-Type: application/json

请求体

                JSON
                
                {"token_name": "app_writer", "expiry_secs": 7776000}

字段	类型	必填	说明
`token_name`	string	是	要重新生成的 Token 名称。
`expiry_secs`	number	否	新的有效秒数。
`permissions`	array / null	否	省略或 `null` 表示保持原权限；空数组表示清空权限；其他值表示替换权限。

响应

成功返回 201 Created，响应结构与创建业务 Token 相同，并包含新的明文 token。

重新生成成功后旧 Token 立即失效。调用前应确认受影响应用，并在维护窗口内完成凭证切换。

删除业务 Token

删除指定命名 Token。调用令牌需要 token:delete 权限。

Http

1DELETE /api/v3/configure/token?token_name=app_writer
2Authorization: Bearer <token>

Query 参数

字段	类型	必填	说明
`token_name`	string	是	要删除的 Token 名称。

响应

删除成功返回 200 OK，响应体为空。

删除后依赖该 Token 的应用会失去访问权限。删除前请确认所有使用方已经切换到其他有效凭证。

列出业务 Token

列出集群中的命名 Token 及其权限和有效期。调用令牌需要 token:read 权限。

Http

1GET /api/v3/configure/token
2Authorization: Bearer <token>

响应示例

                JSON
                
            

                [
  {
    "id": 3,
    "name": "app_writer",
    "permissions": [
      {"resource": "database", "identifiers": ["mydb"], "actions": ["read", "write"]}
    ],
    "created_at_ms": 1783929600000,
    "expiry_ms": 1791705600000,
    "created_by_token_id": 1,
    "description": null
  }
]
            

字段	类型	说明
`id`	number	Token ID。
`name`	string	Token 名称。
`permissions`	array	权限列表。
`created_at_ms`	number	创建时间，Unix epoch 毫秒。
`expiry_ms`	number / null	过期时间，Unix epoch 毫秒；`null` 表示永不过期。
`created_by_token_id`	number / null	创建者 Token ID。
`description`	string / null	Token 描述。

列表响应不包含明文 Token 或可用于恢复明文的值。

评价此篇文章

有帮助没帮助

百度智能云

时序时空数据库 TSDB

时序时空数据库 TSDB

Token 管理

创建业务 Token

请求体

响应示例

重新生成业务 Token

请求体

响应

删除业务 Token

Query 参数

响应

列出业务 Token

响应示例