UpdateAccessKey - 更新访问密钥状态--访问控制-火山引擎

文档中心

立即注册

导航

UpdateAccessKey - 更新访问密钥状态

最近更新时间：2024.09.14 14:54:46首次发布时间：2021.02.23 10:42:32

更新指定访问密钥的状态。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	UpdateAccessKey	要执行的操作，取值：UpdateAccessKey。
Version	String	是	2018-01-01	API的版本，取值：2018-01-01。
UserName	String	否	Bob	密钥所属IAM用户的用户名。当IAM用户拥有密钥自管理权限时（AccessKeySelfManageAccess），如需更新自身的密钥，则需要在请求中传递IAM用户自身的UserName。
AccessKeyId	String	是	AKLTZjIwYzBjYzczNWQ4NDkwN******3NzViZTgzZDAxYjE	密钥ID（Access Key Id）。
Status	String	是	inactive	密钥状态。active代表启用状态，inactive代表禁用状态。

返回参数

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

请求示例

GET /?Action=UpdateAccessKey&Version=2018-01-01&AccessKeyId=AKLTZjIwYzBjYzczNWQ4NDkwN******3NzViZTgzZDAxYjE&Status=inactive HTTP/1.1
Host: iam.volcengineapi.com
X-Date: 20240912T120700Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240912/cn-beijing/iam/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240912200752176157240117AEDB06",
    "Action": "UpdateAccessKey",
    "Version": "2018-01-01",
    "Service": "iam",
    "Region": "cn-beijing"
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	InvalidAccessKeyId	Invalid accessKeyId '%s', err: '%s'	密钥ID不合法。
400	InvalidAccessKeyStatus	Invalid accessKey status: '%s', err: '%s'	密钥状态不合法。
404	AccessKeyNotExist	The accessKey '%s' can not be found	密钥不存在。