OBProxy 集群添加可连接 OceanBase 集群

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

编辑

功能说明

为 OBProxy 集群添加可连接 OceanBase 集群

调用说明

接口约束

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

请求路径

POST /api/v2/obproxy/clusters/{id}/obLinks/batchAdd

请求参数

path：

参数	类型	必选	示例值	描述
id	Long	是	1	OBProxy 集群 ID。

body：

参数	类型	必选	示例值	描述
obLinks	Array	是	-	可连接的 OceanBase 集群信息。
├─ clusterName	String	是	foo	集群名。
├─ obClusterId	Integer	-	1	集群在 OceanBase 侧的集群 ID。当 OBProxy 集群启动方式为 RsList 时，该参数为必填项。当 OBProxy 集群启动方式为 ConfigUrl 时，该参数为非必填项。
├─ username	String	是	proxyro	连接集群的用户。

返回结果

基础数据结构

参数	类型	说明
successful	Boolean	请求是否成功。
timestamp	Datetime	服务端完成请求的时间戳。
duration	Integer	服务端处理请求的时间（毫秒）。
status	Integer	符合 HTTP Status 规范的编码。
traceId	String	请求的 Trace ID，用于排查问题。
server	String	响应请求的应用服务的地址。

示例

请求示例

POST /api/v2/obproxy/clusters/1/obLinks/batchAdd

{
        "username": "proxyro",
        "obClusterId": 1,
        "clusterName": "hooray"
}

返回示例

{
        "duration": 121,
        "server": "a83ad33525",
        "status": 200,
        "successful": true,
        "timestamp": "2021-09-03T16:48:32.957+08:00",
        "traceId": "87dbc0dd2459490c"
}