You need to enable JavaScript to run this app.
导航
ListUsers - 获取IAM用户列表
最近更新时间:2024.09.14 14:48:58首次发布时间:2021.02.23 10:42:32

获取IAM用户列表。

调试

请求参数

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

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

ListUsers

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

Version
String

2018-01-01

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

Query
String

Bob

模糊查询。可按用户名、显示名或备注查询。

Limit
Integer

10

分页条数,默认为10。

Offset
Integer

0

分页起始索引,默认为0。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
UserMetadata
Array of Object

请参考数据结构内具体参数示例值。

用户的数据结构。

Limit
Integer

10

分页条数。

Offset
Integer

0

分页起始索引。

Total
Integer

20

总数。

请求示例

GET /?Action=ListUsers&Version=2018-01-01 HTTP/1.1
Host: iam.volcengineapi.com
X-Date: 20240914T031418Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240914/cn-beijing/iam/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f


返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240914111422032237071040BFD028",
    "Action": "ListUsers",
    "Version": "2018-01-01",
    "Service": "iam",
    "Region": "cn-beijing"
  },
  "Result": {
    "UserMetadata": [
      {
        "Id": 10000,
        "UserName": "Bob",
        "AccountId": 2000000000,
        "Trn": "trn:iam::210*******:user/Bob",
        "DisplayName": "鲍勃",
        "Description": "鲍勃",
        "MobilePhone": "+86130******00",
        "MobilePhoneIsVerify": true,
        "Email": "abc**@**.com",
        "EmailIsVerify": true,
        "CreateDate": "20240813T053809Z",
        "UpdateDate": "20240813T053809Z"
      }
    ],
    "Limit": 10,
    "Offset": 10,
    "Total": 100
  }
}

错误码

您可访问公共错误码,获取更多错误码信息。