跳到主要内容
版本:26.x

API Keys

API Keys 页面用于创建和管理 SelectDB Cloud 管控 API 的程序化访问凭证。API Key 的权限与创建时选择的角色保持一致,不包含直接访问数据库的权限。

API Keys 列表页

创建 API Key

点击右上角 + 创建 API Key,在弹出的对话框中填写以下信息:

  • 名称(必填):用于标识该 Key 的显示名称。

  • 角色(必填):该 Key 所具有的权限等级,内置三种角色:

    角色权限说明
    Organization Admin(组织管理员)执行组织的所有管理活动,包括组织管理、访问控制、费用中心等。
    Warehouse Admin(仓库管理员)管理仓库(新建、查看、修改、删除),并具有数据库的管理员权限。
    Warehouse Viewer(仓库只读者)对所有仓库具有只读权限,默认不授予数据库权限,访问数据库需要单独提供数据库凭证。
  • 有效期(必填):Key 的有效时长,可选 30 天90 天1 年自定义永久

点击 确认 生成 Key。Key 值仅在创建时展示一次,请立即复制并妥善保存。

创建 API Key

管理已有 API Key

API Keys 列表展示组织内所有 Key 的信息:

字段说明
名称创建时设置的显示名称。
Key ID脱敏后的标识符(如 sk-b****V59R),可一键复制。
角色创建时绑定的角色。
状态已启用(正常使用)或 已禁用(暂停访问)。
最近使用最近一次成功调用 API 的时间,未使用则显示
到期时间Key 的过期日期和时间。

操作列提供以下三个操作:

  • 编辑(铅笔图标):修改 Key 名称或更新有效期。
  • 启用/禁用(开关):临时暂停或恢复 Key 的访问权限,不影响 Key 本身。
  • 删除(删除图标):永久删除该 Key,操作不可撤销。

使用管控 API

获取 API Key 后,在每次请求的 Authorization 请求头中携带 Key 即可完成认证:

Authorization: Bearer <your-api-key>

完整的接口列表、请求/响应结构及在线调试,请参考 SelectDB Cloud Management API Reference