备份规则

SDK类名：/backupRule/BackupRule;

备份规则 - 新建

方法名：createBackup;

URL

/backup_rule

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
task_name	String		备份规则名称
biz_grp_list	Array		业务组uuid列表
wk_data_type	Number	是	规则类型:（同原来的） 1：文件； 3：oracle； 4：sqlserver； 14：DM; 21：Oracle rac； 22：GaussDB(HCS)； 23：PostgreSQL； 26：S3；（对象存储文件） 28：GasssDWS；	1
timeout	Number		超时阈值（小时）	1
priority	Number		优先级：0~99999	1
client_list	Array		客户端列表
node_uuid	String		节点UUID/集群UUID
init_main_client	Number		（gauss hcs）初始主客户端，0：关，1：开
unit_uuid	String		存储单元（组）uuid
trans_mode	Number		传输链路： 0：仅TCP/IP； 1：仅LANFree； 2：LANFree优先；
disable	Number		规则禁用： 0：关； 1：开；
tape_pool_uuid	String		磁带池uuid
wk_path	Array		备份内容&参数 - 文件目录（文件类型参数） - 备份路径 备份对象 - 需要备份的（S3）
excl_path	Array		备份内容&参数 - 文件目录（文件类型参数） - 排除路径 备份对象 - 不要备份的（S3）
mirr_file_check	Number		备份内容&参数 - 镜像设置（文件类型参数） - 校验方式： 0：严格校验； 1： 时间校验；	1
mirr_sync_flag	String		备份内容&参数 - 镜像设置（文件类型参数） - 错误处理方式： 0：遇到错误，立即停止同步； 1：遇到错误，写入日志并继续同步；	1
mirr_open_type	Number		备份内容&参数 - 镜像设置（文件类型参数） - 文件打开方式： 0：普通文件； 1：自动选择； 2：MFT；	0
mirr_sync_attr	Number		备份内容&参数 - 镜像设置（文件类型参数 - 文件安全： 0：不同步； 1：同步；	1
ora_sid_name	String		备份内容&参数 - Oracle环境设置（Oracle类型参数） - oracle实例库名称
ora_home_path	String		备份内容&参数 - Oracle环境设置（Oracle类型参数） - oracle Home目录
ora_content_type	Number		备份内容&参数 - 备份内容（Oracle类型参数） - 备份内容： 0：整库； 1：表空间； 2：数据文件； 3：PDBS； 4：CDB； 5：ARCHIVELOG； 6：CONTROLFILE； 7：SPFILE； 8：TABLE；	0
ora_pdbs_name	Array		备份内容&参数 - Oracle环境设置（Oracle类型参数）（备份内容为PDB） - PDB名称
rman_compress_df	Number		备份内容&参数 - 备份内容（Oracle类型参数）（表空间/数据文件） - RMAN传输压缩： 0：关； 1：开； （ 整库/PDBs/CDB$ROOT）	0
rman_num_streams_df_max	Number		备份内容&参数 - 备份内容（Oracle类型参数）（表空间/数据文件） - 并行流数上限： （ 整库/PDBs/CDB$ROOT/ARCHIVELOG）	4
rman_num_streams_df_min	Number		备份内容&参数 - 备份内容（Oracle类型参数）（表空间/数据文件） - 并行流数下限： （ 整库/PDBs/CDB$ROOT/ARCHIVELOG）	4
rman_filespertset_df	Number		备份内容&参数 - 备份内容（Oracle类型参数）（表空间/数据文件） - 每个备份集文件数： （ 整库/PDBs/CDB$ROOT）	20
rman_include_arch_flag	Number		备份内容&参数 - 备份内容（Oracle类型参数）（归档重做日志） - 将归档重做日志包括在全备的和增量的备份计划中： 0：关； 1：开； （ 整库/PDBs/CDB$ROOT）	1
rman_db_readonly	Number		备份内容&参数 - 备份内容（Oracle类型参数）（归档重做日志） - 源端数据库只读： 0：关； 1：开； （ 整库/PDBs/CDB$ROOT & ARCHIVELOG）	0
rman_del_arch	Number		备份内容&参数 - 备份内容（Oracle类型参数）（归档重做日志） - 备份后删除源端归档日志： 0：关； 1：开； （ 整库/PDBs/CDB$ROOT & ARCHIVELOG）	1
rman_arch_retain	Number		备份内容&参数 - 备份内容（Oracle类型参数）（归档重做日志） - 源端归档保留天数： （ 整库/PDBs/CDB$ROOT & ARCHIVELOG）	3
rman_filespertset_arch	Number		备份内容&参数 - 备份内容（Oracle类型参数）（归档重做日志） - 每个备份集文件数： （ 整库/PDBs/CDB$ROOT & ARCHIVELOG）	20
rman_num_streams_arch	Number		备份内容&参数 - 备份内容（Oracle类型参数）（归档重做日志） - 并行流数： （ ARCHIVELOG） 已废弃，ARCHIVELOG并行流数使用与其它类型一致的上、下限参数	4
rman_include_spfile_flag	Number		备份内容&参数 - 备份内容（Oracle类型参数）（参数文件） - 将参数文件包含在全备和增量的计划中： 0：关； 1：开； （ 整库/PDBs/CDB$ROOT）	1
bkup_schedule	Array		执行计划
sched_name	String		名称
backup_type	Number		备份类型：（与旧的配置相同） 0：全量备份/数据备份/合成备份/表备份/归档备份/逻辑备份； 1：增量备份/日志备份/累计增量/日志增量； 2：差异备份/差异增量； 4：日志； 8：日志备份；（Oracle整库，用来区分 累计增量）
retention	Number		保留等级（0~99）
start_window	Array		启动时间窗口
wday	Number		周几：0,1, 2, 3, 4, 5, 6
from	String		开始时间：01:10
to	String		结束时间：02:20
bkup_window	Array		备份时间窗口
wday	Number		周几：0,1, 2, 3, 4, 5, 6
from	String		开始时间：01:10
to	String		结束时间：02:20
bkup_policy	Number		执行策略： 0：一次性； 1：周期； 2：立即执行； 10：按小时； 11：按天； 12：按周； 13：按月；
bkup_one_time	Number		（一次性任务）执行时间
cron_policies	String		周期性任务，cron表达式： 格式： 分 时 日 月 周 eg：0 0 * 1,3,5,8,9,10,11 0#1,1#3,3#4,4L 详细说明： 分钟：默认0分，取值范围[0-59]，单选； 小时：默认0时，取值范围[0-23]，允许多选； 日：默认1日，取值范围[1-31]，允许多选； 月：默认1月，取值范围[1-12]，允许多选； 周：默认周一，取值范围[0-6]，允许多选； 时间段设置：2-5； 指定多个时间点：1,3,4； 分段执行：*/3，表示值除3等于0时(即每3分，3小时，3日等)执行；
exclude_days	Array		周期性任务 - 排除日期	['2023-06-02']
effective_time_switch	Number		规则生效时间开关： 0：关； 1：开；
effective_time	Number		规则生效时间：unix时间戳
replica_uuids	Array		备份集复制规则uuid
thread_num_max	Number		高级设置（文件类型参数） - 并行任务数上限、 备份内容&参数 - 并行任务数上限（sqlserver） - 并行流数（GaussDWS）
thread_num_min	Number		高级设置（文件类型参数） - 并行任务数下限 或 备份内容&参数 - 参数（sqlserver） - 并行任务数下限
pre_backup_script	String		高级设置（文件 & Oracle） - 备份前置脚本
post_backup_script	String		高级设置（文件 & Oracle） - 备份后置脚本
script_timeout	Number		高级设置（文件 & Oracle） - 脚本执行超时时间（秒）
retry_time	Number		高级设置（文件 & Oracle） - 重试时间间隔，默认填入5，强制不为空	5
retry_num	Number		高级设置（文件 & Oracle） - 重试次数上限，默认填入5，强制不为空	5
expire_policy	Number		高级设置（文件类型参数） - 备份集过期删除策略： 0：检查 1：不检查，直接删除	0
compress_switch	Number		高级设置（文件 & Oracle） - 传输压缩开关： 0：关； 1：开； 【DM-备份内容-参数】备份数据压缩开关 0：关 1：开	0
compress	Number		高级设置（文件 & Oracle） - 传输压缩： 1：极速； 2：普通； 3：快速； 4：均衡； 【DM-备份内容-参数】备份数据压缩 0不压缩; 1-9为压缩等级 默认为0
encrypt_switch	Number		高级设置（文件 & Oracle） - 传输加密开关： 0：关； 1：开； 【DM-备份内容-参数】备份数据加密开关 0：关 1：开
encrypt	Number		高级设置（文件 & Oracle） - 传输加密： 1：AES； 2：SM4； 【DM-备份内容-参数】备份数据加密 0不加密；1简单加密；2完全加密
bk_file_crypt	Number		高级设置（文件 & Oracle） - 备端数据加密开关： 0：关； 1：开；
bk_crypt_type	Number		高级设置（文件 & Oracle） - 备端数据加密类型： 2：AES； 3：SM4； 4：RC5；
bk_crypt_key	String		高级设置（文件 & Oracle） - 备端数据加密秘钥
band_width	String		高级设置（文件 & Oracle） - 带宽设置
hcs_uuid	String		(Gauss(Hcs))备份内容，gaussDb
hcs_instance_uuid	String		(Gauss(Hcs))实例id
src_instance_uuid	String		备份内容&参数 - 备份内容 - 数据库源实例uuid （sqlserver、mysql、pgsql、dm）
auto_discover	Number		备份内容&参数 - 备份内容（sqlserver） - 自动发现数据库 0：否； 1：是；	0
db_names	Array		备份内容&参数 - 备份内容（sqlserver） - 数据库列表 当自动发现未开启时必传	['db_name1','db_name2']
log_truncate	Number		备份内容&参数 - 参数（sqlserver） - 日志截断开关 0：关； 1：开；
backup_method	Number		数据库备份类型： 0：物理备份； 1：逻辑备份； （mysql、GaussDWS、pgsql）	0
content_type	Number		数据库备份恢复粒度： 0：集群；【dm-整库】 1：实例；【dm-表空间】 2：整库； 3：模式；【dm-归档日志】 4：表； （mysql、GaussDWS、pgsql）
db_tables	Array		备份内容 - 表数组： 格式：库.模式(如果有).表 （mysql、GaussDWS）	["db_name.schema_name.table_name"]
db_schemas	Array		备份内容 - 模式数组 格式：库.模式 （GaussDWS）	["db_name.schema_name"]
fragment_switch	Number		分片开关，0：关，1：开
fragment_size	Number		分片大小
sto_uuid	String		对象存储UUID
bucket_uuid	String		对象存储桶UUID
encrypt_password	String		【DM-备份内容-参数】加密密钥
encrypt_algorithm	String		【DM-备份内容-参数】加密算法
thread_num	Number		【DM-备份内容-参数】备份线程数

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。

