You can call this operation to query details of the active tenant.

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 GetUserActiveTenant

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

RegionId String No 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 E20EAB9F-A3DB-42EC-BD0C-102A886340F5

The ID of the request.

Success Boolean true

Indicates whether the call was successful.

Tenant Struct

Details about the tenant.

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=GetUserActiveTenant
&<Common request parameters>

Sample success responses

XML format

<Tenant>
    <Status>ACTIVE</Status>
    <TenantName>test</TenantName>
    <Tid>-1</Tid>
</Tenant>
<RequestId>E20EAB9F-A3DB-42EC-BD0C-102A886340F5</RequestId>
<Success>true</Success>

JSON format

{
  "Tenant": {
    "Status": "ACTIVE",
    "TenantName": "test",
    "Tid": -1
  },
  "RequestId": "E20EAB9F-A3DB-42EC-BD0C-102A886340F5",
  "Success": true
}

Error codes

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