All Products
Search
Document Center

ApsaraDB for OceanBase:DescribeInstanceCreatableZone

Last Updated:Oct 21, 2024

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 zone.

ob317v4uif****

Response parameters

ParameterTypeDescriptionExample
object

The list of zones.

RequestIdstring

Indicates whether the cluster is deployed in the zone.

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
ZoneListarray<object>

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

ZoneListobject

Example 1

IsInClusterboolean
true
Zonestring

DescribeInstanceCreatableZone

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