obshell 备份命令组 - OceanBase 数据库 V4.3.5

obshell 备份命令组

更新时间：2026-04-07 20:57:20

本文档介绍 obshell 的备份命令组，备份命令组可用于设置备份配置及查看备份任务。该命令组要求 OceanBase 集群已经被初始化。您可通过在命令中配置 -h/--help 选项查看命令的帮助信息，当任务执行报错时，也可配置 -v/--verbose 选项查看命令的详细执行过程。

obshell backup set-config

使用该命令可对所有租户或者指定租户设置备份相关配置项。

${home_path}/bin/obshell backup set-config [flags]

# example
/home/admin/oceanbase/bin/obshell backup set-config -t tenant1 -d /path/to/backup/data -a /path/to/backup/archive

home_path 为 OceanBase 数据库的安装目录，obshell 默认在 OceanBase 数据库安装目录的 bin 目录下。

选项说明见下表：

选项名	是否必选	数据类型	默认值	说明
-t/--tenant_name	否	string	无	设置需要备份配置的某个租户名。若不设置，则对集群内所有租户进行设置。
-d/--data_backup_uri	否	string	无	设置租户的数据备份目的端。若之前设置过备份目的端，此处不配置该选项则采用之前设置的配置；若之前未设置过备份目的端，此处不配置该选项则默认为空。说明该选项仅在配置了 `-t/--tenant_name 时生效。`
-a/--archive_log_uri	否	string	无	设置租户的日志归档目的端。若之前设置过日志归档目的端，此处不配置该选项则采用之前设置的配置；若之前未设置过日志归档目的端，此处不配置该选项则默认为空。说明该选项仅在配置了 `-t/--tenant_name 时生效。`
-u/--backup_base_uri	否	string	无	设置所有租户的备份目的端。配置后会在该路径下根据一定规则拼接每个租户的数据备份路径和日志归档路径。说明该选项仅在未配置 `-t/--tenant_name 时生效，两者同时配置会报错。`
-c/--log_archive_concurrency	否	int	无	设置日志归档的总工作线程数量。
-b/--binding	否	string	Optional	仅支持设置为 `Optional`（以用户业务优先）和 `Mandatory`（以归档优先）。如果未配置，默认为 Optional 模式。
-i/--piece_switch_interval	否	string	无	用于配置 piece 的切换周期，取值范围为 [1d, 7d]。
-l/--archive_lag_target	否	string	无	控制租户日志归档的延迟时间。如需修改，请确认已完成日志归档目的端的配置。
-D/--delete_policy	否	string	default	设置清理策略，设置了清理策略的租户将会每小时触发一次自动清理。当前仅支持设置为 `default`，表示自动清理的范围仅为 `-d`/`--data_backup_uri` 和 `-a`/`--archive_log_uri` 值中的备份。
-r/--delete_recovery_window	否	string	无	控制备份数据可恢复的时间窗口，设置时需要带时间单位。该选项的使用可参考清理备份相关参数介绍。
-s/--ha_low_thread_score	否	int	无	指定备份、备份清理等中低优先级任务的当前工作线程数。取值范围为 [0, 100]。
-y/--yes	否	无	无	该选项无需传值，命令中配置即表示跳过二次确认。

obshell cluster backup

使用该命令可对集群中的所有租户设置备份相关配置项并进行备份。命令的详细使用可参见发起集群级备份。

${home_path}/bin/obshell cluster backup [flags]

# example
/home/admin/oceanbase/bin/obshell cluster backup -u /path/to/backup --backup_mode incremental --encryption MySecretPassword

home_path 为 OceanBase 数据库的安装目录，obshell 默认在 OceanBase 数据库安装目录的 bin 目录下。

选项说明见下表：

