调用DescribeUsers查询便捷用户信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeUsers

系统规定参数。取值:DescribeUsers。

MaxResults Long 10

分页查询时每页行数。

取值范围:1~500。

默认值:500。

NextToken String caeba0bbb2be03f84eb48b699f0a4883

下一个查询开始的Token。

Filter String test

模糊搜索字符串,支持匹配用户名和邮箱。

返回数据

名称 类型 示例值 描述
NextToken String caeba0bbb2be03f84eb48b699f0a4883

下一个查询开始的Token,NextToken为空表示没有下一个。

RequestId String BA75EDC9-8A5F-40C2-ABD5-EBAE56A4D67C

请求ID。

Users Array of data

便捷用户信息集合。

Email String test1@example***.com

邮箱。

EndUserId String test1

用户名。

Id Long 12345

用户ID。

Phone String 1871234****

手机号。

Status Long 0

状态。可能值:

  • 0:正常。
  • 9:锁定。

示例

请求示例

https://eds-user.cn-shanghai.aliyuncs.com/?Action=DescribeUsers
&Filter=test
&<公共请求参数>

正常返回示例

XML格式

<DescribeUsersResponse>
      <RequestId>BA75EDC9-8A5F-40C2-ABD5-EBAE56A4D67C</RequestId>
      <Users>
            <Status>0</Status>
            <Email>test1@example***.com</Email>
            <EndUserId>test1</EndUserId>
            <Id>12345</Id>
      </Users>
</DescribeUsersResponse>

JSON格式

{
    "RequestId": "BA75EDC9-8A5F-40C2-ABD5-EBAE56A4D67C",
    "Users": [
        {
            "Status": 0,
            "Email": "test1@example***.com",
            "EndUserId": "test1",
            "Id": 12345
        }
    ]
}