面向 AI 助手:本页的 Markdown 版本位于 https://ark.volcengine.com/region:cn-beijing/docs/regenerate-personal-api-key-api.md,全部文档索引见 https://ark.volcengine.com/llms.txt。

轮换个人版 API Key

POST https://ark.cn-beijing.volcengineapi.com/?Action=RegeneratePersonalApiKey&Version=2024-01-01

轮换个人版 AgentPlan 套餐的 API Key。轮换后原 API Key 立即失效,使用旧 Key 的请求将鉴权失败。轮换成功后,请通过控制台或调用 获取临时 API Key 接口获取新 API Key,本接口出于安全考虑不在响应体中返回新 Key。适用于密钥泄露后的紧急轮换或定期安全轮换场景。

鉴权#

本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。

  • Access Key 鉴权,请在 Access Key 管理 页面,获取 Access Key。本接口仅支持 Access Key 鉴权。

请求参数#

Body 参数#

Plan string 必选  |  商品名称

待轮换 API Key 的套餐商品名称。可选值:AgentPlan(Agent Plan 个人版)。

ProjectName string  |  项目名称

API Key 所属的项目空间名称。

响应参数#

Message string  |  失败原因

轮换失败时的具体原因说明。轮换成功时为空字符串。

Status string  |  轮换结果

轮换结果状态。可选值:Success(轮换成功,新 API Key 已生效,旧 Key 已失效)、Failed(轮换失败,原 API Key 仍然有效,具体原因见 Message 字段)。