删除 API Key

更新时间:
复制 MD 格式

本文介绍删除 API Key 的前置条件与操作步骤。删除 API Key 前必须先将其禁用,删除后凭证将失效并销毁,且无法恢复。

删除 API Key 后,凭证将失效并销毁,使用该凭证的 OpenAPI 调用也会失败,且无法恢复。建议先禁用并观察一段时间,确认无业务依赖后再删除。

前置条件

  • API Key 处于已禁用状态:处于 已启用 的 API Key 无法直接删除,控制台 移入回收站 按钮置灰。请先完成禁用。

  • 具备删除权限:根据使用场景不同,权限要求不同:

    • 为自己删除:需同时满足以下两个条件:

      1. 阿里云主账号已允许 RAM 用户自主管理 API Key。开启方式:

        • 控制台:登录 RAM 控制台,进入 安全设置,开启 允许 RAM 用户自主管理 API Key

        • API:调用 SetSecurityPreference,将参数 AllowUserToManageServiceCredential 设为 true

      2. 当前 RAM 用户未被管理员通过权限策略明确禁止管理 API Key(即所绑定的权限策略中,不存在针对 API Key 相关操作的 Deny 声明)。

    • 为他人删除:操作者已被授予包含 ram:DeleteServiceCredential 操作的权限策略。如需限定到特定云服务,可在策略中通过 Condition 配置 ram:ServiceCredentialServiceName 条件键。

警告

删除是不可逆操作。请确认所有调用方已切换到其他凭证,再执行删除。

在 RAM 控制台删除

  1. 登录 RAM 控制台,进入目标 RAM 用户的 凭证管理 标签页。

  2. 如目标 API Key 处于 已启用 状态,先在操作列单击 禁用 并完成禁用。

  3. 在操作列单击 移入回收站

  4. 删除 对话框中,按提示在输入框中输入当前 AccessKey 的 ID以二次确认。

    重要

    AccessKey ID 必须完全匹配。输入正确后 移入回收站 按钮才会启用。

  5. 单击 移入回收站。系统提示"移入回收站成功",列表中该凭证消失。

调用 OpenAPI 删除

调用 DeleteServiceCredential 删除 API Key。删除前请确认 StatusInactive,否则会返回错误。

名称

类型

必填

说明

ServiceCredentialId

String

服务凭证 ID。

UserPrincipalName

String

RAM 用户登录名,格式为 <用户名>@<默认域名>.onaliyun.com 或 <用户名>@<自定义域名>。

删除影响

  • 请求失效:使用该 API Key 调用绑定云服务 OpenAPI 的所有请求将失败。请提前完成应用侧的凭证轮转。

  • 不可恢复:删除后无法通过任何方式恢复原 API Key。如仍需要使用,请重新创建。

  • RAM 用户删除校验:删除 RAM 用户时,系统会校验该用户名下是否仍存在 API Key。如存在,必须先删除该用户名下的所有 API Key 后才能删除用户。