Queries the information about convenience users.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

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.

Filter String No test

A string that is used for fuzzy search. You can enter keywords such as usernames and email addresses.

Response parameters

Parameter Type Example Description
NextToken String caeba0bbb2be03f84eb48b699f0a4883

The token that determines the start point of the next query. This parameter is empty if no additional results exist.

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

The ID of the request.

Users Array of data

The information about the convenience user.

Email String test1@example***.com

The email address.

EndUserId String test1

The username of the convenience user.

Id Long 12345

The user ID of the convenience user.

Phone String 1871234****

The mobile phone number.

Status Long 0

The status of the convenience user. Valid values:

  • 0: The convenience user is normal.
  • 9: The convenience user is locked.

Examples

Sample requests

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

Sample success responses

XML format

<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

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