---
title: "删除 OBProxy | OceanBase 文档中心"
description: "删除 OBProxy 功能说明 删除 OBProxy 时使用的接口。 调用说明 接口约束 调用者需要通过 OCP 应用服务鉴权。 请求路径 DELETE /api/v2/obproxy/clusters/{id}/obproxies/{obproxyIds} 请求参数 参数 类型 必选 示例值 描述 id Long …"
---
切换语言

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

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

# 删除 OBProxy

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

## 功能说明

删除 OBProxy 时使用的接口。

## 调用说明

### 接口约束

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

### 请求路径

`DELETE /api/v2/obproxy/clusters/{id}/obproxies/{obproxyIds}`

### 请求参数

| 参数 | 类型 | 必选 | 示例值 | 描述 |
| --- | --- | --- | --- | --- |
| id | Long | 是 | 1 | OBProxy 集群 ID |
| obproxyIds | Long | 是 | 1,2,3,4 | OBProxy server ID |

### 返回结果

基础数据结

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| data | Object | 异步任务信息，详情参见 [任务信息](https://www.oceanbase.com/docs/enterprise-oceanbase-ocp-cn-10000000001540216)。 |
| successful | Boolean | 请求是否成功。 |
| timestamp | Datetime | 服务端完成请求的时间戳。 |
| duration | Integer | 服务端处理请求的时间（毫秒）。 |
| status | Integer | 符合 HTTP Status 规范的编码。 |
| traceId | String | 请求的 Trace ID，用于排查问题。 |
| server | String | 响应请求的应用服务的地址。 |

## 示例

### 请求示例

`DELETE /api/v2/obproxy/clusters/1/obproxies/2`

### 返回示例

```unknow
{
        "data": {
                "context": {
                        "listMap": {
                                "obproxy_server_ids": ["2"],
                                "host_ids": ["2"]
                        },
                        "parallel": false,
                        "parallelIdx": -1,
                        "stringMap": {
                                "service_type": "OB_PROXY",
                                "obproxy_need_delete_cluster": "false",
                                "prohibit_rollback": "false",
                                "service_name": "test"
                        }
                },
                "creator": "admin",
                "executor": "xxx.xxx.xxx.xxx",
                "id": 33149,
                "name": "Offline obproxy",
                "operation": "EXECUTE",
                "startTime": "2021-09-03T16:31:58.151+08:00",
                "status": "RUNNING",
                "subtasks": [{
                        "className": "com.alipay.ocp.service.task.business.obproxy.DeleteObproxyMetaInfoTask",
                        "description": "Delete obproxy info",
                        "downstreams": [34970],
                        "id": 34964,
                        "name": "Delete obproxy info",
                        "nodeType": "JAVA_TASK",
                        "operation": "EXECUTE",
                        "parallelIdx": -1,
                        "prohibitRollback": false,
                        "runTime": 1,
                        "seriesId": 0,
                        "status": "PENDING",
                        "timeout": 300,
                        "upstreams": [34963]
                }, {
                        "className": "com.alipay.ocp.service.task.business.host.UnReserveHostTask",
                        "description": "Unreserve host",
                        "downstreams": [34968],
                        "id": 34966,
                        "name": "Unreserve host",
                        "nodeType": "JAVA_TASK",
                        "operation": "EXECUTE",
                        "parallelIdx": -1,
                        "prohibitRollback": false,
                        "runTime": 1,
                        "seriesId": 3,
                        "status": "PENDING",
                        "timeout": 1800,
                        "upstreams": [34970]
                }, {
                        "className": "com.alipay.ocp.service.task.business.obproxy.UninstallObproxyTask",
                        "description": "Stop and uninstall obproxy",
                        "downstreams": [34964],
                        "id": 34963,
                        "name": "Stop and uninstall obproxy",
                        "nodeType": "JAVA_TASK",
                        "operation": "EXECUTE",
                        "parallelIdx": 0,
                        "prohibitRollback": false,
                        "runTime": 1,
                        "seriesId": 1,
                        "status": "PENDING",
                        "timeout": 1800,
                        "upstreams": [34965]
                }, {
                        "className": "com.alipay.ocp.service.task.business.obproxy.FinishTask",
                        "description": "Finish node",
                        "downstreams": [],
                        "id": 34968,
                        "name": "Finish node",
                        "nodeType": "JAVA_TASK",
                        "operation": "EXECUTE",
                        "parallelIdx": -1,
                        "prohibitRollback": false,
                        "runTime": 1,
                        "seriesId": 2,
                        "status": "PENDING",
                        "timeout": 0,
                        "upstreams": [34966]
                }, {
                        "className": "com.alipay.ocp.service.task.business.obproxy.OfflineObproxyExporterTask",
                        "description": "Offline obproxy exporter",
                        "downstreams": [34966],
                        "id": 34970,
                        "name": "Offline obproxy exporter",
                        "nodeType": "JAVA_TASK",
                        "operation": "EXECUTE",
                        "parallelIdx": 0,
                        "prohibitRollback": false,
                        "runTime": 1,
                        "seriesId": 7,
                        "status": "PENDING",
                        "timeout": 30,
                        "upstreams": [34964]
                }, {
                        "className": "com.alipay.ocp.service.task.business.obproxy.PrepareOfflineObproxyTask",
                        "description": "Prepare offline obproxy",
                        "downstreams": [34965],
                        "id": 34967,
                        "name": "Prepare offline obproxy",
                        "nodeType": "JAVA_TASK",
                        "operation": "EXECUTE",
                        "parallelIdx": 0,
                        "prohibitRollback": false,
                        "runTime": 1,
                        "seriesId": 5,
                        "status": "PENDING",
                        "timeout": 1800,
                        "upstreams": [34969]
                }, {
                        "className": "com.alipay.ocp.service.task.business.WaitNode",
                        "description": "Wait node",
                        "downstreams": [34963],
                        "id": 34965,
                        "name": "Wait node",
                        "nodeType": "JAVA_TASK",
                        "operation": "EXECUTE",
                        "parallelIdx": -1,
                        "prohibitRollback": false,
                        "runTime": 1,
                        "seriesId": 4,
                        "status": "PENDING",
                        "timeout": 30,
                        "upstreams": [34967]
                }, {
                        "className": "com.alipay.ocp.service.task.business.StartNode",
                        "description": "Start node",
                        "downstreams": [34967],
                        "id": 34969,
                        "name": "Start node",
                        "nodeType": "JAVA_TASK",
                        "operation": "EXECUTE",
                        "parallelIdx": -1,
                        "prohibitRollback": false,
                        "runTime": 1,
                        "seriesId": 6,
                        "status": "READY",
                        "timeout": 30,
                        "upstreams": []
                }],
                "taskDefinitionId": -1,
                "type": "MANUAL"
        },
        "duration": 17,
        "server": "a83ad33525",
        "status": 200,
        "successful": true,
        "timestamp": "2021-09-03T16:31:58.162+08:00",
        "traceId": "0fda4c74b7a84932"
}

```

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