备份规则 - 修改

SDK方法名：modifyBackupRule;

URL

/backup_rule/:uuid([A-F0-9]+)

Method

PUT

Request

名称	类型	必选	简介	Mock初始值	Mock规则
task_name	String
biz_grp_list	Array
wk_data_type	Number			1
timeout	Number			1
priority	Number			1
unit_uuid	String
trans_mode	Number
disable	Number
tape_pool_uuid	String
client_list	Array
node_uuid	String
wk_path	Array
excl_path	Array
mirr_file_check	Number			1
mirr_sync_flag	String			1
mirr_open_type	Number			0
mirr_sync_attr	Number			1
ora_sid_name	String
ora_home_path	String
ora_content_type	Number			0
rman_compress_df	Number			0
rman_num_streams_df_max	Number			4
rman_num_streams_df_min	Number
rman_filespertset_df	Number			20
rman_arch_retain	Number			3
rman_include_arch_flag	Number			1
rman_db_readonly	Number			0
rman_del_arch	Number			1
rman_filespertset_arch	Number			20
rman_include_spfile_flag	Number			1
rman_num_streams_arch	Number			4
bkup_schedule	Array
sched_name	String
backup_type	Number			1
retention	Number			1
start_window	Array
wday	String
from	String
to	String
bkup_window	Array
wday	String
from	String
to	String
bkup_one_time	Number			1
bkup_policy	Number			1
cron_type	Number			1
exclude_days	Array			["2023-06-02"]
cron_policies	String
replica_uuid	String
thread_num_max	Number			1
pre_backup_script	String
post_backup_script	String
script_timeout	Number			1
expire_policy	Number			0
thread_num_min	String
compress	Number			1
compress_switch	Number			0
encrypt_switch	Number			1
encrypt	Number			1
secret_key	String
bk_file_crypt	Number			1
bk_crypt_type	Number			1
bk_crypt_key	String
ukey_crypt_switch	Number			1
ukey_cred_uuid	String
band_width	String
random_str	String

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。

