You can call this operation to add a user to Data Management (DMS) Enterprise of your enterprise.

The administrator of DMS Enterprise can call this operation to add users to DMS Enterprise. To check the users with the administrator role, log on to the DMS Enterprise console and choose System Management > User Management.

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
Tid Long Yes -1

The ID of the tenant.

To query the ID, log on to the DMS Enterprise console and choose System Management > Instance Management or System Management > User Management. The ID of the tenant appears in the Service Specification section.

Uid Long Yes 12345678

The Alibaba Cloud unique ID (UID) of the user to add.

UserNick String Yes dmstest

The nickname of the user.

Action String Yes RegisterUser

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

RoleNames String No USER,DBA

The roles that the user plays. Valid values:

  • USER: a common user.
  • DBA: a database administrator (DBA).
  • ADMIN: an administrator.
  • SECURITY_ADMIN: a security administrator.

If you do not specify this parameter, the value is set to USER by default. You can assign one or more roles to the user. Separate multiple roles with commas (,).

Response parameters

Parameter Type Example Description
ErrorCode String 403

The error code.

ErrorMessage String The specified user already exists.

The error message.

RequestId String 34E01EDD-6A16-4CF0-9541-C644D1BE01AA

The ID of the request.

Success Boolean true
  • true: The request was successful.
  • false: The request failed.

Examples

Sample requests


http(s)://[Endpoint]/? Action=RegisterUser
&Tid=-1
&Uid=12345678
&UserNick=dmstest
&<Common request parameters>

Sample success responses

XML format

<RegisterUserResponse>
      <RequestId>ADE24A7C-DB8B-4D32-94AD-E50E3B921197</RequestId>
      <Success>true</Success>
</RegisterUserResponse>

JSON format

{
	"RequestId":"34E01EDD-6A16-4CF0-9541-C644D1BE01AA",
	"Success":true
}

Error codes

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