本文介绍修改 API Key 名称、切换启用/禁用状态的操作步骤。云服务范围与过期时间在创建后不可修改。
您可以修改 API Key 的名称(便于识别)和状态(在 已启用 与 已禁用 之间切换)。云服务(ServiceName) 和 过期时间(ExpirationTime) 在创建时即固定,不可修改。如需更换,请新建一个 API Key 并删除原凭证。
支持修改的字段
字段 | 是否可修改 | 说明 |
名称(ServiceCredentialName) | 支持 | 在控制台或调用 |
状态(Status) | 支持 | 在 |
云服务(ServiceName) | 不支持 | 创建时即固定。如需更换云服务,请新建 API Key。 |
过期时间(ExpirationTime) | 不支持 | 创建时设置后不可延长或缩短。如需更换有效期,请删除当前凭证并重新创建。 |
修改名称
登录 RAM 控制台,进入目标 RAM 用户的 凭证管理 标签页。
在 API Keys 列表的目标行的 名称 列右侧,单击 编辑 图标。
在 重命名 API Key 对话框中输入新名称,单击 确定。
启用与禁用
禁用后,API Key将失效,所有使用该凭证的 API 调用将失败。重新启用即可恢复使用。删除 API Key 前必须先禁用,详见删除 API Key。
在 RAM 控制台禁用
在目标 API Key 所在行的 操作 列单击 禁用。
在 禁用 确认对话框中确认提示信息("禁用 API Key {名称}?"),单击 禁用。
列表中该凭证状态变为 已禁用,操作列出现 启用 与 删除 按钮。
禁用是即时生效的破坏性操作,会中断使用该 API Key 的业务调用。请提前确认调用方已切换到其他凭证,再执行禁用。
在 RAM 控制台启用
在已禁用状态的 API Key 行单击 启用。
在 启用 确认对话框中单击 启用,状态恢复为 已启用。
已过期(Expired)的 API Key 不可启用,必须重新创建。
调用 OpenAPI 切换状态
调用 UpdateServiceCredential,传入新的 Status(Active 或 Inactive):
UpdateServiceCredential 参数说明
名称 | 类型 | 必填 | 说明 |
ServiceCredentialId | String | 是 | 服务凭证 ID。 |
UserPrincipalName | String | 是 | RAM 用户登录名,格式为 <用户名>@<账号别名>.onaliyun.com。 |
ServiceCredentialName | String | 否 | 新名称。不传表示不变更。 |
Status | String | 否 | 新状态,取值 |