All Products
Search
Document Center

ApsaraDB for OceanBase (Deprecated):DescribeInstanceAvailableZones

Last Updated:Jan 13, 2026

You can call this operation to query the zones of a cluster that can be set as the primary zone.

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the OceanBase cluster.

ob317v4uif****

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

Id of the request

E3D924FB-52****B253-0C1A7EFB778C
ZoneListarray<object>

The return result of the request.

ZoneListobject

The return result of the request.

Zonestring

The name of the physical zone.

cn-hangzhou-i
IsInClusterboolean

Indicates whether the cluster is deployed in the zone.

true
ReplicateZoneIndexstring

The index of the replicated zone.

1
LogicalZoneNamestring

The name of the logical zone.

cn-shanghai-g-z0,cn-shanghai-g-z1, cn-shanghai-g-z2

Examples

Sample success responses

JSONformat

{
  "RequestId": "E3D924FB-52****B253-0C1A7EFB778C",
  "ZoneList": [
    {
      "Zone": "cn-hangzhou-i",
      "IsInCluster": true,
      "ReplicateZoneIndex": 1,
      "LogicalZoneName": "cn-shanghai-g-z0,cn-shanghai-g-z1, cn-shanghai-g-z2"
    }
  ]
}

Error codes

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