查询IAM用户详情 - ShowUserV5
功能介绍
该接口可以用于查询IAM用户详情。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
URI
GET /v5/users/{user_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| user_id | 是 | String | 参数解释: IAM用户ID,是IAM用户的全局唯一标识。获取方式请参见查询IAM用户列表或在IAM控制台的IAM用户详情页查看。 约束限制: 用户ID需要真实存在且有效。 取值范围: 长度为32个字符,只能由字母和数字组成。 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| user | user object | 参数解释: IAM用户。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| description | String | 参数解释: IAM用户描述信息。 取值范围: 长度为0到255个字符,不能包含特定字符"@"、"#"、"%"、"&"、"<"、">"、"\"、"$"、"^"和"*"的字符串。 |
| user_name | String | 参数解释: IAM用户名。 取值范围: 长度为1到64个字符,只包含字母、数字、"_"、"-"、"."和空格的字符串,且首位不能为数字。 |
| is_root_user | Boolean | 参数解释: IAM用户是否为根用户。 取值范围: 取值范围为[true,false]。 |
| created_at | String | 参数解释: IAM用户创建时间。使用UTC时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ,例如2023-09-13T06:51:20.550Z。 取值范围: 不涉及。 |
| user_id | String | 参数解释: IAM用户ID,是IAM用户的全局唯一标识。获取方式请参见查询IAM用户列表或在IAM控制台的IAM用户详情页查看。 取值范围: 长度为32个字符,只能由字母和数字组成。 |
| urn | String | 参数解释 : URN(Uniform Resource Name)统一资源名称, 参考链接。 取值范围: 不涉及。 |
| enabled | Boolean | 参数解释: IAM用户是否启用。 取值范围: 取值范围为[true,false]。 |
| tags | Array of tags objects | 参数解释: 自定义标签列表。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| tag_key | String | 参数解释: 标签键。 取值范围: 可以包含任意语种字母、数字、空格以及"_"、"."、":"、"="、"+"、"-"、"@"符号的任意组合,但是首尾不能包含空格以及不能使用"_sys_"为开头,长度范围为[1,128]。 |
| tag_value | String | 参数解释: 标签值。 取值范围: 可以包含任意语种字母、数字、空格以及"_"、"."、":"、"/"、"="、"+"、"-"、"@"符号的任意组合,可以是空字符串,长度范围为[0,255]。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,请参见错误码。 取值范围: 格式为PAP5.XXXX,例如PAP5.0012。 |
| error_msg | String | 参数解释: 错误信息,请参见错误信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: API请求的唯一标识,用于排查接口调用异常。 取值范围: 不涉及。 |
| encoded_authorization_message | String | 参数解释: 认证失败时返回的加密详细信息,用于定位认证问题。 可以通过STS5解密接口进行解密,请参见接口链接。 取值范围: 不涉及。 |
状态码:404
请求示例
查询IAM用户详情。
GET https://{endpoint}/v5/users/{user_id} 响应示例
状态码:200
{
"user" : {
"description" : "description",
"user_name" : "example-user-name",
"is_root_user" : false,
"created_at" : "2023-04-26T03:49:42Z",
"user_id" : "0123456789abcdef0123456789abcdef",
"urn" : "iam::123456789012:user:example-user-01",
"enabled" : true,
"tags" : [ {
"tag_key" : "key",
"tag_value" : "value"
} ]
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功。 |
| 403 | 没有操作权限。 |
| 404 | 未找到相应的资源。 |
错误码
请参见错误码。