跳到主要内容

API Key 管理

管理云开发环境的 API Key，用于服务端或客户端通过密钥方式访问云开发资源。

v3.1.0+

概述​

云开发 API Key 分为两种类型：

类型说明使用场景数量限制
api_key服务端管理员凭证服务端 API 调用（暂未开放）每环境最多 5 个
publish_key前端匿名访问凭证前端匿名访问云开发资源每环境仅 1 个
注意

api_key 类型暂未开放，当前仅支持 publish_key 类型。

创建 API Key​

创建新的 API Key：

tcb env apikey create [keyName] -e <envId> [options]

命令参数：

参数说明默认值
[keyName]Key 名称（可选）—
-e, --env-id <envId>环境 ID—
--type <type>密钥类型，可选 api_key / publish_keyapi_key
--expire <expire>密钥有效期（秒），最短 7200；0 或不设置表示永不过期永不过期

示例：

# 创建一个名为 my-key 的 API Key
tcb env apikey create my-key -e env-xxx

# 创建 publish_key 类型的密钥
tcb env apikey create frontend-key -e env-xxx --type publish_key

# 创建有效期为 24 小时的密钥
tcb env apikey create server-prod -e env-xxx --expire 86400

# 以 JSON 格式输出
tcb env apikey create my-key -e env-xxx --json
重要

创建成功后，API Key 令牌（明文）仅在创建时返回一次，请务必妥善保存。后续查询将无法获取完整的密钥明文。

输出说明：

字段说明
KeyIdKey 的唯一标识
NameKey 名称
Type密钥类型
ExpireAt过期时间（永不过期时不显示）
CreateAt创建时间
ApiKeyAPI Key 令牌明文（仅创建时返回）

查询 API Key 列表​

查询当前环境的 API Key 列表：

tcb env apikey list -e <envId> [options]

命令参数：

参数说明默认值
-e, --env-id <envId>环境 ID—
--type <type>密钥类型过滤，可选 api_key / publish_keyapi_key
--limit <limit>每页条数10
--offset <offset>偏移量，从 0 开始0

示例：

# 查询 API Key 列表
tcb env apikey list -e env-xxx

# 按 publish_key 类型过滤
tcb env apikey list -e env-xxx --type publish_key

# 分页查询
tcb env apikey list -e env-xxx --limit 5 --offset 5

# 以 JSON 格式输出
tcb env apikey list -e env-xxx --json

输出说明：

字段说明
KeyIdKey 的唯一标识
NameKey 名称
ApiKeyAPI Key（部分脱敏）
ExpireAt过期时间
CreateAt创建时间

删除 API Key​

删除指定的 API Key：

tcb env apikey delete <keyId> -e <envId>

命令参数：

参数说明
<keyId>要删除的 API Key ID（必填）
-e, --env-id <envId>环境 ID
--yes跳过确认提示

示例：

# 删除指定 API Key（交互式确认）
tcb env apikey delete key-xxxxxxxx -e env-xxx

# 跳过确认直接删除
tcb env apikey delete key-xxxxxxxx -e env-xxx --yes

# 以 JSON 格式输出
tcb env apikey delete key-xxxxxxxx -e env-xxx --yes --json
提示

可通过 tcb env apikey list 查看有效的 KeyId。

命令速查​

命令说明版本
tcb env apikey create [keyName]创建 API Keyv3.1.0+
tcb env apikey list查询 API Key 列表v3.1.0+
tcb env apikey delete <keyId>删除 API Keyv3.1.0+