---
title: "发起租户/库/表恢复 - 云平台 OCP V4.4.2 | OceanBase 文档中心"
description: "发起租户/库/表恢复 功能说明 该接口用于将已备份的租户/库/表恢复到目标集群。 调用说明 接口约束 调用者需对恢复的目标集群有创建租户/库/表的权限。 调用者需要通过 OCP 应用服务鉴权。 请求路径 POST /api/v2/ob/clusters/{id}/backup/restore 请求参数 参数 类型 必…"
---
切换语言

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

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

# 发起租户/库/表恢复

更新时间：2026-07-09 19:45:52

[编辑](https://github.com/oceanbase/ocp-doc/edit/V4.4.2/zh-CN/1900.reference-guide/200.api-reference/1300.backup-and-restoration/1200.initiate-tenant-recovery-1.md)  

## 功能说明

该接口用于将已备份的租户/库/表恢复到目标集群。

## 调用说明

### 接口约束

- 调用者需对恢复的目标集群有创建租户/库/表的权限。
 - 调用者需要通过 OCP 应用服务鉴权。

### 请求路径

`POST /api/v2/ob/clusters/{id}/backup/restore`

### 请求参数

| 参数 | 类型 | 必选 | 示例值 | 描述 |
| --- | --- | --- | --- | --- |
| id | Integer | 是 | 1001 | 已备份集群的 ID。 |

**RestoreTenantParam 的数据结构**

| 参数 | 类型 | 必选 | 说明 |
| --- | --- | --- | --- |
| backupTenantStatus | String | 是 | 备份租户的状态，包括：- 在线：ONLINE。 - 离线：OFFLINE。 |
| restoreOnlineTenantRequiredParam | Object | 否 | 当备份租户是在线时，该参数为必选。 |
| restoreObj | String | 否 | 恢复对象类型：- tenant：租户恢复（默认）。 - database：库恢复。 - table：表恢复。 |
| tableRestoreObjects | Array | 否 | 恢复的库表信息，当 restoreObj=database/table 时必填。 |
| \|----sourceDatabase | String | 否 | 源库， 当 restoreObj = database 时传入。 |
| \|----targetDatabase | String | 否 | 目标库， 当 restoreObj = database 时传入。 |
| \|----sourceTable | String | 否 | 源表， 当 restoreObj = table 时传入。 |
| \|----targetTable | String | 否 | 目标表， 当 restoreObj = table 时传入。 |
| \|----backupClusterId | Long | 是 | 备份集群 ID。 |
| \|----backupTenantId | Long | 是 | 备份租户 ID。 |
| \|----restoreClusterId | Long | 是 | 恢复集群 ID。 |
| \|----restoreEndTime | OffsetDateTime | 是 | 恢复到某个时刻。 |
| \|----restoreTenantInfoParam | Object | 是 | 恢复的目标租户模型。 |
| \|----restoreMethod | String | 否 | 指定数据恢复的方式，需要 OBServer 版本 >= 4.3.3：- full：全量恢复（默认）。 - quick：快速恢复。   > **说明**   > - 快速恢复支持仅恢复日志备份而不恢复数据备份即可对外提供只读服务，在数据备份较大时，本功能将极大地减少恢复的等待时间，也极大地降低用户的使用成本。 > - 使用限制：恢复完的租户处于只读状态，不支持合并和数据备份。 |
| \|----name | String | 是 | 租户名。 |
| \|----primaryZone | String | 否 | 主可用区。 |
| \|----zones | Arrays | 是 | Zone 配置。 |
| \|--------name | String | 是 | Zone 名。 |
| \|--------replicaType | String | 是 | 副本类型，包括：- FULL。 - LOGONLY。 - READONLY。 |
| \|--------resourcePool | Object | 是 | 资源池配置。 |
| \|--------unitSpecName | String | 是 | 规格名。 |
| \|--------unitCount | Long | 是 | 规格数目。 |
| restoreOfflineTenantRequiredParam | Object | 是 | 当备份租户是离线时，该参数为必选。 |
| \|----backupMode | String | 是 | 备份方式。 |
| \|----backupClusterName | String | 是 | 备份集群名。 |
| \|----backupObClusterId | Long | 否 | 备份集群 OceanBase 侧 ID。。 |
| \|----backupTenantName | String | 是 | 备份租户名。 |
| \|----backupObTenantId | Long | 否 | 备份租户 OceanBase 侧 ID。。 |
| \|----restoreClusterId | Long | 是 | 恢复集群 ID。 |
| \|----obBackupStorageBaseInfo | Object | 是 | 备份存储信息，参照 [创建集群的备份策略](https://www.oceanbase.com/docs/common-ocp-1000000006010994) 中的具体数据结构。 |
| \|----restoreEndTime | OffsetDateTime | 是 | 恢复到某个时刻。 |
| \|----restoreTenantInfoParam | Object | 是 | 恢复的目标租户模型，同在线恢复中的模型。 |

### 返回结果

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

**`BackupCommonResponse` 的数据结构**

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| obBackupTaskType | String | 备份操作类型，如 "CREATE_BACKUP_STRATEGY"。 |
| backupObjectOpsResultList | Array | 备份对象操作结果集。 |
| \|--obBackupObjectList | Array | 备份对象列表。 |
| \|--clusterId | Long | 集群 ID。 |
| \|--tenantId | Long | 租户 ID。 |
| \|--backupDimension | String | 备份维度，如 CLUSTER 代表集群备份，TENANT 代表租户备份。 |
| \|--beSuccessful | Boolean | 操作是否成功。 |
| \|--taskIdList | Array | 任务编号列表，在有异步任务下返回。 |
| \|--errorCode | Object | 错误码。 |
| \|--hint | String | 提示信息。 |

## 示例

### 请求示例

```Java
{
    "backupTenantStatus": "ONLINE",
    "restoreOnlineTenantRequiredParam": {
        "restoreClusterId": 9,
        "restoreTenantInfoParam": {
            "name": "mysql_1",
            "zones": [
                {
                    "name": "zone1",
                    "replicaType": "FULL",
                    "resourcePool": {
                        "unitSpecName": "S1",
                        "unitCount": 1
                    }
                }
            ],
            "primaryZone": "zone1"
        },
        "backupClusterId": 9,
        "backupTenantId": 21,
        "restoreEndTime": "2020-11-11T00:50:00.215+08:00"
    }
}

```

### 返回示例

```java
{
    "data": {
        "backupObjectOpsResultList": [
            {
                "beSuccessful": true,
                "obBackupObjectList": [
                    {
                        "backupDimension": "CLUSTER",
                        "clusterId": 1000005
                    }
                ],
                "taskIdList": [
                    3000041
                ]
            }
        ],
        "obBackupTaskType": "RESTORE"
    },
    "duration": 51,
    "server": "a83ad33525",
    "status": 200,
    "successful": true,
    "timestamp": "2021-09-07T14:51:41.135+08:00",
    "traceId": "5962f337662d4043"
}

```

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