---
title: "修改租户副本 | OceanBase 文档中心"
description: "修改租户副本 功能说明 修改指定租户的副本时使用的接口。 调用说明 接口约束 调用者需要通过 OCP 应用服务鉴权。 请求路径 POST /api/v2/ob/clusters/{id}/tenants/{tenantId}/modifyReplica 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}/modifyReplica`

**path:**

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

### 请求参数

| 参数 | 类型 | 必选 | 示例值 | 描述 |
| --- | --- | --- | --- | --- |
| zoneName | String | 是 | foo | 租户名称，集群下唯一 |
| replicaType | String | 否 | FULL | 副本类型，取值范围： - FULL - LOGONLY - READONLY |
| resourcePool | Object | 否 | -- | -- |
| ├─unitSpecName | Object | 否 | S1 | 可在 Unit 规格管理"页面上查看规格列表 |
| ├─unitCount | Integer | 否 | 1 | Unit 个数 |

### 返回结果

基础数据结构

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| data | Object | 创建成功的租户信息，异步 DAG 任务信息，详情参见 [DAG 任务信息](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/modifyReplica`

body:

```unknow
[
  {
    "zoneName": "zone1",
    "replicaType": "FULL",
    "resourcePool": {
      "unitSpecName": "S1",
      "unitCount": 1
    }
  }
]

```

### 返回示例

```unknow
{
  "data": {
    "cluster": {
      "id": 20,
      "name": "ob_upgrade",
      "obClusterId": 20
    },
    "context": "Context(parallelIdx=-1, stringMap={tenant_id=3, cluster_id=20, zone_name=zone2}, listMap={})",
    "creator": {
      "id": 100,
      "name": "admin"
    },
    "id": 94494,
    "name": "Modify tenant replica",
    "startTime": "2021-03-01T15:12:07.419+08:00",
    "status": "RUNNING",
    "tasks": [
      {
        "description": "Wait alter locality",
        "downstreams": [
          112165
        ],
        "id": 112163,
        "name": "Wait alter locality",
        "operation": "EXECUTE",
        "status": "PENDING",
        "upstreams": [
          112164
        ]
      },
      {
        "description": "Prepare alter tenant",
        "downstreams": [
          112163
        ],
        "id": 112164,
        "name": "Prepare alter tenant",
        "operation": "EXECUTE",
        "status": "RUNNING",
        "upstreams": [

        ]
      },
      {
        "description": "Sync tenant information",
        "downstreams": [
          112166
        ],
        "id": 112165,
        "name": "Sync tenant information",
        "operation": "EXECUTE",
        "status": "PENDING",
        "upstreams": [
          112163
        ]
      },
      {
        "description": "Update tenant status",
        "downstreams": [

        ],
        "id": 112166,
        "name": "Update tenant status",
        "operation": "EXECUTE",
        "status": "PENDING",
        "upstreams": [
          112165
        ]
      }
    ],
    "tenant": {
      "id": 3,
      "name": "tenant1"
    }
  },
  "duration": 406,
  "server": "a83ad33525",
  "status": 200,
  "successful": true,
  "timestamp": "2021-03-01T15:12:07.449+08:00",
  "traceId": "71f24180979c487b"
}

```

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