备份规则 - 获取单个详情

SDK方法名：describeBackupRule;

URL

/backup_rule/:uuid([A-F0-9-]+)

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
message	String
backup_rule	Object
task_name	String
biz_grp_list	Array
wk_data_type	Number			1
timeout	Number			1
priority	Number			1
trans_mode	String
disable	Number
unit_uuid	String
tape_pool_uuid	String
client_list	Array
node_uuid	String
wk_path	Array
excl_path	Array
mirr_file_check	Number			1
mirr_sync_flag	String			1
mirr_open_type	Number			0
mirr_sync_attr	Number			1
ora_sid_name	String
ora_home_path	String
ora_content_type	Number			0
rman_compress_df	Number			0
rman_num_streams_df_max	Number			4
rman_filespertset_df	Number			20
rman_arch_retain	Number			3
rman_include_arch_flag	Number			1
rman_db_readonly	Number			0
rman_del_arch	Number			1
rman_filespertset_arch	Number			20
rman_include_spfile_flag	Number			1
rman_num_streams_arch	Number			4
bkup_schedule	Array
sched_name	String
backup_type	Number			1
retention	Number			1
start_window	Array
wday	Number			1
from	String
to	String
bkup_window	Array
wday	Number			1
from	String
to	String
bkup_one_time	Number			1
bkup_policy	Number			1
exclude_days	Array			["2023-06-02"]
cron_policies	String
replica_uuid	String
thread_num_max	Number			1
pre_backup_script	String
post_backup_script	String
script_timeout	Number			1
expire_policy	Number			0
thread_num_min	Number			1
compress	Number			1
compress_switch	Number			0
encrypt_switch	Number			1
encrypt	Number			1
secret_key	String
bk_file_crypt	Number			1
bk_crypt_type	Number			1
bk_crypt_key	String
band_width	String
ora_pdbs_name	Array
retry_time	Number			5
retry_num	Number			5
rman_num_streams_df_min	Number			4
code	Number			0

