更新时间:2026-05-14 GMT+08:00
分享

查询IAM用户列表 - ListUsersV5

功能介绍

该接口可以用于查询IAM用户列表。

调试

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

授权信息

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

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

iam:users:listUsersV5

List

user *

-

-

-

URI

GET /v5/users

表1 Query参数

参数

是否必选

参数类型

描述

limit

Integer

参数解释

每页显示的条目数量。

约束限制

不涉及。

取值范围

取值范围为[1,200]。

默认取值

默认为100。

marker

String

参数解释

服务内部自动生成的分页标记,用于标记本次请求的起始位置,可从上一次分页请求响应体的next_marker获得。

约束限制

长度为4到400个字符,只包含字母、数字、"+"、"/"、"="、"-"和"_"的字符串。

取值范围

不涉及。

默认取值

不涉及。

group_id

String

参数解释

用户组ID。

约束限制

长度为1到64个字符,只包含字母、数字和"-"的字符串。

取值范围

不涉及。

默认取值

不涉及。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

users

Array of users objects

参数解释

IAM用户列表。

取值范围

不涉及。

page_info

page_info object

参数解释

分页信息。

取值范围

不涉及。

表3 users

参数

参数类型

描述

description

String

参数解释

IAM用户描述信息。

取值范围

不涉及。

user_name

String

参数解释

IAM用户名。

取值范围

不涉及。

is_root_user

Boolean

参数解释

IAM用户是否为根用户。

取值范围

取值范围为[true,false]。

created_at

String

参数解释

IAM用户创建时间。

取值范围

不涉及。

user_id

String

参数解释

IAM用户ID,是IAM用户的全局唯一标识。

取值范围

不涉及。

urn

String

参数解释

URN(Uniform Resource Name)统一资源名称, 参考链接

取值范围

不涉及。

enabled

Boolean

参数解释

IAM用户是否启用。

取值范围

取值范围为[true,false]。

表4 page_info

参数

参数类型

描述

next_marker

String

参数解释

下一次分页调用的起始位置标记,由服务自动生成。

取值范围

不涉及。

current_count

Integer

参数解释

本页返回条目数量。

取值范围

不涉及。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码,请参见错误码

取值范围

格式为PAP5.XXXX,例如 PAP5.0012。

error_msg

String

参数解释

错误信息,请参见错误信息

取值范围

不涉及。

request_id

String

参数解释

API 请求的唯一标识,用于排查接口调用异常。

取值范围

不涉及。

状态码:403

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码,请参见错误码

取值范围

格式为PAP5.XXXX,例如PAP5.0012。

error_msg

String

参数解释

错误信息,请参见错误消息

取值范围

不涉及。

request_id

String

参数解释

API请求的唯一标识,用于排查接口调用异常。

取值范围

不涉及。

encoded_authorization_message

String

参数解释

认证失败时返回的加密详细信息,用于定位认证问题。 可以通过STS5解密接口进行解密,请参见接口链接

取值范围

不涉及。

请求示例

  • 查询所有用户列表。

    GET https://{endpoint}/v5/users
  • 查询用户组xxx中的所有用户列表。

    GET https://{endpoint}/v5/users?group_id=xxx

响应示例

状态码:200

请求成功。

{
  "users" : [ {
    "description" : "description",
    "user_name" : "name",
    "is_root_user" : false,
    "created_at" : "2023-04-26T03:49:42Z",
    "user_id" : "string",
    "urn" : "iam::accountid:user:name",
    "enabled" : true
  } ],
  "page_info" : {
    "next_marker" : "marker",
    "current_count" : 1
  }
}

状态码

状态码

描述

200

请求成功。

400

请求体异常。

403

没有操作权限。

错误码

请参见错误码

相关文档