管理 API Key
API Key 在开发者控制台的 API Key 页统一管理。页面列出你账户下所有未删除的 Key,以及每个 Key 的状态、本月消耗和最近使用时间。
创建 API Key
Section titled “创建 API Key”-
点击右上角「创建 API Key」。
-
填写:
- 名称:用来区分用途,建议按环境或项目命名,如「生产环境」「数据看板」。最长 128 个字符。
- 有效期:永不过期、30 天、90 天、180 天、1 年,或自定义到期日期。有效期创建后不能修改,需要更换只能重置或新建。
-
点「创建」。弹窗显示完整的 Key。完整 Key 只显示这一次:立即复制并保存到你的密钥管理处,关闭弹窗后无法再次查看。
-
可以在弹窗里点「试一下」,用这个 Key 查询支持的平台,确认 Key 可用(不消耗点数)。
每个账户最多保留 10 个未删除的 Key(含已停用、已过期的),达到上限后需要先删除不用的 Key。当前上限以页面顶部的提示为准。
Key 列表
Section titled “Key 列表”| 列 | 说明 |
|---|---|
| 名称 | 创建或编辑时填写的名称 |
| API Key | Key 的前 12 个字符,用来区分不同的 Key;完整 Key 不再显示 |
| 状态 | 启用、已停用、已过期;即将过期时会提示剩余天数 |
| 本月消耗(点) | 本自然月(北京时间)用这个 Key 成功调用扣除的点数 |
| 最近使用 | 最近一次用这个 Key 成功通过鉴权的时间;从未使用显示「从未使用」 |
从操作菜单的「查看调用日志」可以直接跳到这个 Key 的调用记录。
只能修改名称。Key 本身和有效期都不能修改。
- 停用:使用这个 Key 的请求会立即被拒绝(
ret 1030)。可以随时重新启用。适合暂时不用、或怀疑有异常调用时先止损。 - 启用:恢复已停用的 Key。已过期的 Key 不能启用,请新建。
重置 Key
Section titled “重置 Key”重置会生成一个新 Key,用于定期轮换或在怀疑泄露时更换:
-
在操作菜单点「重置 Key」。
-
选择旧 Key 失效时间:立即失效、1 小时后、24 小时后(默认)或 7 天后。宽限期内新旧 Key 都能用,你可以先把新 Key 部署上线,再让旧 Key 自然失效。
-
确认后弹窗显示新 Key 的完整内容,同样只显示这一次。
重置的规则:
- 新 Key 沿用旧 Key 的名称和到期时间,在列表中是一条新记录;旧 Key 保留在列表中,宽限期结束后变为已过期(选择「立即失效」时直接变为已停用)。
- 旧 Key 的失效时间取「现在 + 宽限期」与它原本到期时间中较早的一个。
- 只能重置启用中且未过期的 Key;已停用的请先启用,已过期的请新建。
- Key 数量已达上限时仍可重置一次;超过上限后需要先删除不用的旧 Key 才能再次重置。
- 重置前用旧 Key 提交的任务,不会出现在新 Key 的任务列表里,但仍可以凭
task_id查询。
删除后无法恢复,使用这个 Key 的请求会立即被拒绝(ret 1030)。只是暂时不用的话,建议停用。
删除后,这个 Key 提交过的任务仍然保留:调用日志和用量统计里照常显示 Key 的名称和前缀,任务也可以用其他有效 Key 按 task_id 查询。
对进行中任务的影响
Section titled “对进行中任务的影响”停用、删除 Key,或 Key 到期、重置宽限期结束后:
- 用这个 Key 提交、但还在排队(
queued)未派发的任务,派发时会失败(error_code为credential_invalid),不扣点数。 - 已经派发给平台执行的任务照常完成。
- 不要把 Key 写进网页前端、小程序、App 安装包或公开的代码仓库,在服务端通过环境变量读取。
- 按环境、项目分别创建 Key,单个 Key 泄露时停用或重置它即可,不影响其他调用。
- 怀疑泄露时立即重置;需要平滑替换时给旧 Key 留出宽限期。
更多说明见认证与 API Key。
认证与 API Key请求头格式、Key 的权限范围与鉴权失败排查。
调用日志与用量按 Key 查看调用明细与点数消耗。
