---
title: "查 OceanBase 集群的 Zone 列表 | OceanBase 文档中心"
description: 查 OceanBase 集群的 Zone 列表 功能说明 该接口用于查询 OceanBase 集群的 Zone 列表。 调用说明 接口约束 调用者需具备查看 OceanBase 集群的权限。 关于调用者的权限，详情可参见 安全概述 。 调用者需要通过 OCP 应用服务鉴权。 请求路径 GET /api/v2/ob/c…
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*lJTmRZ61jSUAAAAAAAAAAAAADiGDAQ/original) 云平台 OCPV 4.0.3 企业版

# 查 OceanBase 集群的 Zone 列表

更新时间：2023-08-16 15:51:32

## 功能说明

该接口用于查询 OceanBase 集群的 Zone 列表。

## 调用说明

### 接口约束

- 调用者需具备查看 OceanBase 集群的权限。

  关于调用者的权限，详情可参见 [安全概述](https://www.oceanbase.com/docs/enterprise-oceanbase-ocp-cn-10000000001538756)。
 - 调用者需要通过 OCP 应用服务鉴权。

### 请求路径

`GET /api/v2/ob/clusters/{id}/zones`

**path:**

| 参数 | 类型 | 必选 | 示例值 | 描述 |
| --- | --- | --- | --- | --- |
| id | Integer | 是 | 100 | 需查询 Zone 列表的 OceanBase 集群的 ID。 |

### 返回结果

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| data | Object | 请求的数据。 |
| ├─ contents | Array | Zone 的数组，详细数据结构见下表。 |
| ├─ page | Object | 分页信息。 |
| ├─ totalElements | Integer | 总记录数。 |
| ├─ totalPage | Integer | 总页数。 |
| ├─ number | Integer | 当前页码。 |
| ├─ size | Integer | 当前页大小。 |
| successful | Boolean | 请求是否成功。 |
| timestamp | Datetime | 服务端完成请求的时间戳。 |
| duration | Integer | 服务端处理请求的时间（毫秒）。 |
| status | Integer | 符合 HTTP Status 规范的编码。 |
| traceId | String | 请求的 Trace Id，用于排查问题。 |
| server | String | 响应请求的应用服务的地址。 |

**Zone 数据结构**

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| name | String | Zone 名 |
| idcName | String | 所属机房名 |
| regionName | String | 所属地域 |
| servers | Array | Server 列表 |
| clusterId | Long | 机器 ID |
| obClusterId | Long | OceanBase 集群的 ID |
| serverCount | Integer | Server 数 |
| hostCount | Integer | 主机数 |

**Server 数据结构**

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| id | String | OB server ID |
| ip | String | OB server IP |
| port | Integer | 端口 |
| sqlPort | Integer | SQL端口 |
| version | String | 版本 |
| withRootserver | Boolean | 是否带root service |
| status | String | 状态 |
| clusterId | Long | 所属集群id |
| zoneName | String | 所属zone名称 |
| regionName | String | 所属地域 |
| idcName | String | 所属机房 |
| hostId | Long | 对应主机ID |
| hostTypeName | String | 机型名称 |
| startTime | DateTime | 启动时间 |
| stopTime | DateTime | 停止时间 |

## 示例

### 请求示例

查询集群 Zone 信息的列表。

`GET /api/v2/ob/clusters/100/zones`

### 返回示例

```unknow
{
    "data": {
        "contents": [
            {
                "clusterId": 12000001,
                "compactionStatus": "IDLE",
                "createTime": "2021-09-02T16:31:34+08:00",
                "hostCount": 1,
                "idcId": 3,
                "idcName": "hz3",
                "innerStatus": "ACTIVE",
                "name": "zone1",
                "obClusterId": 22,
                "regionName": "hangzhou",
                "rootServer": {
                    "address": "xxx.xxx.xxx.xxx:2882",
                    "role": "LEADER",
                    "sql_port": 2881
                },
                "serverCount": 1,
                "servers": [
                    {
                        "clusterId": 12000001,
                        "hostId": 4000003,
                        "hostTypeName": "forge",
                        "id": 12000001,
                        "idcName": "hz3",
                        "innerStatus": "ACTIVE",
                        "ip": "xxx.xxx.xxx.xxx",
                        "port": 2882,
                        "regionName": "hangzhou",
                        "sqlPort": 2881,
                        "startTime": "2021-09-02T08:39:29.295684Z",
                        "status": "RUNNING",
                        "stopTime": "1970-01-01T00:00:00Z",
                        "updateTime": "2021-09-02T16:39:58+08:00",
                        "version": "3.1.0_20210412122703-1c10f0b3ad39105cd5d12eb566ebe3a374ea38f5(Apr 12 2021 12:57:39)",
                        "withRootserver": true,
                        "zoneName": "zone1"
                    }
                ],
                "status": "RUNNING",
                "updateTime": "2021-09-03T02:01:31+08:00"
            }
        ]
    },
    "duration": 593,
    "server": "a83ad33525",
    "status": 200,
    "successful": true,
    "timestamp": "2021-09-03T10:28:31.861+08:00",
    "traceId": "340849601d4d4ffe"
}

```

 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线