ListUserTenants - Data Management - Alibaba Cloud Documentation Center

Queries tenants.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Tid	long	No	The ID of the tenant. You can call the GetUserActiveTenant operation to query the tenant ID.	3***

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	C478D9DA-3615-50F6-A2BC-7855AD65****
TenantList	array<object>	The details of the tenants that were returned.
Tenant	object
Status	string	The status of the tenant. Valid values: ACTIVE: The tenant is used to access DMS. IN_ACTIVE: The tenant is not used.	ACTIVE
Tid	long	The ID of the tenant.	3***
TenantName	string	The name of the tenant.	test_name
ErrorCode	string	The error code.	TenantNotExist
ErrorMessage	string	The error message.	The specified tenant does not exist.
Success	boolean	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "C478D9DA-3615-50F6-A2BC-7855AD65****",
  "TenantList": [
    {
      "Status": "ACTIVE",
      "Tid": 0,
      "TenantName": "test_name"
    }
  ],
  "ErrorCode": "TenantNotExist",
  "ErrorMessage": "The specified tenant does not exist.",
  "Success": true
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history