GetUser - Query user information | DMS API - Data Management

Queries the details of a specific user.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:GetUser

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tid	integer	No	The tenant ID. Call GetUserActiveTenant to obtain this value.	3***
Uid	string	No	The Alibaba Cloud account UID. To view your UID, hover over the profile picture in the upper-right corner of the DMS console.	22973492647626****
UserId	string	No	The user ID. Call ListUsers to obtain this value.	51****

Response elements

Element	Type	Description	Example
	object
User	object	The user details.
State	string	The user status. Valid values: NORMAL: The user is normal. DISABLE: The user is disabled. DELETE: The user is deleted.	NORMAL
CurResultCount	integer	Rows queried today.	28
UserId	string	The user ID.	51****
LastLoginTime	string	Last console login time.	2021-11-08 11:26:21
MaxResultCount	integer	Maximum queryable rows per day.	10000
ParentUid	integer	UID of the parent Alibaba Cloud account. Note An Alibaba Cloud account can contain one or more RAM users.	140692647406****
RoleIdList	object
RoleIds	array	The role IDs.
	integer	The user's role ID. Valid values: 1: regular user. 2: DBA. 3: DMS administrator. 4: security administrator. 6: schema read-only user.	1
RoleNameList	object
RoleNames	array	The role names.
	string	The user's role name. Valid values: USER: regular user. DBA: DBA. ADMIN: DMS administrator. SECURITY_ADMIN: security administrator. STRUCT_READ_ONLY: schema read-only user.	USER
NickName	string	The user nickname.	User_NickName
MaxExecuteCount	integer	Maximum queries allowed per day.	2000
CurExecuteCount	integer	Queries performed today.	3
Mobile	string	The user's mobile number. Note Returned only if configured in DMS. To configure, hover over the profile picture and click the Edit icon next to Notice. Not returned if unconfigured.	1389223****
Uid	string	The UID of the user.	22275482072787****
Email	string	The user's notification email address. Note Returned only if configured in DMS. To configure, hover over the profile picture and click the Edit icon next to Notice. Not returned if unconfigured.	Uesr_email
DingRobot	string	The DingTalk chatbot webhook URL. Note Returned only if configured in DMS. To configure, hover over the profile picture and click the Edit icon next to Notice. Not returned if unconfigured.	https://XXX.dingtalk.com/robot/send?access_token=***
Webhook	string	The webhook URL for notifications. Note DMS sends notifications to this URL when configured. Not returned if unconfigured.	http://dms-XXX.aliyun.com:8***
SignatureMethod	string	Signature method for webhook connections. Valid values: NONE: no signature. HMAC_SHA1: HMAC_SHA1.	NONE
NotificationMode	string	Notification method. Multiple values may be returned. Valid values: SMS: text message EMAIL: email. DINGDING: DingTalk. DINGROBOT: DingTalk chatbot. WEBHOOK: webhook.	EMAIL
RequestId	string	The request ID.	804BB128-CAFA-5DD0-BA1E-43DDE488****
ErrorCode	string	The error code.	UnknownError
ErrorMessage	string	Error message returned on failure.	Unknown server error
Success	boolean	Whether the request succeeded. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "User": {
    "State": "NORMAL",
    "CurResultCount": 28,
    "UserId": "51****",
    "LastLoginTime": "2021-11-08 11:26:21",
    "MaxResultCount": 10000,
    "ParentUid": 0,
    "RoleIdList": {
      "RoleIds": [
        1
      ]
    },
    "RoleNameList": {
      "RoleNames": [
        "USER"
      ]
    },
    "NickName": "User_NickName",
    "MaxExecuteCount": 2000,
    "CurExecuteCount": 3,
    "Mobile": "1389223****",
    "Uid": "22275482072787****",
    "Email": "Uesr_email",
    "DingRobot": "https://XXX.dingtalk.com/robot/send?access_token=***",
    "Webhook": "http://dms-XXX.aliyun.com:8***",
    "SignatureMethod": "NONE",
    "NotificationMode": "EMAIL"
  },
  "RequestId": "804BB128-CAFA-5DD0-BA1E-43DDE488****",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "Unknown server error",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.