Queries tenants.


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 ListUserTenants

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

RegionId String Yes cn-hangzhou

The ID of the region in which Data Management (DMS) is activated. Set this parameter to the ID of the region that is in proximity to your applications. For more information about the valid values of this parameter, see RegionID parameter.

Tid Long No 3***

The ID of the tenant. You can call the GetUserActiveTenant operation to query the tenant ID.

Response parameters

Parameter Type Example Description
RequestId String C478D9DA-3615-50F6-A2BC-7855AD65****

The ID of the request.

TenantList Array of Tenant

The details of the tenants that were returned.

Status String ACTIVE

The status of the tenant. Valid values:

  • ACTIVE: The tenant is used to access DMS.
  • IN_ACTIVE: The tenant is not used.
Tid Long 3***

The ID of the tenant.

TenantName String test_name

The name of the tenant.

ErrorCode String TenantNotExist

The error code.

ErrorMessage String The specified tenant does not exist.

The error message.

Success Boolean true

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request fails.


Sample requests

&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK


JSON format

HTTP/1.1 200 OK

  "RequestId" : "C478D9DA-3615-50F6-A2BC-7855AD65****",
  "TenantList" : [ {
    "Status" : "ACTIVE",
    "TenantName" : "test_name",
    "Tid" : "3***"
  } ],
  "Success" : true

Error codes

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