修改指定永久访问密钥 - UpdateAccessKeyV5

功能介绍

该接口可以用于修改IAM用户的指定永久访问密钥。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
iam:credentials:updateCredentialV5	Write	user *	g:ResourceTag/<tag-key>	-	-

URI

PUT /v5/users/{user_id}/access-keys/{access_key_id}

表1 路径参数
参数	是否必选	参数类型	描述
user_id	是	String	参数解释： IAM用户ID。约束限制：用户ID需要真实存在且有效。取值范围： 32位。默认取值：不涉及。
access_key_id	是	String	参数解释：永久访问密钥ID，即AK。获取方式参考链接。约束限制：见上述参考链接。取值范围：不涉及。默认取值：不涉及。

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
status	是	String	参数解释：访问密钥状态。约束限制：不涉及。取值范围： “启用”（active）或“停用”（inactive）。默认取值：不涉及。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
access_key	access_key object	参数解释：永久访问密钥。取值范围：不涉及。

表4 access_key
参数	参数类型	描述
user_id	String	参数解释： IAM用户ID，是IAM用户的全局唯一标识。取值范围：不涉及。
access_key_id	String	参数解释：永久访问密钥ID，即AK。获取方式参考链接。取值范围：不涉及。
created_at	String	参数解释：访问密钥创建时间。取值范围：不涉及。
status	String	参数解释：访问密钥状态。取值范围： “启用”（active）或“停用”（inactive）。

状态码：403

表5 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码，请参见错误码。取值范围：格式为PAP5.XXXX，例如PAP5.0012。
error_msg	String	参数解释：错误信息，请参见错误消息。取值范围：不涉及。
request_id	String	参数解释： API请求的唯一标识，用于排查接口调用异常。取值范围：不涉及。
encoded_authorization_message	String	参数解释：认证失败时返回的加密详细信息，用于定位认证问题。可以通过STS5解密接口进行解密，请参见接口链接。取值范围：不涉及。

状态码：404

表6 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码，请参见错误码。取值范围：格式为PAP5.XXXX，例如 PAP5.0012。
error_msg	String	参数解释：错误信息，请参见错误信息。取值范围：不涉及。
request_id	String	参数解释： API 请求的唯一标识，用于排查接口调用异常。取值范围：不涉及。

请求示例

将IAM用户的指定永久访问密钥的状态置为启用。

PUT https://{endpoint}/v5/users/{user_id}/access-keys/{access_key_id}

{
  "status" : "active"
}

响应示例

状态码：200

请求成功。

{
  "access_key" : {
    "user_id" : "user",
    "access_key_id" : "access",
    "created_at" : "2023-09-13T06:51:20.550Z",
    "status" : "active"
  }
}