备份规则 - 获取列表

SDK方法名：listBackupRule;

URL

/backup_rule

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
page	Number		页数
limit	Number		条数
search_field	String		模糊查询字段	task_name
search_value	String		模糊查询值	test
order_by	String		排序方式	task_name
direction	String		顺序（此处初始值代表：搜索类似规则名：test规则的所有规则并且按照降序排）	DESC
like_args[task_name]	String		模糊搜索：名称
like_args[unit_name]	String		模糊搜索：名称：存储单元（组）
where_args[wk_data_type]	String		根据源类型过滤： 1：文件； 3：oracle； 21：Oracle rac 22 : GaussDB(HCS)
filter_by_biz_grp	Number		根据业务组过滤开关：1
where_args[task_uuid]	String		根据业务组过滤：业务组UUID
status	String		状态过滤： DISABLE：禁用； FINISH：完成； SCHEDULING：调度中； 总览跳转： DASH_DISABLE 禁用 DASH_ENABLE 启用
node_name	String		客户端过滤
hostname	String		主机名过滤
where_args[username]	String		所有者名称

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] success
info_list	Array
task_uuid	String		任务uuid	@uuid
task_name	String		规则名称	@first
wk_data_type	Number		源类型： 1：文件； 3：oracle；	@pick(1, 3)
unit_uuid	String		存储单元（组）uuid
unit_name	String		存储单元（组）name	unit-@first
user_uuid	String		所属用户uuid
user_name	String		所属用户名	user-@first
can_del	Number
can_up	Number
can_op	Number
is_biz_admin	Number
client_list	Array		客户端列表 - 同新建时下发的
node_uuiid	String
client_list_info	Array		客户端详情列表		2
node_uuid	String		节点uuid	@pick(D1DBbC39-8D72-E671-6F84-7ce7d51bB61e, f2C5B05E-f73c-83bE-4D66-7AB8D9ed7AA9)
node_name	String		节点名称	client-node-@first
hostname	String		节点主机名	host-@first
bkup_schedule	Array		备份计划列表
sched_name	String		备份计划名称
src_instance_uuid	String		数据库实例UUID
src_instance_name	String		数据库实例名称
total	Number			24

