---
title: "备份与恢复 - 安装部署工具 OBD V3.5.0 | OceanBase 文档中心"
description: 备份与恢复 obd 自 V3.2.0 起支持通过命令进行租户备份与恢复的功能，本文详细介绍如何操作。 说明 使用 obd 命令进行备份与恢复时，涉及集群需是被 obd 管理的集群，否则 obd 无法获取集群的信息。obd 部署的集群默认由 obd 管理，非 obd 部署的集群可执行接管操作进行接管。接管的详细操作可参…
---
切换语言

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

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*Qq8pT6yBPTcAAAAAAAAAAAAADiGDAQ/original) 安装部署工具 OBDV 3.5.0

# 备份与恢复

更新时间：2025-09-08 10:46:16

[编辑](https://github.com/oceanbase/obd-doc/edit/V3.5.0/zh-CN/400.user-guide/300.command-line-operations/1200.backup-and-recovery.md)  

obd 自 V3.2.0 起支持通过命令进行租户备份与恢复的功能，本文详细介绍如何操作。

#### 说明

- 使用 obd 命令进行备份与恢复时，涉及集群需是被 obd 管理的集群，否则 obd 无法获取集群的信息。obd 部署的集群默认由 obd 管理，非 obd 部署的集群可执行接管操作进行接管。接管的详细操作可参见 [使用 obd 接管集群](https://www.oceanbase.com/docs/common-obd-cn-1000000003754544)。
 - 本文中使用的所有命令的详细介绍均可参见 [集群命令组](https://www.oceanbase.com/docs/common-obd-cn-1000000003754444)，搜索对应命令即可。

## 前提条件

在开始之前，请确保您已满足以下条件：

- 您已安装 V3.2.0 或之后版本 obd，建议安装最新版本。安装 obd 的详细操作您可参见 [安装 obd](https://www.oceanbase.com/docs/common-obd-cn-1000000003754455)。
 - 待备份或恢复的租户所在集群中存在 obshell，且 obshell 处于正常运行状态。
 - 已配置合适的备份目的端。

## 租户备份

本节以对部署名为 `test` 的集群的 `obmysql` 租户进行备份为例。您需根据实际情况修改示例，建议使用 OSS 作为备份的目的端。

#### 说明

不支持使用备份命令备份系统租户（sys 租户）。

1. 配置备份信息

       阿里云 OSS   NFS   AWS S3

   ```shell
   obd cluster tenant set-backup-config test obmysql -d 'oss://oceanbase-test-bucket/backup/data?host=****.aliyun-inc.com&access_id=****&access_key=****&delete_mode=delete&checksum_type=md5' -a 'oss://oceanbase-test-bucket/backup/log?host=****.aliyun-inc.com&access_id=****&access_key=****&delete_mode=delete&checksum_type=md5'

   ```

   示例中，`oss://` 表示使用 OSS 作为备份介质类型，存储桶名 `oceanbase-test-bucket`，在存储桶中的路径是 `/backup/data` 和 `/backup/log`，同时使用 `?` 来分隔路径的其他参数，`host` 用于设置存储桶的主机地址，`access_id` 和 `access_key` 用于设置 OSS 的访问密钥，清理模式为 `delete`，使用 MD5 算法来校验备份数据的完整性。

   数据备份路径中参数的具体介绍可参见官网《OceanBase 数据库》文档 [SET DATA_BACKUP_DEST](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000002016885) 一文中 `data_backup_path` 部分内容。

   ```shell
   obd cluster tenant set-backup-config test obmysql -d 'file:///data/nfs/backup/data' -a 'file:///data/nfs/backup/log'

   ```

   ```shell
   obd cluster tenant set-backup-config test obmysql -d 's3://oceanbase-test-bucket/backup/data?host=s3.<region>.amazonaws.com&access_id=****&access_key=****&s3_region=****&delete_mode=delete&checksum_type=crc32' -a 's3://oceanbase-test-bucket/backup/log?host=s3.<region>.amazonaws.com&access_id=****&access_key=****&s3_region=****&delete_mode=delete&checksum_type=crc32'

   ```

   示例中，`s3://` 表示使用 S3 作为备份介质类型，存储桶名 `oceanbase-test-bucket`，在存储桶中的路径是 `/backup/data` 和 `/backup/log`，同时使用 `?` 来分隔路径的其他参数，`host` 用于设置 Amazon S3 服务的域名，`access_id` 和 `access_key` 用于设置 AWS 服务的访问密钥，`s3_region` 在使用 S3 作为备份介质时为必选参数，表示 S3 的存储桶所在的地域，清理模式为 `delete`，使用 CRC32 算法来校验备份数据的完整性。

   数据备份路径中参数的具体介绍可参见官网《OceanBase 数据库》文档 [SET DATA_BACKUP_DEST](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000002016885) 一文中 `data_backup_path` 部分内容。
 2. 执行备份

       执行全量备份   执行增量备份

   ```shell
   obd cluster tenant backup test obmysql

   ```

   ```shell
   obd cluster tenant backup test obmysql -m incremental

   ```
 3. 查看备份任务

   ```shell
   obd cluster tenant backup-show test obmysql

   ```

   此处以备份租户为部署名 `test` 集群中的 `obmysql` 租户，OBServer 节点为 `10.10.10.1` 为例，您需根据实际情况修改示例。输出如下，`task_status` 列状态为 `COMPLETED` 表示备份成功。

   ```shell
   +---------------------------------------------------------------------------------------------------------+
   |                               backup task details of backup tenant obmysql                              |
   +-----------+----------------------------------+----------------------------------+-------------+---------+
   | tenant_id | start_timestamp                  | end_timestamp                    | task_status | comment |
   +-----------+----------------------------------+----------------------------------+-------------+---------+
   | 1002      | 2025-03-26T14:56:47.623096+08:00 | 2025-03-26T14:58:15.234362+08:00 | COMPLETED   | -       |
   +-----------+----------------------------------+----------------------------------+-------------+---------+

   ```
 4. （可选）取消备份任务

   ```shell
   obd cluster tenant backup-cancel test obmysql

   ```

   该命令可取消非 `COMPLETED` 状态的备份任务，执行取消备份命令后，可等几分钟后执行 `obd cluster tenant backup-show` 命令查看备份任务是否已取消。输出如下，`task_status` 列状态为 `CANCELED` 表示备份任务已取消。

   ```shell
   +--------------------------------------------------------------------------------------------------------------------+
   |                                    backup task details of backup tenant obmysql                                    |
   +-----------+----------------------------------+----------------------------------+-------------+--------------------+
   | tenant_id | start_timestamp                  | end_timestamp                    | task_status | comment            |
   +-----------+----------------------------------+----------------------------------+-------------+--------------------+
   | 1002      | 2025-03-26T15:15:49.728777+08:00 | 2025-03-26T15:16:18.547451+08:00 | CANCELED    | Operation canceled |
   +-----------+----------------------------------+----------------------------------+-------------+--------------------+

   ```

## 租户恢复

本节以在部署名为 `obtest` 的集群中创建 `restore_1` 租户，并将备份数据恢复到该租户为例，您需根据实际情况修改示例。

1. 执行恢复

   ```shell
   obd cluster tenant restore obtest restore_1 'oss://oceanbase-test-bucket/backup/data/?host=***.aliyun-inc.com&access_id=***&access_key=***' 'oss://oceanbase-test-bucket/backup/log/?host=***.aliyun-inc.com&access_id=***&access_key=***' --memory_size=2G --max_cpu=2

   ```

   您可通过指定命令选项设置待恢复租户的资源情况，未设置选项时默认使用集群剩余所有资源创建待恢复租户。命令的详细介绍可参见 [集群命令组](https://www.oceanbase.com/docs/common-obd-cn-1000000003754444) 中 **obd cluster tenant restore** 介绍。

   ```shell
   obd cluster tenant restore obtest restore_1 'file:///data/nfs/backup/data' 'file:///data/nfs/backup/log' --memory_size=2G --max_cpu=2

   ```

   ```shell
   obd cluster tenant restore obtest restore_1 's3://oceanbase-test-bucket/backup/data?host=s3.<region>.amazonaws.com&access_id=****&access_key=****&s3_region=****' 's3://oceanbase-test-bucket/backup/log?host=s3.<region>.amazonaws.com&access_id=****&access_key=****&s3_region=****' --memory_size=2G --max_cpu=2

   ```

   您可通过指定命令选项设置待恢复租户的资源情况，未设置选项时默认使用集群剩余所有资源创建待恢复租户。命令的详细介绍可参见 [集群命令组](https://www.oceanbase.com/docs/common-obd-cn-1000000003754444) 中 **obd cluster tenant restore** 介绍。
 2. 查看恢复任务

   ```shell
   obd cluster tenant restore-show obtest restore_1

   ```

   此处以恢复租户为部署名 `obtest` 集群中的 `restore_1` 租户为例，您需根据实际情况修改示例。输出如下，`task_status` 列状态为 `SUCCESS` 表示恢复成功。

   ```shell
   +--------------------------------------------------------------------------------------------------------+
   |                            restore task details of restore tenant restore_1                            |
   +-----------+----------------------------------+---------------------------------+-------------+---------+
   | tenant_id | start_timestamp                  | end_timestamp                   | task_status | comment |
   +-----------+----------------------------------+---------------------------------+-------------+---------+
   | 1         | 2025-03-26T15:27:00.930773+08:00 | 2025-03-26T15:32:11.33193+08:00 | SUCCESS     | -       |
   +-----------+----------------------------------+---------------------------------+-------------+---------+

   ```
 3. 查看集群租户

   ```shell
   obd cluster tenant show obtest

   ```

   输出如下：

   ```shell
   +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   |                                                                                    tenant basic info                                                                                    |
   +-------------+-------------+--------------------+--------------+---------+---------+-------------+---------------------+---------------------+---------------+-------------+-------------+
   | tenant_name | tenant_type | compatibility_mode | primary_zone | max_cpu | min_cpu | memory_size | max_iops            | min_iops            | log_disk_size | iops_weight | tenant_role |
   +-------------+-------------+--------------------+--------------+---------+---------+-------------+---------------------+---------------------+---------------+-------------+-------------+
   | sys         | SYS         | MYSQL              | RANDOM       | 3.0     | 3.0     | 1G          | 9223372036854775807 | 9223372036854775807 | 2G            | 3           | PRIMARY     |
   | restore_1   | USER        | MYSQL              | RANDOM       | 2.0     | 2.0     | 2G          | 9223372036854775807 | 9223372036854775807 | 6G            | 2           | PRIMARY     |
   +-------------+-------------+--------------------+--------------+---------+---------+-------------+---------------------+---------------------+---------------+-------------+-------------+

   ```
 4. （可选）取消恢复任务

   可执行如下命令取消租户恢复任务，需注意，仅可取消非 `SUCCESS` 状态的恢复任务。

   ```shell
   obd cluster tenant restore-cancel obtest restore_1

   ```

   命令执行成功后，可执行 `obd cluster tenant show` 命令查看集群中的租户（输出中无 `obtest` 租户），或执行 `obd cluster tenant restore-show` 命令查看恢复任务（报错无对应租户）。

## 相关文档

- OceanBase 数据库的备份与恢复功能可详见官网《OceanBase 数据库》文档 [管理数据库/备份恢复](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000002012861) 章节。
 - 数据备份路径中参数的具体介绍可参见官网《OceanBase 数据库》文档 [SET DATA_BACKUP_DEST](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000002016885) 一文中 `data_backup_path` 部分内容。

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