All Products
Search
Document Center

:DescribeInstanceCreatableZone

Last Updated:Mar 14, 2023

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

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

The return result of the request.

RequestIdstring

The request ID.

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
ZoneListarray

The list of zones.

object

The return result of the request.

IsInClusterboolean

Indicates whether the cluster is deployed in the zone.

true
Zonestring

The ID of the zone.

cn-hangzhou-i

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "ZoneList": [
    {
      "IsInCluster": true,
      "Zone": "cn-hangzhou-i"
    }
  ]
}

Error codes

HTTP status codeError codeError message
500InternalErrorThe request processing has failed due to some unknown error.

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

Change history

Change timeSummary of changesOperation
No change history