You can call this operation to query the list of tenants.

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
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. For the valid values of this parameter, see RegionID parameter.

Note Set the value to the ID of the region to which your applications are close.

Response parameters

Parameter Type Example Description
ErrorCode String UnknownError

The error code.

ErrorMessage String UnknownError

The error message.

RequestId String CA1F4A4D-EE49-472F-8DF9-F537101E263A

The ID of the request.

Success Boolean true

Indicates whether the call was successful.

TenantList Array of Tenant

The tenants.

Status String ACTIVE

The status of the tenant. Valid values:

  • ACTIVE: active
  • IN_ACTIVE: inactive
TenantName String test

The name of the tenant.

Tid Long -1

The ID of the tenant.

Examples

Sample requests

http(s)://[Endpoint]/? Action=ListUserTenants
&<Common request parameters>

Sample success responses

XML format

<RequestId>CA1F4A4D-EE49-472F-8DF9-F537101E263A</RequestId>
<TenantList>
    <Status>ACTIVE</Status>
    <TenantName>test1</TenantName>
    <Tid>-1</Tid>
</TenantList>
<TenantList>
    <Status>IN_ACTIVE</Status>
    <TenantName>test2</TenantName>
    <Tid>-2</Tid>
</TenantList>
<TenantList>
    <Status>IN_ACTIVE</Status>
    <TenantName>tes</TenantName>
    <Tid>-3</Tid>
</TenantList>

JSON format

{
  "RequestId": "CA1F4A4D-EE49-472F-8DF9-F537101E263A",
  "TenantList": [
    {
      "Status": "ACTIVE",
      "TenantName": "test1",
      "Tid": -1
    },
    {
      "Status": "IN_ACTIVE",
      "TenantName": "test2",
      "Tid": -2
    },
    {
      "Status": "IN_ACTIVE",
      "TenantName": "tes",
      "Tid": -3
    }
  ]
}

Error codes

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