---
title: "查询 OBProxy 集群列表 - 云平台 OCP V4.3.0 | OceanBase 文档中心"
description: 查询 OBProxy 集群列表 功能说明 查询 OBProxy 集群列表信息时使用的接口。 调用说明 接口约束 调用者需要通过 OCP 应用服务鉴权。 请求路径 GET /api/v2/obproxy/clusters 请求参数 无。 返回结果 基础数据结构 参数 类型 说明 data Object 请求的数据。 ├…
---
切换语言

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

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

# 查询 OBProxy 集群列表

更新时间：2026-04-14 11:55:54

[编辑](https://github.com/oceanbase/ocp-doc/edit/V4.3.0/zh-CN/1900.reference-guide/200.api-reference/800.obproxy-management/300.queries-the-obproxy-cluster-list.md)  

## 功能说明

查询 OBProxy 集群列表信息时使用的接口。

## 调用说明

### 接口约束

调用者需要通过 OCP 应用服务鉴权。

### 请求路径

`GET /api/v2/obproxy/clusters`

### 请求参数

无。

### 返回结果

**基础数据结构**

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| data | Object | 请求的数据。 |
| ├─ contents | Array | OBProxy 的集群信息，详情参见 **obproxyCluster 数据结构**。 |
| ├─ page | Object | 分页信息，详情参见 **page 数据结构**。 |
| successful | Boolean | 请求是否成功。 |
| timestamp | Datetime | 服务端完成请求的时间戳。 |
| duration | Integer | 服务端处理请求的时间（毫秒）。 |
| status | Integer | 符合 HTTP Status 规范的编码。 |
| traceId | String | 请求的 Trace ID，用于排查问题。 |
| server | String | 响应请求的应用服务的地址。 |

**page 数据结构**

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| totalElements | Integer | 总页数。 |
| totalPage | Integer | 页码。 |
| number | Integer | 当前页码。 |
| size | Integer | 当前页大小。 |

**obproxyCluster 数据结构**

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| id | Long | OBProxy 集群 ID。 |
| name | String | OBProxy 集群名称。 |
| parameterVersion | Long | OBProxy 集群参数版本。 |
| creatorId | Long | 创建者 ID。 |
| creatorName | String | 创建者名字。 |
| createTime | OffsetDateTime | 创建时间。 |
| updateTime | OffsetDateTime | 修改时间。 |
| configUrl | String | Config URL 地址。 |
| address | String | OBProxy 集群访问地址。 |
| port | Integer | OBProxy 集群访问端口。 |
| obLinks | Array | 可连接 OceanBase 集群信息，详情参见 **ObLink 数据结构**。 |
| versions | Array | OBProxy 部署版本信息，按照版本统计 OBProxy 数量，详情参见 **VersionStatInfo 数据结构**。 |
| topo | Array | OBProxy 部署 topo 信息，按照机房统计 OBProxy 数量，详情参见 **IdcStatInfo 数据结构**。 |
| obproxies | Array | 集群下所有 OBProxy 列表，详情参见 **ObproxyServer 数据结构**。 |

**ObLink 数据结构**

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| clusterId | Long | 集群在 OCP 端的 ID。 |
| clusterName | String | 集群名。 |
| username | String | 连接用户。 |
| status | String | 集群状态，取值范围：- RUNNING - UNAVAILABLE - STOPPED - CREATING - TAKINGOVER - DELETING - MOVINGOUT - RESTARTING - STARTING - STOPPING - SWITCHOVER - FAILOVER - UPGRADING - OPERATING - ABANDONED - DISCONNECTING - MOVED_OUT |
| connections | Double | OceanBase 集群连接数。 |
| obClusterId | Long | 集群在 OceanBase 端的 ID。 |
| clusterType | String | 集群类型，取值范围：- PRIMARY - STANDBY 。 |

**VersionStatInfo 数据结构**

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| version | String | 版本信息。 |
| count | Long | OBProxy 数量。 |

**IdcStatInfo 数据结构**

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| idcName | String | IDC 名字。 |
| count | Long | OBProxy 数量。 |

**ObproxyServer 数据结构**

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| id | Long | OBProxy Server ID。 |
| clusterId | Long | OBProxy 所属 OBProxy 集群 ID。 |
| hostId | Long | OBProxy 所属 Host ID。 |
| idcName | String | OBProxy 所在机房名字。 |
| lastActiveTime | OffsetDateTime | 最近可用时间。 |
| parameterVersion | Long | 参数版本。 |
| ip | String | IP 地址。 |
| sqlPort | Integer | SQL 端口。 |
| exporterPort | Integer | Exporter 端口。 |
| version | String | OBProxy 版本信息。 |
| status | String | OBProxy 状态，取值范围：- CREATING - RUNNING - RESTARTING - UPGRADING - REFRESHING - DELETING - UNAVAILABLE - TAKINGOVER - STARTING - STOPPING - STOPPED - MOVINGOUT |
| operateStatus | String | OBProxy 操作状态，取值范围：- NORMAL - OPERATING |
| architecture | String | Host 硬件架构信息。 |

## 示例

### 请求示例

`GET /api/v2/obproxy/clusters?page=1&size=10`

### 返回示例

```javascript
{
    "data": {
            "contents": [{
                    "address": "xxx.xxx.xxx.xxx",
                    "configUrl": "http://xxx.xxx.xxx.xxx:8080/services?Action=GetObProxyConfig&User_ID=alibaba&UID=admin&ObproxyClusterName=test",
                    "createTime": "2021-09-01T16:52:56+08:00",
                    "creatorId": 100,
                    "creatorName": "admin",
                    "id": 1,
                    "name": "test",
                    "obLinks": [],
                    "obproxies": [{
                            "architecture": "x86_64",
                            "clusterId": 1,
                            "exporterPort": 2884,
                            "hostId": 2,
                            "id": 1,
                            "idcName": "am171",
                            "ip": "xxx.xxx.xxx.xxx",
                            "lastActiveTime": "2021-09-01T16:59:06+08:00",
                            "operateStatus": "NORMAL",
                            "parameterVersion": 3,
                            "sqlPort": 2883,
                            "status": "UNAVAILABLE",
                            "version": "1.9.1.1-1919579"
                    }],
                    "parameterVersion": 3,
                    "port": 2883,
                    "topo": [{
                            "count": 1,
                            "idcName": "am171"
                    }],
                    "updateTime": "2021-09-01T16:59:14+08:00",
                    "versions": [{
                            "count": 1,
                            "version": "1.9.1.1-1919579"
                    }],
                    "workMode": "CONFIG_URL"
            }],
            "page": {
                    "number": 1,
                    "size": 10,
                    "totalElements": 1,
                    "totalPages": 1
            }
    },
    "duration": 12,
    "server": "a83ad33525",
    "status": 200,
    "successful": true,
    "timestamp": "2021-09-03T15:59:25.606+08:00",
    "traceId": "dc06ed9d01354597"
}

```

 上一篇 下一篇 ![有帮助](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) 咨询热线