You can call this operation to query detailed information of users in Data Management (DMS) Enterprise.

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 ListUsers

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

Role String Yes DBA

The role of the user to query. For more information about the valid values, see the description of the RegisterUser operation.

Tid Long Yes -1

The ID of the tenant in DMS Enterprise.

UserState String Yes NORMAL

The status of the user. Valid values:

  • NORMAL: The user is normal.
  • DISABLE: The user is disabled.
  • DELETE: The user is deleted.
PageNumber Integer No 1

The number of the page to return.

PageSize Integer No 50

The number of entries to return on each page.

SearchKey String No test

The keyword used to query users.

Response parameters

Parameter Type Example Description
ErrorCode String UnknownError

The error code.

ErrorMessage String UnknownError

The error message.

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

The ID of the request.

Success Boolean true

Indicates whether the request was successful.

TotalCount Long 1

The total number of users who met the query conditions.

UserList

The detailed information of users.

User

The detailed information of a user.

Mobile String 188xxxxx

The DingTalk number or mobile number of the user.

NickName String test

The nickname of the user.

ParentUid Long 143214352

The Alibaba Cloud unique ID (UID) of the parent account if the user corresponds to a Resource Access Management (RAM) user.

RoleIdList 1

The IDs of the roles that the user plays.

RoleIds

The ID of the role that the user plays.

RoleNameList ADMIN

The names of the roles that the user plays.

RoleNames

The name of the role that the user plays.

State String NORMAL

The status of the user.

Uid Long 14324321533

The Alibaba Cloud UID of the user if the user corresponds to an Alibaba Cloud account.

UserId String 1

The ID of the user.

Examples

Sample requests


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[RAM user]</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 format

{
	"TotalCount":2,
	"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"
			}
		]
	},
	"RequestId":"2D346B20-BF4A-4C96-8295-DE8EB9BF5B90",
	"Success":true
}

Error codes

For a list of error codes, visit the API Error Center.