全部产品
Search
文档中心

云数据库 OceanBase (文档停止维护):DescribeInstanceCreatableZone - 查询可用区信息

更新时间:Aug 27, 2026

查询集群可创建主可用区的可用区信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

oceanbase:DescribeInstanceCreatableZone

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

OceanBase 集群 ID。

ob317v4uif****

返回参数

名称

类型

描述

示例值

object

请求的返回结果。

RequestId

string

请求 ID。

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C

ZoneList

array<object>

可用区列表信息。

object

请求的返回结果。

IsInCluster

boolean

是否是集群部署的可用区。

true

Zone

string

物理可用区名称。

cn-hangzhou-i

FullCopyId

string

副本序号。

1

LogicalZoneName

string

逻辑可用区名称。

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

ReplicateZoneIndex

integer

副本可用区索引。

1

示例

正常返回示例

JSON格式

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "ZoneList": [
    {
      "IsInCluster": true,
      "Zone": "cn-hangzhou-i",
      "FullCopyId": "1",
      "LogicalZoneName": "cn-shanghai-g-z0,cn-shanghai-g-z1, cn-shanghai-g-z2",
      "ReplicateZoneIndex": 1
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

500 InternalError The request processing has failed due to some unknown error. 内部错误

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情