All Products
Search
Document Center

ApsaraDB for OceanBase:DescribeTenantZonesRead

Last Updated:Apr 29, 2024

You can call this operation to query the information about read-only zones of a tenant.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The zone information of the tenant.

ob317v4uif****
TenantIdstringYes

The return result of the request.

ob2mr3oae0****

Response parameters

ParameterTypeDescriptionExample
object

Indicates whether a read-only connection has been created.

RequestIdstring

Indicates whether a read-only connection needs to be created for the zone.

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
TenantZonesobject []

The request ID.

IsElectableboolean

Example 1

true
IsPrimaryboolean
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "TenantZones": [
    {
      "IsElectable": true,
      "IsPrimary": true,
      "Zone": "cn-hangzhou-i",
      "IsReadOnlyAddressMaster": true,
      "IsReadable": "true"
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-07-04The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.