备份规则 - 删除

SDK方法名：deleteBackupRule;

URL

/backup_rule

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
task_uuids	Array		已选择的，规则uuid列表
client_list	Array		已选择的，客户端列表
task_uuid	String		任务uuid
node_uuid	Array		客户端节点uuid
force	Number		强制删除	0

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
ret	Number			200
data	Object
code	Number			11110001
message	String
fail_list	Array
code	Number			11110001
message	String			[-1] 找不到节点
task_uuid	String		规则uuid	@uuid
task_name	String		规则名称	@name
node_uuid	String
node_name	String
hostname	String
success_list	Array
code	Number			11110001
message	String			[0] success
task_uuid	String		规则uuid	@uuid
task_name	String		规则名称	@name
node_uuid	String
node_name	String
hostname	String

备份规则 - 操作

SDK方法名：operateBackupRule;

URL

/backup_rule/operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
operate	String		enable：启用； disable：禁用； manual_start：手动备份； clone：复制
task_uuids	Array		已选择的，规则uuid
client_list	Array		已选择的，客户端列表
task_uuid	String		规则uuid
node_uuid	String		客户端节点uuid
sched_name	String		计划名称（手动备份必传）
new_task_name	String		复制出的新规则名称

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
ret	Number			200
data	Object
code	Number			11110001
message	String
fail_list	Array
code	Number			11110001
message	String			[-1] 找不到节点
task_uuid	String			@uuid
task_name	String			@name
node_uuid	String
node_name	String
hostname	String
success_list	Array
code	Number			11110001
message	String			[0] success
task_uuid	String			@uuid
task_name	String			@name
node_uuid	String
node_name	String
hostname	String

备份规则 - 获取状态

SDK方法名：listBackupRuleStatus；

URL

/backup_rule/status

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
task_uuids	Array		规则uuid

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
ret	Number			200
data	Object
message	String
code	Number			0
status	Object
task_uuid-node_uuid	Object
status	String		DISABLE：禁用； FINISH：完成； UNKNOWN：未知； SCHEDULING：调度中；
last_result	Object
backup_type	String
result	String
end_time	String
last_success_result	Object
backup_type	String
result	String
end_time	String