All Products
Search
Document Center

ApsaraDB for OceanBase:DescribeTenantZonesRead

Last Updated:Oct 20, 2022

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the OceanBase cluster.

ob317v4uif****
TenantIdstringYes

The ID of the tenant.

ob2mr3oae0****

Response parameters

ParameterTypeDescriptionExample
object

The return result of the request.

RequestIdstring

The request ID.

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
TenantZonesarray

The zone information of the tenant.

object
IsElectableboolean

Indicates whether the zone can be set as the primary zone.

true
IsPrimaryboolean

Indicates whether the zone is the primary zone.

true
Zonestring

The ID of the zone.

cn-hangzhou-i
IsReadOnlyAddressMasterboolean

Indicates whether a read-only connection has been created.

true
IsReadablestring

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

true

Example

Normal return example

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 API error center.

Change history

Change timeSummary of changesOperate
2021-11-04OpenAPI DescribeTenantZonesRead is offline
Change itemChange content
2021-11-04OpenAPI DescribeTenantZonesRead is offline
Change itemChange content
2021-11-04OpenAPI DescribeTenantZonesRead is offline
Change itemChange content
2021-11-04OpenAPI DescribeTenantZonesRead is offline
Change itemChange content