选项名	是否必选	数据类型	默认值	说明
-u/--backup_base_uri	否	string	无	设置所有租户的备份目的端。设置后会在该路径下根据一定规则拼接每个租户的数据备份路径和日志归档路径。若之前设置过备份目的端，此处不配置该选项则采用之前设置的配置；若之前未设置过备份目的端，此处不配置该选项则默认为空。
-m/--backup_mode	否	string	full	数据备份模式，可取值为 `full` 和 `incremental`，分别表示全量备份（`full`）和增量备份（`incremental`）。
-c/--log_archive_concurrency	否	int	无	设置日志归档的总工作线程数量。
-b/--binding	否	string	Optional	设置归档和业务的优先模式。目前支持设置为 `Optional`（以用户业务优先）和 `Mandatory`（以归档优先）。如果未配置，默认为 Optional 模式。
-i/--piece_switch_interval	否	string	无	用于配置 piece 的切换周期，取值范围为 [1d, 7d]。
-e/--encryption	否	string	无	为备份后的备份集设置密码。如果设置了该选项，在使用该备份集进行恢复时，需要输入该密码，且该密码不能被删除。
-l/--archive_lag_target	否	string	无	控制租户日志归档的延迟时间。如需修改，请确认已完成日志归档目的端的配置。
-D/--delete_policy	否	string	default	设置清理策略，设置了清理策略的租户将会每小时触发一次自动清理。当前仅支持设置为 `default`，表示自动清理的范围仅为 `-u`/`--backup_base_uri` 值中的备份。
-r/--delete_recovery_window	否	string	无	控制备份数据可恢复的时间窗口，设置时需要带时间单位。该选项的使用可参考清理备份相关参数介绍。
-s/--ha_low_thread_score	否	int	无	指定备份、备份清理等中低优先级任务的当前工作线程数。取值范围为 [0, 100]。
-P/--plus_archive	否	无	无	控制是否在数据备份过程中同时将归档日志一起备份，无需传值。添加该选项后，最终备份目录下会生成一份带有归档日志的完整数据集。
-y/--yes	否	无	无	该选项无需传值，命令中配置即表示跳过二次确认。

obshell tenant backup

使用该命令可对指定租户设置备份相关配置项并进行备份。

${home_path}/bin/obshell tenant backup <tenant_name> [flags]

# example
/home/admin/oceanbase/bin/obshell tenant backup t1 -d /path/to/backup/data --backup_mode incremental --encryption MySecretPassword

home_path 为 OceanBase 数据库的安装目录，obshell 默认在 OceanBase 数据库安装目录的 bin 目录下。tenant_name 需配置为待备份的租户名称。

命令的选项说明如下：

选项名	是否必选	数据类型	默认值	说明
-d/--data_backup_uri	否	string	无	设置租户的数据备份目的端。若之前设置过备份目的端，此处不配置该选项则采用之前设置的配置；若之前未设置过备份目的端，此处不配置该选项则默认为空。
-a/--archive_log_uri	否	string	无	设置租户的日志归档目的端。若之前设置过日志归档目的端，此处不配置该选项则采用之前设置的配置；若之前未设置过日志归档目的端，此处不配置该选项则默认为空。
-m/--backup_mode	否	string	full	数据备份模式，可取值为 `full` 和 `incremental`，分别表示全量备份（`full`）和增量备份（`incremental`）。
-c/--log_archive_concurrency	否	int	无	日志归档总的工作线程数量。
-b/--binding	否	string	Optional	设置归档和业务的优先模式。目前支持设置为 `Optional`（以用户业务优先）和 `Mandatory`（以归档优先）。如果未配置，默认为 Optional 模式。
-i/--piece_switch_interval	否	string	无	用于配置 piece 的切换周期，取值范围为 [1d, 7d]。
-e/--encryption	否	string	无	为备份后的备份集设置密码。如果设置了该选项，在使用该备份集进行恢复时，需要输入该密码，且该密码不能被删除。
-l/--archive_lag_target	否	string	无	控制租户日志归档的延迟时间。如需修改，请确认已完成日志归档目的端的配置。
-D/--delete_policy	否	string	default	设置清理策略，设置了清理策略的租户将会每小时触发一次自动清理。当前仅支持设置为 `default`，表示自动清理的范围仅为 `-d`/`--data_backup_uri` 和 `-a`/`--archive_log_uri` 值中的备份。
-r/--delete_recovery_window	否	string	无	控制备份数据可恢复的时间窗口，设置时需要带时间单位。该选项的使用可参考清理备份相关参数介绍。
-s/--ha_low_thread_score	否	int	无	指定备份、备份清理等中低优先级任务的当前工作线程数。取值范围为 [0, 100]。
-P/--plus_archive	否	无	无	控制是否在数据备份过程中同时将归档日志一起备份，无需传值。添加该选项后，最终备份目录下会生成一份带有归档日志的完整数据集。
-y/--yes	否	无	无	该选项无需传值，命令中配置即表示跳过二次确认。

obshell backup show

使用该命令可展示所有租户或者指定租户的备份任务。

${home_path}/bin/obshell backup show [flags]

# example
/home/admin/oceanbase/bin/obshell backup show -d

home_path 为 OceanBase 数据库的安装目录，obshell 默认在 OceanBase 数据库安装目录的 bin 目录下。

选项名	是否必选	数据类型	默认值	说明
-t/--tenant_name	否	string	无	指定需要展示备份任务的某个租户名。若不设置，则展示集群内所有租户的备份任务。
-d/--show_detail	否	无	无	控制是否展示备份任务的详细信息，无需传值。