调用DescribeUsers查询便捷用户信息。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeUsers |
系统规定参数。取值:DescribeUsers。 |
MaxResults | Long | 否 | 10 |
分页查询时每页行数。 取值范围:1~500。 默认值:500。 |
NextToken | String | 否 | caeba0bbb2be03f84eb48b699f0a4883 |
下一次查询的Token。首次调用接口时无需设置该参数。 如果一次查询结果并没有完整返回所有的结果,则返回的NextToken不为空。您可以在查询中上传返回的NextToken继续查询。 |
Filter | String | 否 | test |
模糊搜索字符串,支持匹配用户名(EndUserId)和邮箱(Email)。 |
EndUserIds.N | String | 否 | test |
按用户名(EndUserId)精确匹配,查询用户名一致的用户信息。 |
ExcludeEndUserIds.N | String | 否 | test |
按用户名(EndUserId)精确排除,查询不包含该用户名的用户列表。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | BA75EDC9-8A5F-40C2-ABD5-EBAE56A4D67C |
请求ID。 |
NextToken | String | caeba0bbb2be03f84eb48b699f0a4883 |
下一次查询的Token。NextToken为空表示没有下一次。 |
Users | Array of data |
便捷用户信息集合。 |
|
Id | Long | 12345 |
用户ID。 |
EndUserId | String | test1 |
用户名。 |
String | test1@example***.com |
邮箱。 |
|
Phone | String | 1871234**** |
手机号,当用户未设置时不返回。 |
Status | Long | 0 |
状态。可能值:
|
示例
请求示例
https://eds-user.cn-shanghai.aliyuncs.com/?Action=DescribeUsers
&Filter=test
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/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
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "BA75EDC9-8A5F-40C2-ABD5-EBAE56A4D67C",
"Users" : [ {
"Status" : 0,
"Email" : "test1@example***.com",
"EndUserId" : "test1",
"Id" : 12345
} ]
}