You need to enable JavaScript to run this app.
文档中心
访问控制

访问控制

复制全文
下载 pdf
API Key
DeleteApiKey - 删除 API 密钥
复制全文
下载 pdf
DeleteApiKey - 删除 API 密钥

删除指定的 API 密钥。仅禁用状态(inactive)的 API 密钥可以被删除,启用状态的密钥需先禁用后再删除。

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

DeleteApiKey

要执行的操作,取值:DeleteApiKey。

Version
String

2018-01-01

API的版本,取值:2018-01-01。

UserName
String

Bob

用户名。用于删除指定 IAM 用户的 API 密钥。

Id
String

Ab3kX9mN******vQ

API 密钥 ID。

返回参数

本接口无特有的返回参数。更多信息请见返回结构

请求示例

POST /?Action=DeleteApiKey&Version=2018-01-01 HTTP/1.1
Host: iam.volcengineapi.com
Content-Type: application/x-www-form-urlencoded
X-Date: 20260314T054545Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260314/cn-beijing/iam/request, SignedHeaders=content-type;host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

UserName=Bob&Id=Ab3kX9mN******vQ

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20260314054545010225146063063CE58B",
    "Action": "DeleteApiKey",
    "Version": "2018-01-01",
    "Service": "iam",
    "Region": "cn-beijing"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
InvalidParameter

The parameter '%s' in request is invalid, error: %v.

无效参数!

404
UserNotExist

User '%s' does not exist.

用户不存在。

404
ApiKeyNotExist

The API key does not exist

API 密钥不存在。

409
ApiKeyUndeletable

Active API key cannot be deleted. Please set it to inactive first.

启用状态的 API 密钥无法直接删除,请先将密钥状态设置为禁用(inactive)。

最近更新时间:2026.06.24 17:25:06
这个页面对您有帮助吗?
有用
有用
无用
无用