RegisterUser - Register a DMS user - Data Management - Alibaba Cloud Documentation Center

Operation description

Only administrator users in DMS can call this operation. To view administrators, log on to the DMS console and navigate to O&M > 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:RegisterUser

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tid	integer	No	The ID of the tenant. Note Hover over the profile picture in the upper-right corner of the DMS console to find your tenant ID. Manage DMS tenants.	-1
Uid	string	Yes	The UID of the Alibaba Cloud account to register.	12345678
UserNick	string	No	The nickname of the user.	dmstest
RoleNames	string	No	The role to assign to the user. Valid values: USER: regular user DBA: database administrator ADMIN: DMS administrator SECURITY_ADMIN: security administrator Note Defaults to USER if not specified. Separate multiple roles with commas (,).	USER,DBA
Mobile	string	No	The mobile number of the user.	130000000xx

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	34E01EDD-6A16-4CF0-9541-C644D1BE01AA
ErrorCode	string	The error code.	403
ErrorMessage	string	The error message.	The specified user already exists.
Success	boolean	true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "RequestId": "34E01EDD-6A16-4CF0-9541-C644D1BE01AA",
  "ErrorCode": "403",
  "ErrorMessage": "The specified user already exists.",
  "Success": true
}

Error response

JSON format

{
    "RequestId": "34E01EDD-6A16-4CF0-9541-C644D1BE01AA",
    "HostId": "dms-enterprise.aliyuncs.com",
    "Code": "UserExisted",
    "Message": "The specified user already exists."
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.