Queries the information about convenience users.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeUsers

The operation that you want to perform. Set the value to DescribeUsers.

MaxResults Long No 10

The number of entries to return on each page.

Valid values: 1 to 500.

Default value: 500.

NextToken String No caeba0bbb2be03f84eb48b699f0a4883

The token that determines the start point of the query. You do not need to configure this parameter if you call this operation for the first time.

If not all results are returned in a query, a value is returned for the NextToken parameter. In this case, you can use the returned NextToken value to retrieve the next page.

Filter String No test

The fuzzy search string that matches the username (EndUserId) and email address (Email) of the regular user.

EndUserIds.N String No test

The username that is used to match regular user N that you want to query.

ExcludeEndUserIds.N String No test

The username that is used to match regular user N that you want to exclude.

Response parameters

Parameter Type Example Description
RequestId String BA75EDC9-8A5F-40C2-ABD5-EBAE56A4D67C

The ID of the request.

NextToken String caeba0bbb2be03f84eb48b699f0a4883

The token that determines the start point of the query. If this parameter is empty, all results have been returned.

Users Array of data

Details about convenience users.

Id Long 12345

The ID of the regular user.

EndUserId String test1

The name of the convenience user.

Email String test1@example***.com

The email address of the regular user.

Phone String 1871234****

The mobile number of the regular user. If this parameter is left empty, no mobile number is returned.

Status Long 0

The status of the regular user. Valid values:

  • 0: normal
  • 9: locked

Examples

Sample requests

https://eds-user.cn-shanghai.aliyuncs.com/?Action=DescribeUsers
&Filter=test
&<Common request parameters>

Sample success responses

XML format

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 format

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
  } ]
}