You can call this operation to query user details.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. You can use OpenAPI Explorer to search for API operations, call API operations, and dynamically generate SDK sample code.

Request parameters

Parameter Type Required Example Description
Action String Yes ListUsers

The operation that you want to perform. Value: ListUsers .

Tid Long Yes -1

The ID of the tenant.

Note The tenant ID is taken from the tenant ID displayed when you move the pointer on your profile picture. For more information, see View tenant information .
Role String No DBA

The role. For more information about the value, see RegisterUser.

UserState String No NORMAL

The status of the user. Valid values:

  • NORMAL: The API group is normal.
  • DISABLE: The database is disabled.
  • DELETE: The user is deleted.
SearchKey String No test

The keyword to be matched.

PageNumber Integer No 1

The page number of the returned page.

PageSize Integer No 50

The number of entries to return on each page.

Response parameters

Parameter Type Sample response Description
ErrorCode String UnknownError

The error codes.

ErrorMessage String UnknownError

The error message of the failure.

RequestId String 98D35416-2B92-4CE5-8FD2-B1E61E165536

The ID of the API request.

Success Boolean true

Indicates whether the call was successful.

TotalCount Long 1

The total number of records.

UserList Array of User

The user details list.

User
CurExecuteCount Long 0

Number of queries of the current day.

CurResultCount Long 0

The number of rows queried in the current day.

LastLoginTime String 2020-02-02 00:00:00

The last logon time.

MaxExecuteCount Long 1000

Maximum number of queries per day.

MaxResultCount Long 1000

Maximum number of queried rows of the current day.

Mobile String 188xxxxx

DingTalk number (mobile phone number).

NickName String test

The nick name of the device.

ParentUid Long 143214352

The Uid of the parent account.

RoleIdList List 1

The list of role IDs.

RoleNameList List ADMIN

The list of roles.

State String NORMAL

The user status.

Uid Long 14324321533

The Alibaba Cloud Uid of the user.

UserId String 1

The ID of the user account.

Examples

Sample request


     http(s)://[Endpoint]/? Action=ListUsers &Role=DBA &Tid=-1 &UserState=NORMAL &<common request parameters> 
   

Sample success responses

XML format


     <UserList> <User> <RoleIdList> <RoleIds> 3 </RoleIds> <RoleIds> 1 </RoleIds> </RoleIdList> <State> NORMAL </State> <RoleNameList> <RoleNames> ADMIN </RoleNames> <RoleNames> USER </RoleNames> </RoleNameList> <NickName> xxx </NickName> <UserId> 2 </UserId> <Uid> 111 </Uid> </User> <User> <RoleIdList> <RoleIds> 1 </RoleIds> <RoleIds> 3 </RoleIds> </RoleIdList> <State> NORMAL </State> <RoleNameList> <RoleNames> USER </RoleNames> <RoleNames> ADMIN </RoleNames> </RoleNameList> <NickName> xxx [account] </NickName> <ParentUid> 111 </ParentUid> <UserId> 1 </UserId> <Uid> 111 </Uid> </User> </UserList> <TotalCount> 2 </TotalCount> <RequestId> 2d346b20-bf4a-4c96-8295-de8eb9bf5b90 </RequestId> <Success> true </Success> 
   

JSON


     {"UserList": { "User": [ { "RoleIdList": { "RoleIds": [ 3, 1 ] }, "State": "NORMAL", "RoleNameList": { "RoleNames": [ "ADMIN", "USER" ] }, "NickName": "xxx", "UserId": 2," Uid ": " 111 " }, { " RoleIdList ": { " RoleIds ": [ 1, 3 ] }, " State ": " NORMAL ", " RoleNameList ": { " RoleNames ": [ " USER ", " ADMIN " ] }, " NickName ": " xxx [Ram user] ", " ParentUid ": " 111 ", " UserId ": 1, "Uid": "111" } ] }, "TotalCount": 2, "RequestId": "2D346B20-BF4A-4C96-8295-DE8EB9BF5B90", "Success": true} 
   

Error codes

For more information about error codes, see error center.