---
title: "删除租户副本 | OceanBase 文档中心"
description: "删除租户副本 功能说明 为指定租户删除副本时使用的接口。 调用说明 接口约束 调用者需要通过 OCP 应用服务鉴权。 请求路径 POST /api/v2/ob/clusters/{id}/tenants/{tenantId}/deleteReplica path: 参数 类型 必选 示例值 描述 id Long 是 …"
---
切换语言

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

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

# 删除租户副本

更新时间：2024-10-18 17:00:42

## 功能说明

为指定租户删除副本时使用的接口。

## 调用说明

### 接口约束

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

### 请求路径

`POST /api/v2/ob/clusters/{id}/tenants/{tenantId}/deleteReplica`

**path:**

| 参数 | 类型 | 必选 | 示例值 | 描述 |
| --- | --- | --- | --- | --- |
| id | Long | 是 | 1 | 集群 ID |
| tenantId | Long | 是 | 1 | 租户 ID |

### 请求参数

| 参数 | 类型 | 必选 | 示例值 | 描述 |
| --- | --- | --- | --- | --- |
| zoneName | String | 是 | foo | 租户名称，集群下唯一 |

### 返回结果

基础数据结构

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 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 | 响应请求的应用服务的地址。 |

## 示例

### 请求示例

`POST /api/v2/ob/clusters/1/tenants/2/addReplica`

body:

```unknow
[
  {
    "zoneName": "zone1"
  },
  {
    "zoneName": "zone2"
  }
]

```

### 返回示例

```unknow
{
  "data": {
    "clusterId": 9,
    "context": {
      "listMap": {
        "zone_names": [
          "zone3"
        ]
      },
      "parallel": false,
      "parallelIdx": -1,
      "stringMap": {
        "tenant_id": "18",
        "cluster_id": "9"
      }
    },
    "creator": "admin",
    "executor": "xxx.xxx.xxx.xxx",
    "id": 239885,
    "name": "Delete tenant replica",
    "operation": "EXECUTE",
    "startTime": "2021-06-30T12:06:51.078+08:00",
    "status": "RUNNING",
    "subtasks": [
      {
        "className": "com.alipay.ocp.service.task.business.tenant.UpdateTenantStatusTask",
        "description": "Update tenant status",
        "downstreams": [

        ],
        "id": 305073,
        "name": "Update tenant status",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": -1,
        "runTime": 1,
        "seriesId": 1,
        "status": "PENDING",
        "timeout": 300,
        "upstreams": [
          305072
        ]
      },
      {
        "className": "com.alipay.ocp.service.task.business.tenant.PrepareResourcePoolTask",
        "description": "Prepare resource pool",
        "downstreams": [
          305070
        ],
        "id": 305074,
        "name": "Prepare resource pool",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": -1,
        "runTime": 1,
        "seriesId": 5,
        "status": "PENDING",
        "timeout": 300,
        "upstreams": [
          305071
        ]
      },
      {
        "className": "com.alipay.ocp.service.task.business.tenant.DeleteResourcePoolTask",
        "description": "Delete resource pool",
        "downstreams": [
          305072
        ],
        "id": 305070,
        "name": "Delete resource pool",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": 0,
        "runTime": 1,
        "seriesId": 0,
        "status": "PENDING",
        "timeout": 300,
        "upstreams": [
          305074
        ]
      },
      {
        "className": "com.alipay.ocp.service.task.business.tenant.WaitAlterLocalityTask",
        "description": "Wait alter locality",
        "downstreams": [
          305074
        ],
        "id": 305071,
        "name": "Wait alter locality",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": -1,
        "runTime": 1,
        "seriesId": 2,
        "status": "PENDING",
        "timeout": 3600,
        "upstreams": [
          305069
        ]
      },
      {
        "className": "com.alipay.ocp.service.task.business.tenant.SyncTenantInfoTask",
        "description": "Sync tenant information",
        "downstreams": [
          305073
        ],
        "id": 305072,
        "name": "Sync tenant information",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": -1,
        "runTime": 1,
        "seriesId": 4,
        "status": "PENDING",
        "timeout": 300,
        "upstreams": [
          305070
        ]
      },
      {
        "className": "com.alipay.ocp.service.task.business.tenant.PrepareAlterTenantTask",
        "description": "Prepare alter tenant",
        "downstreams": [
          305071
        ],
        "id": 305069,
        "name": "Prepare alter tenant",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": -1,
        "runTime": 1,
        "seriesId": 3,
        "status": "READY",
        "timeout": 300,
        "upstreams": [

        ]
      }
    ],
    "taskDefinitionId": -1,
    "tenantId": 18,
    "type": "MANUAL"
  },
  "duration": 104,
  "server": "a83ad33525",
  "status": 200,
  "successful": true,
  "timestamp": "2021-06-30T12:06:51.103+08:00",
  "traceId": "55f85ba1c1db4b13"
}

```

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