应用保护

SDK类名：/timing/TimingBackup;

------ 备份 ------

URL

/dash/timing/backup

Method

GET

Request

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

Response

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

1-1 备份 准备-4 备份 获取MsSql数据源

SDK方法名：describeTimingBackupMssqlSource;

URL

/timing/backup/mssql_source

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
wk_uuid	String	否	工作机节点uuid	22D03E06-94D0-5E2C-336E-4BEEC2D28EC4

Response

名称	类型	必选	简介	Mock初始值	Mock规则
data	Object	否
data_source	String	否	@mock=sql	sql
code	Number	否	@mock=0	0
message	String	否	@mock=[0] success	[0] success
msg	String	否	@mock=
ret	Number	否	@mock=200	200

1-1 备份 准备-1 备份/恢复 认证Oracle信息（目前未使用）

SDK方法名：verifyTimingBackupOracleInfo

URL

/timing/backup/verify_oracle_info

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
oracle_settings	Object	否	oracle 设置（基本设置）
ora_sid_name	String	否	Oracle数据库实例名
ora_port	Number	否	【隐藏】Oracle监听端口	1
ora_home_path	String	否	Oracle数据库Home目录
ora_passwd	String	否	【隐藏】Oracle SYS用户密码	Info1234
wk_uuid	String	否	节点uuid	67E33CDB-D75B-15B3-367D-50C764F5A26F

Response

名称	类型	必选	简介	Mock初始值	Mock规则
data	Object	否
oracle_info	String	否	@mock=
code	Number	否	@mock=0	0
message	String	否	@mock=[0] success	[0] success
msg	String	否	@mock=
ret	Number	否	@mock=200	200

1-1 备份 准备-2 备份/恢复 获取Oracle表空间（目前未使用）

SDK方法名：describeTimingBackupOracleContent

URL

/timing/backup/oracle_content

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
oracle_settings	Object	否	oracle 设置（基本设置）
ora_passwd	String	否	【隐藏】Oracle SYS用户密码	Info1234
ora_port	Number	否	【隐藏】Oracle监听端口	1
ora_sid_name	String	否	Oracle数据库实例名
ora_content_type	Number	否	0：整库；1：表空间；2：数据文件；	0
wk_uuid	String	否	节点uuid	67E33CDB-D75B-15B3-367D-50C764F5A26F

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否	@mock=200	200
data	Object	否
code	Number	否	@mock=0	0
message	String	否	@mock=[0] success	[0] success
oracle_content	Array	否	@mock=
msg	String	否	@mock=

1-1 备份 准备-3 备份 获取Oracle脚本路径

SDK方法名：descibeTimingBackupOracleSriptPath

URL

/timing/backup/oracle_script_path

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
wk_uuid	String	否	工作机节点uuid	67E33CDB-D75B-15B3-367D-50C764F5A26F

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否	@mock=200	200
msg	String	否	@mock=
data	Object	否
code	Number	否	@mock=0	0
message	String	否	@mock=[0] success	[0] success
script_path	String	否	@mock=

1-1 备份 准备-5 备份 获取MsSql数据库列表

SDK方法名：listTimingBackupMssqlDbList

URL

/timing/backup/mssql_db_list

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
wk_uuid	String	否	工作机节点uuid	67E33CDB-D75B-15B3-367D-50C764F5A26F
mssql_settings	Object	否
win_verify	Number	否	登录SQL Server服务器的信息：0：用mssql用户名密码；1：用winNT集成设置；	0
instance_name	String	否	sql server 实例名，默认是MSSQLSERVER	MSSQLSERVER
user_id	String	否	sql server 用户名，用winNT集成设置不填	sa
pass_word	String	否	sql server 密码，用winNT集成设置不填	123456
data_source	String	否	[BK] 数据源名称	WIN-EGKN86NF3PM
port	String		当网络协议类型为TCP/IP时，默认值1433
protocol	Number		0:shared memory，1:TCP/IP，默认值 0

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否	@mock=200	200
data	Object	否
code	Number	否	@mock=0	0
message	String	否	@mock=[0] success	[0] success
mssql_db_list	Array	否	@mock=$order('master','tempdb','model','msdb','ReportServer','ReportServerTempDB','test')	['master','tempdb','model','msdb','ReportServer','ReportServerTempDB','test']	+1
msg	String	否	@mock=

备份 准备 验证oracle登录认证

SDK方法名：verifyTimingBackupOracleLogin;

URL

/timing/backup/oracle_login

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
wk_uuid	String	否
oracle_settings	Object	否
ora_sid_name	String	否	oracle的sid
ora_login_name	String	否	oracle的用户名
ora_login_pwd	String	否	oracle的密码
ora_server_name	String		oracle的实例名
ora_server_port	String		oracle的服务端口

Response

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

1-2 备份 新建/编辑-1 备份 新建

SDK方法名：createTimingBackup

URL

/timing/backup

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
timing_backup	Object	否
mirr_sync_attr	Number	否	文件安全属性，0：不同步；1：同步；	1
mirr_file_check	Number		校验方式, 0: 严格校验， 1: 时间校验	0
oracle_settings	Object	否	oracle 设置（基本设置）
ora_sid_name	String	否	Oracle数据库实例名
ora_content_type	Number	否	备份内容：0：整库；1：表空间；2：数据文件；3：PDBS；4：CDB；5：ARCHIVELOG；6：CONTROLFILE；7：SPFILE；8：TABLE；	0
ora_pdbs_name	String	否	PDB，ora_content_type 为 PDBS 时必传，内容为逗号分隔的PDB名称
ora_use_script	Number	否	[BK] 使用脚本	0
ora_port	Number	否	【隐藏】Oracle监听端口	1
ora_script_path	String	否	[BK] 脚本路径
ora_passwd	String	否	【隐藏】Oracle SYS用户密码	Info1234
ora_home_path	String	否	Oracle数据库Home目录
ora_login_name	String	否
ora_login_pwd	String	否
ora_server_name	String
ora_server_port	String
pool_uuid	String		存储池uuid
pool_name	String		存储池名称
volume_uuid	String		复制卷uuid
volume_name	String		复制卷名称
attach_point	String		挂载点
ora_tab_mode	Number		数据库模式： 0：non-CDB； 1：CDBRoot； 2：PDBs；
ora_tab_pdb_name	String		PDBs模式后，输入PDB的名称
ora_tab_names	Array
user	String		用户名
ori_table	String		原表名
tgt_table	String		目标表名
ora_tab_aux_path	String		辅助实例存放路径
ora_tab_rctype	Number		恢复表指定备份 0：日期； 1：SCN； 2：日志序列号；
ora_tab_time	String		时间
ora_tab_scn	String		SCN
ora_tab_log	String		日志序列号
log_ccopy	Number		日志持续复制开关： 0：关； 1：开；
log_volume_uuid	String		日志卷uuid
log_mount_point	String		日志卷挂载点
wk_data_type	Number	否	源类型： 0：块设备； 1：文件； 3：oracle； 4：mssql； 9：MySQL； 12：高斯db； 13：informix; 14：达梦数据库; 15：GaussDB100T; 16：复制卷; 17：DWS； 18：GoldenDB； 21：KingbaseES； 30：AIX；	1
task_name	String	否	任务名	testTiming
backup_type	Number	否	备份策略里非全备的备份类型，0：全备（没策略或策略只有全备）；1：增量（策略中存在增量）；2：差异（策略中存在）；	0
del_policy	Number	否	删除策略，0：不开启；1：开启；	0
mirr_sync_flag	Number	否	错误处理方式，0：出错停止；1：出错继续；	0
snap_type	Number	否	源端快照类型，0：none，1：vss	0
oracle_rman_settings	Object	否	oracle rman 设置（备份选项）
rman_skip_offline	Number	否	表空间选项，跳过脱机数据文件	0
rman_num_streams_arch	Number	否	归档选项，并行流数	20
rman_del_arch	Number	否	归档选项，备份后删除	1
rman_arch_retain	Number		归档选项，保留天数	3
rman_include_arch_flag	Number	否	归档选项，将归档重做日志包括在全备的和增量的备份计划中	1
rman_num_streams_df	Number	否	表空间选项，并行流数	1
rman_filespertset_arch	Number	否	归档选项，每个备份集文件数	20
rman_maxsetsize_df	Number	否	表空间选项，备份集大小(KB)	0
rman_set_limit_arch_flag	Number	否	归档选项，指定最高限额	0
rman_skip_readonly	Number	否	表空间选项，跳过脱机数据文件	0
rman_maxsetsize_arch	Number	否	归档选项，备份集大小(KB)	0
rman_cold_bkup	Number	否	表空间选项，离线(冷)数据库备份	0
rman_filespertset_df	Number	否	表空间选项，每个备份集文件数	20
rman_db_readonly	Number	否	源端数据库只读	0
rman_compress_df	Number	否	表空间选项，压缩，开启传1，关闭传0
rman_include_spfile_flag	Number	否	参数文件选项，将参数文件包括在全备的和增量的备份计划中，开启传1，关闭传0
wk_path	Array	否	工作路径	["E:\test\"]
excl_path	Array	否	源机排除目录	[]
bk_data_type	Number	否	目标类型， 1：文件； 2：raw数据； 10：备份快照; 11: 合成备份 ;	1
compress	Number	否	压缩，0关；1：低；2：中；3：高；	0
encrypt_switch	Number	否	是否加密，0：不开启；1：开启；	0
encrypt	Number		加密类型 1：aes， 2：sm4	1
secret_key	String	否	密钥
bk_path	Array	否	备份路径	["E:\t\"]
blk_direct_copy	Number	否	块设备，1：直接拷贝；	0
mirr_open_type	Number	否	文件打开方式，0：普通文件；1：自动选择；2：MFT；	0
mssql_settings	Object	否	mssql 设置（基本设置）
win_verify	Number	否	登录SQL Server服务器的信息：0：用mssql用户名密码；1：用winNT集成设置；	1
data_source	String	否	[BK] 数据源名称
instance_name	String	否	sql server 实例名，默认是MSSQLSERVER	MSSQLSERVER
protocol	Number		0:shared memory，1:TCP/IP，默认值 0
port	String		当网络协议类型为TCP/IP时，默认值1433
user_id	String	否	sql server 用户名，用winNT集成设置不填
pass_word	String	否	sql server 密码，用winNT集成设置不填
time_out	String	否	连接超时设定(秒):
db_info	Array		库信息，同时用来存放子任务信息	[]
db_name	String		[BK] 备份数据库名称
check_out	Number		开启校验功能：0关1开 （目标类型为文件）	1
lanfree	Number		是否开启lanfree：（目标类型为合成备份） 0：否； 1：是；
volume_uuid	String		复制卷uuid（目标类型为合成备份）
mount_point	String		挂载点（目标类型为合成备份）
wk_uuid	String	否	@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机节点uuid	67E33CDB-D75B-15B3-367D-50C764F5A26F
bk_uuid	String	否	@mock=@pick(["kevin", "Jane", "Grey"]), 备机节点uuid	B8566905-411E-B2CD-A742-77B1346D8E84
bkup_policy	Number	否	备份策略，2 立即，0 定时，1 循环；	2
bkup_window	Object	否	运行时间范围
sched_time_start	String	否	运行时间范围 开始	00:00
sched_time_end	String	否	运行时间范围 结束	00:00
bkup_one_time	Number	否	定时任务，执行时间（备份策略）	1547538235
bkup_schedule	Array	否	周期任务（备份策略）
limit	Number	否	数据保留期限（天）	@integer(1, 64)
sched_day	Array	否	哪几天	"@integer(1, 31)"
sched_every	Number	否	0：每天；1：每周：2：每月；3：每隔	2
sched_time	Array	否	哪几点	@time('HH:mm')
sched_gap_min	Number	否	间隔分钟数	@integer(1, 64)
backup_type	Number	否	备份类型： 0：全量备份/数据备份/合成备份/表备份/归档备份； 1：增量备份/日志备份/累计增量/日志增量； 2：差异备份/差异增量； 8：日志备份；（Oracle整库，用来区分 累计增量）
task_type	Number	否	任务类型：备份任务：0；还原任务：1；备份任务模板：10；	0
file_check_dir	String	否	校验目录
random_str	String	否	新建不传	11111111-1111-1111-1111-111111111111
file_check_switch	Number	否	文件校验开关，0关1开；	0
mirr_blk_size	Number	否	块大小	0
timing_type	Number		定时任务类型： 0 - 普通定时任务; 1 - 集群定时任务(RAC); 2 - 集群定时任务(GAUSS); 3 - 集群定时任务(英方服务集群);
data_ip_uuid	String		灾备机数据地址	B8566905-411E-B2CD-A742-77B1346D8E84
bk_file_crypt	Number		备端数据加密，1是，0否；默认为0	0
bk_crypt_type	Number		备端数据加密类型： 1：Byte Invert 字节翻转加密（默认）； 2：aes； 3：sm4； 4：RC5；	1
bk_crypt_key	String		备端数据加密，密钥	''
ukey_crypt_switch	Number		是否启用ukey加密 0-不启用 1-启用
ukey_cred_uuid	String		ukey凭据
mysql_settings	Object		mysql基本设置
pool_uuid	String		存储池uuid
pool_name	String		存储池名称
volume_uuid	String		复制卷uuid
volume_name	String		复制卷名称
attach_point	String		挂载点
mysql_host	String		数据库IP	127.0.0.1
mysql_port	String		端口
mysql_user	String		用户名
mysql_passwd	String		密码
time_out	Number		超时时间
mysql_path	String		MySQL执行目录
log_ccopy	Number		日志持续复制开关
log_volume_uuid	String		日志卷
log_volume_name	String
log_mount_point	String		日志卷在工作机的挂载点
data_dir	String		数据目录
config_path	String		配置文件路径	/etc/my.cnf
lanfree	Number		Lanfree开关： 0 ：不勾选，表示 lan_free模式 1：勾选，表示lan_base模式	1
backup_mode	Number		mysql备份方式： 0：物理备份； 1：逻辑备份；	0
tables	Array		表备份数组，格式：db.table
archive_pen	Number		是否开启备份归档：0否了是	0
retry_time	Number		重试时间间隔，默认填入5，强制不为空	5
retry_num	Number		重试次数上限，默认填入5，强制不为空	5
tape_uuid	String		磁带库uuid	E8566905-411E-B2CD-A742-77B1346D8E84
tape_pool_uuid	String		磁带池uuid
tape_pool_name	String		磁带池名称
tape_name	String		磁带名
tape_reserve	Number		磁带保留： 0：按备份周期保留； 1：永久保留；
library_sn	String		磁带序列号	SYZZY_A
db_name	String		备份数据库名称(gauss集群)
content_type	Number		备份内容类型(gauss集群): 0：集群备份； 1：整库； 2：表；
tables	String		数据表名称，多个表之间用空格隔开(gauss集群)
informix_settings	Object		informix 基本设置
oper_user	String		操作用户，默认为informix
is_ori_machine	Number		【RC】【弃用】是否恢复到原机: 1-是 0-否
config_recover	Number		【RC】恢复关键文件 1：还原，0不还原 默认为0
verify_only	Number		【RC】仅验证，0是需要还原数据，1是仅验证
informix_instance	Object
is_default	Number		默认实例，1是默认，0是非默认
install_dir	String		安装目录路径
instance_name	String		实例名
onconfig_name	String		配置文件名
thread_num	Number		并行任务数	0
dm_settings	Object		达梦数据库选项
dm_home	String		HOME 目录
system_user	String		系统用户名(非“表”备份时必传)
host	String		主机名
port	String		端口
user	String		用户名
password	String		密码
content_type	Number		备份内容： 0：整库； 1：表空间； 2：表； 3：归档日志；
is_bk_arch	Number		将归档日志包括在全备的和增量的备份计划中： 0：关； 1：开
is_del_arch	Number		备份后删除归档： 0：关； 1：开；
specify_time	String		是否从指定时间点开始备份归档： 0：关； 1：开；
time_type	Number		指定时间类型： 0：日期； 1：LSN；
since_time	String		归档日期
since_lsn	String		归档lsn
table_space	String		表空间名
schema_name	String		模式名
table_name	String		表名
compress_switch	Number		压缩开关：0，1	0
compress	Number		压缩等级： 0~9， 默认0	0
encrypt_switch	Number		加密开关:0,1	0
encrypt_type	Number		加密类型： 1：简单加密； 2：完全加密;	1
encrypt_password	String		加密密码
encrypt_algorithm	String		加密算法
thread_num	Number		线程数 1-64	4
parallel_switch	Number		是否开启并行： 0，1	0
parallel_num	Number		并行数 1-128； 并行数与线程数乘积不大于512；	4
block_size	Number		备份块大小： 默认为1G，最小为512M；
block_unit	String		备份块单位： GB, MB
timeout	String		超时时间，超过这个时间还没备完则产生告警， 默认0， 大小0 - 168之间
db2_settings	Object		db2 基本设置
db2_user	String		db2用户，db2时必传
db2_group	String		db2组，db2时必传
db_info	Array
db_name	String		备份数据库名称
synthetic_bkup_settings	Object		合成备份 基本设置
pool_uuid	String		存储池UUID
pool_name	String		存储池名称
volume_uuid	String		复制卷uuid
volume_name	String		复制卷名称
lanfree	String		开启LAN-FREE开关
pre_backup_script	String		备份前源端脚本路径
post_backup_script	String		备份完成后置脚本路径
script_timeout	Number		脚本执行超时时间（秒），默认30s
obs_settings	Object		对象存储 基本设置
sto_uuid	String		对象存储uuid
bucket_name	String		对象桶名称
bucket_path	String		对象桶路径
bk_storage	Number		备份存储类型： 0：文件系统； 1：对象存储； 2：磁带库； 3：重删池； 3：移动云备份 - 磁盘存储池；
inc_type	Number		文件到文件，周期性规则： 0：以块为单位（默认） 1：以文件为单位
gsdbt_settings	Object		GaussDB100T设置字段
gsdbt_home	String		数据库安装目录；
oper_user	String		操作用户名，默认值 omm
user	String		数据库登录用户名，默认值 SYS
password	String		数据库密码
port	String		端口号；默认值 1888
dedupe_uuid	String		重删池uuid（文件备份，备份存储选择重删池）
storage_pool_uuid	String		磁盘存储池uuid，备份存储池选择磁盘存储
goldendb_settings	Object		GoldenDB选项
manager_user_name	String		管理用户名
manager_user_home_dir	String		管理用户家目录
tenant_name	String		租户名
db_user_name	String		租户数据库名
db_user_passwd	String		租户数据库用户密码（RSA加密）
custom_type	Number		自定义类型，GASS参数
kingbasees_settings	Object
kes_bin	String		KES二进制文件目录
kes_data	String		数据库data目录
oper_user	String		操作用户，默认kingbase
user	String		用户名，默认SYSTEM
password	String		密码（RSA）加密
port	String		端口，默认：54321	54321
proxy_uuid	String		代理

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String	否	@mock=
ret	Number	否	@mock=200	200
data	Object	否
code	Number	否	@mock=0	0
message	String	否	@mock=[0] success	[0] success
success_list	Array
db_name	String
fail_list	Array		失败的列表
db_name	String
message	String

1-2 备份 新建/编辑-2 备份 获取单个

SDK方法名：describeTimingBackup

URL

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

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String	否
data	Object	否
timing_backup	Object	否
mirr_sync_attr	Number	否		1
secret_key	String	否
oracle_settings	Object	否
ora_sid_name	String	否		orcl
ora_content_type	Number	否		0
ora_use_script	Number	否		0
ora_port	Number	否		1
ora_script_path	String	否
ora_passwd	String	否		Info1234
ora_home_path	String	否		/test
attach_point	String			/data
pool_name	String			Richard Hall
pool_uuid	String			5C9D7fB7-91AB-cB5D-d267-C5EE4593cfcc
volume_name	String			copy-volume1
volume_uuid	String			E95CB20B-917C-57F4-F926-751ECE95F869
log_ccopy	String
log_volume_uuid	String
log_mount_point	String
policy_uuid	String	否		38FFA6E2-2A40-31D6-7A94-E8168EBA9FF1
wk_data_type	Number	否		1
task_name	String	否		@name
backup_type	Number	否		1
del_policy	Number	否		0
mirr_sync_flag	Number	否		0
snap_type	Number	否		0
oracle_rman_settings	Object	否
rman_skip_offline	Number	否		0
rman_num_streams_arch	Number	否		1
rman_del_arch	Number	否		1
rman_arch_retain	Number			3
rman_include_arch_flag	Number	否		1
rman_num_streams_df	Number	否		1
rman_filespertset_arch	Number	否		20
rman_maxsetsize_df	Number	否		0
rman_set_limit_arch_flag	Number	否		0
rman_skip_readonly	Number	否		0
rman_maxsetsize_arch	Number	否		0
rman_cold_bkup	Number	否		0
rman_filespertset_df	Number	否		20
compress	Number	否		0
encrypt_switch	Number	否		0
wk_path	Array	否
excl_path	Array	否
bk_data_type	Number	否		11
mirr_blk_size	Number	否		0
bk_path	Array	否		['/test1','/test2']
blk_direct_copy	Number	否		0
mirr_open_type	Number	否		0
mssql_settings	Object	否
instance_name	String	否
time_out	String	否		2
data_source	String	否
dbsize	String	否
win_verify	Number	否		0
user_id	String	否
db_info	Array	否
db_name	String
pass_word	String	否
wk_uuid	String	否		0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
bk_uuid	String	否		Grey
bkup_policy	Number	否		0
bkup_window	Object	否
sched_time_start	String	否		18:47
sched_time_end	String	否		21:05
bkup_one_time	Number	否		1515568566
bkup_schedule	Array	否
limit	Number	否		50
sched_day	Number	否		24
sched_every	Number	否		2
sched_time	String	否		17:16
sched_gap_min	Number	否		41
task_type	Number	否	任务类型：备份任务：0；还原任务：1；备份任务模板：10；	0
data_ip_uuid	String		灾备机数据地址	0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
band_width	String			000:00-23:592k,100:00-23:594k
task_uuid	String			@uuid
db2_settings	Object
db2_user	String
db2_group	String
db_info	Array
task_name	String
task_uuid	String
db_name	String
synthetic_bkup_settings	Object
pool_uuid	String			FEaF20d4-FAf6-c4e3-F2dB-55D8dC44E10e
pool_name	String			Gary Hernandez
volume_uuid	String			FEaF20d4-FAf6-c4e3-F2dB-55D8dC44E10e
volume_name	String			copy-volume1
attach_point	String			/data
lanfree	Number			1
message	String	否		[0] success
code	Number	否		0
ret	Number	否		200

1-2 备份 新建/编辑-3 备份 修改

SDK方法名：modifyTimingBackup

URL

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

Method

PUT

Request

名称	类型	必选	简介	Mock初始值	Mock规则
timing_backup	Object	否
mirr_sync_attr	Number	否		1
secret_key	String	否
oracle_settings	Object	否
ora_sid_name	String	否
ora_content_type	Number	否		0
ora_use_script	Number	否		0
ora_port	Number	否		1
ora_script_path	String	否
ora_passwd	String	否		Info1234
ora_home_path	String	否
policy_uuid	String	否		38FFA6E2-2A40-31D6-7A94-E8168EBA9FF1
wk_data_type	Number	否		0
task_name	String	否
backup_type	Number	否		1
del_policy	Number	否		0
mirr_sync_flag	Number	否		0
snap_type	Number	否		0
oracle_rman_settings	Object	否
rman_skip_offline	Number	否		0
rman_num_streams_arch	Number	否		1
rman_del_arch	Number	否		1
rman_include_arch_flag	Number	否		1
rman_num_streams_df	Number	否		1
rman_filespertset_arch	Number	否		20
rman_maxsetsize_df	Number	否		0
rman_set_limit_arch_flag	Number	否		0
rman_skip_readonly	Number	否		0
rman_maxsetsize_arch	Number	否		0
rman_cold_bkup	Number	否		0
rman_filespertset_df	Number	否		20
compress	Number	否		0
encrypt_switch	Number	否		0
wk_path	Array	否
excl_path	Array	否
bk_data_type	Number	否		1
mirr_blk_size	Number	否		0
bk_path	Array	否
blk_direct_copy	Number	否		0
mirr_open_type	Number	否		0
mssql_settings	Object	否
instance_name	String	否
time_out	String	否		2
data_source	String	否
dbsize	String	否
win_verify	Number	否		0
user_id	String	否
db_info	Array	否
db_name	String
pass_word	String	否
wk_uuid	String	否		0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
bk_uuid	String	否		Jane
bkup_policy	Number	否		0
bkup_window	Object	否
sched_time_start	String	否		15:18
sched_time_end	String	否		14:37
bkup_one_time	Number	否		1515568566
bkup_schedule	Array	否
limit	Number	否		25
sched_day	Number	否		24
sched_every	Number	否		2
sched_time	String	否		04:07
sched_gap_min	Number	否		49
task_type	Number	否	任务类型：备份任务：0；还原任务：1；备份任务模板：10；	0
random_str	String	否	新建不传	11111111-1111-1111-1111-111111111111
data_ip_uuid	String		灾备机数据地址	0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
db2_settings	Object
db2_user	String
db2_group	String
db_info	Array
task_uuid	String
task_name	String
db_name	String
bk_storage	String		备份存储类型： 0：文件系统； 1：对象存储； 2：磁带库； 3：重删池；
dedupe_uuid	String		重删池uuid

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String	否	@mock=
ret	Number	否	@mock=200	200
data	Object	否
message	String	否	@mock=[0] success	[0] success
code	Number	否	@mock=0	0
success_list	Array
db_name	String
fail_list	Array
db_name	String
code	String
message	String

1-3 备份 列表-1 备份 获取列表

SDK方法名：listTimingBackup; 获取列表详细入参说明详见【节点管理-获取节点列表】接口说明；

URL

/timing/backup

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
search_field	String	否	【可选】搜索字段
search_value	String	否	【可选】搜索字段对应值（支持模糊查询）
limit	Number	否	【可选】分页条数，不传就是全部	10
page	Number	否	【可选】分页数，不传就是全部	1
type	Number	否	任务类型： 备份任务：0； 备份任务模板：10；	0
where_args[timing_type]	Number	否	普通：0； 生产集群：1、2； 灾备服务集群：3；
status	String		【可选】总览页面跳转时按照状态过滤时需要： REPLICATION：复制； MAINTAIN：维护； WAIT：等待； FINISH：完成； STOP：停止； UNKNOWN：未知；

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String	否
data	Object	否
info_list	Array	否
task_name	String	否	规则名称
task_uuid	String		规则uuid	38FFA6E2-2A40-31D6-7A94-E8168EBA9FF2
task_type	Number	否	规则类型： 0：备份； 10：备份模板；	0
wk_data_type	Number	否	源类型： 0：块设备； 1：文件； 3：oracle； 4：SQL server； 5：云备份； 6：DB2； 7：容灾平台； 8：VMware； 9：mysql； 12：gaussDB； 13：informix； 14：DB； 15：gaussDB 100T； 17：高斯集群备份； 20：goldenDB；	9
bk_data_type	Number	否	目标类型： 1：文件； 2：raw； 10：备份快照； 11：合成备份；	1
wk_uuid	String	否	工作机uuid	0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
wk_ip	String		工作机数据地址
wk_node_name	String		工作机名称
bk_uuid	String	否	灾备机uuid	Grey
bk_ip	String		灾备机数据地址
bk_node_name	String		灾备机名称
bkup_policy	Number	否	策略类型： 0:一次性； 1：周期； 2：立即执行；	0
bkup_schedule	Array	否	备份策略
limit	Number	否	数据保留期限（天）	50
sched_every	Number	否	周期策略： 0：每天； 1：每周： 2：每月； 3：每隔	2
sched_day	Number	否	哪几天	24
sched_time	String	否	哪几点	17:16
sched_gap_min	Number	否	间隔分钟数	41
can_op	Number		是否可操作： 0：否； 1：是；	1
can_up	Number		是否可更新： 0：否； 1：是；	1
can_del	Number		是否可删除： 0：否； 1：是；	1
last_result	Object		上次执行结果
backup_type	String		备份类型： o：全量； i：增量； d：差异；	o
end_time	String		结束时间	2020-09-14 19:00:00
result	Number		结果： 0：成功； 小于0：失败；	0
last_success_result	Object		上次成功执行结果
backup_type	String		备份类型： o：全量； i：增量； d：差异；	o
end_time	String		结束时间	2020-09-14 19:00:00
result	Number		结果： 0：成功； 小于0：失败；
archive_pen	Number		是否开启磁带库归档： 0：否； 1：是；
tape_uuid	String		带库uuid
library_sn	String		带库序列号
tape_node_uuid	String		磁带库关联节点uuid
tape_pool_uuid	String		磁带池uuid
is_group	Number		多库备份 - 是否组规则： 0：否； 1：是；	0
group_uuid	String		多库备份 - 组uuid
bk_storage	Number		备份存储类型： 0：文件系统； 1：对象存储； 2：磁带库； 3：重删池； 3：移动云备份 - 磁盘存储池；
oracle_settings	Object	否	ORACLE配置信息
ora_sid_name	String	否	Oracle数据库实例名
ora_content_type	Number	否	备份内容： 0：整库； 1：表空间； 2：数据文件； 3：PDBS； 4：CDB； 5：ARCHIVELOG； 6：CONTROLFILE； 7：SPFILE； 8：TABLE；	0
ora_use_script	Number	否	[BK] 使用脚本	0
ora_port	Number	否	【隐藏】Oracle监听端口	1
ora_script_path	String	否	[BK] 脚本路径
ora_passwd	String	否	【隐藏】Oracle SYS用户密码	Info1234
ora_home_path	String	否	Oracle数据库Home目录
oracle_rman_settings	Object	否	ORACLE RMAN配置信息
rman_skip_offline	Number	否	表空间选项，跳过脱机数据文件	0
rman_num_streams_arch	Number	否	归档选项，并行流数	1
rman_del_arch	Number	否	归档选项，备份后删除	1
rman_include_arch_flag	Number	否	归档选项，将归档重做日志包括在全备的和增量的备份计划中	1
rman_num_streams_df	Number	否	表空间选项，并行流数	1
rman_filespertset_arch	Number	否	归档选项，每个备份集文件数	20
rman_maxsetsize_df	Number	否	表空间选项，备份集大小(KB)	0
rman_set_limit_arch_flag	Number	否	归档选项，指定最高限额	0
rman_skip_readonly	Number	否	表空间选项，跳过脱机数据文件	0
rman_maxsetsize_arch	Number	否	归档选项，备份集大小(KB)	0
rman_cold_bkup	Number	否	表空间选项，离线(冷)数据库备份	0
rman_filespertset_df	Number	否	表空间选项，每个备份集文件数	20
mssql_settings	Object	否	MSSQL配置信息
instance_name	String	否	sql server 实例名，默认是MSSQLSERVER
time_out	String	否	连接超时设定(秒):	2
data_source	String	否	[BK] 数据源名称
win_verify	Number	否	登录SQL Server服务器的信息：0：用mssql用户名密码；1：用winNT集成设置；	0
protocol	String		0:shared memory，1:TCP/IP，默认值 0
port	String		当网络协议类型为TCP/IP时，默认值1433
user_id	String	否	sql server 用户名，用winNT集成设置不填
pass_word	String	否	sql server 密码，用winNT集成设置不填
db_info	Array	否	库信息，同时用来存放子任务信息
task_uuid	String		子规则uuid
db_name	String		[BK] 备份数据库名称
children	Array		子任务列表
has_remote_rep	Number		是否存在远程复制规则： 0：否； 1：是；
total	Number		总数量
message	String	否		[0] success
code	Number	否		0
ret	Number	否		200

1-3 备份 列表-2 备份 状态

SDK方法名：listTimingBackupStatus

URL

/timing/backup/status

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
task_uuids	Array	否	必传，uuid数组，页面加载第一次获取状态一个一个获取，之后是批量获取； (不论组还是子，都传task_uuid)	["11111111-1111-1111-1111-111111111111"]
force_refresh	Number		点击操作栏刷新按钮必传，下发1，表示从rpc获取；其他情况不传

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number		@mock=	200
msg	String
data	Object
code	Number		@mock=0	0
message	String			[0] 操作成功。
status	Object
D81A10A3-3F59-4E90-B6CB-8A7579C221A8-B457B215-3886-46D9-8AF2-2A4D894340D9	Object		规则UUID-节点UUID
status	String		状态文字： UNKNOWN：未知； FINISH：完成； STOP：停止； PENDING：等待； MIRROR：镜像； CALC：计算； PREPARING：准备；	DISABLE
last_result	Object		上次执行信息
backup_type	Number		备份类型： o：全量； i：增量； d：差异；	0
end_time	Null		结束时间
result	Number		执行结果： 0：成功； 小于0：失败；	0
last_success_result	Object		上次成功执行信息
backup_type	Number		备份类型： o：全量； i：增量； d：差异；	0
end_time	String		结束时间	2023-10-13 10:52:56
result	Number		执行结果： 0：成功； 小于0：失败；	0

1-3 备份 列表-3 备份 删除

SDK方法名：deleteTimingBackup

URL

/timing/backup

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
task_uuids	Array	否	*规则数组	["11111111-1111-1111-1111-111111111111"]
del_policy	Number	否	*删除策略，0：不开启；1：开启；
force	Number		1 - 强制删除 0 - 非强制删除
recycle	Number		是否添加到数据清理： 0：否； 1：是；	0

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
data	Object
code	Number			11110001
message	String
fail_list	Array
code	Number			11110001
message	String			[-1] 离线
task_uuid	String			@guid
task_name	String			test2
success_list	Array
code	Number			11110001
message	String			[0] success
task_uuid	String			@guid
task_name	String			test1
ret	Number			200

1-3 备份 列表-4 备份 操作

SDK方法名：

启动：startTimingBackup;

停止：stopTimingBackup;

立即执行：startImmediateTimingBackup;

URL

/timing/backup/operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
operate	String	否	start：启动； stop：停止； start_immediately：立即执行； pause：暂停； proceed：继续； clone：克隆	start
task_uuids	Array	否	必传，规则数组	["11111111-1111-1111-1111-111111111111"]
bk_type	Number	否	立即执行操作（start_immediately）必传，取值为，备份策略 - 周期任务 - 备份方式；0：全备，1：增量，2：差异
new_task_name	String		【可选】克隆必传，新规则名称

Response

名称	类型	必选	简介	Mock初始值	Mock规则
data	Object	否
code	Number	否	@mock=0	0
message	String	否	@mock=[0] success	[0] success
success_list	Array
fail_list	Array
task_uuid	String
code	String
message	String
task_name	String
msg	String	否	@mock=
ret	Number	否	@mock=200	200

备份 列表 - 查看更多

SDK方法名：showTimingBackupDetailInfo;

URL

/timing/backup/detail

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
task_uuid	String		规则uuid
timing_type	Number		目前只能为3，表示英方服务集群	3

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
message	String
detail	Object
cls_name	String		服务集群名称	svc01
node_name	String		规则被分配到此节点运行	i2node01
task_name	String		规则名称	bk01
code	Number			0

1-4 备份 获取达梦数据库信息

SDK方法名：descibeDmDbInfo

URL

/timing/backup/dm_db_info

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
node_uuid	String		节点uuid
dm_home	String		dm home目录
host	String		主机
port	String		端口
user	String		用户名
password	String		密码
type	Number		查询类型： 0：表空间； 1：模式； 2：表；
schema_name	String		模式名，查询表时下发

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
ret	Number			200
data	Object
code	Number			0
message	String			[0] success
list	Array		索要查询的内容数组

1-5 备份 获取GaussDB库/表

SDK方法名：listGaussDBDatabaseTables;

URL

/timing/backup/list_gaussdb_database_tables

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
node_uuid	String		集群uuid
content_type	Number		1：只获取数据库 2：获取数据库和表
page_no	String		分页数
page_size	String	是	分页条数
top_dir	String		/ 或 /database

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			success
list	Array		当前层级列表
name	String		名称
type	String		如果是Folder，表示可以展开
total	String
page_no	String
page_count	String
page_size	String

------ 还原 ------

URL

/dash/timing/recovery

Method

GET

Request

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

Response

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

2-1 恢复 准备-2 恢复 获取还原时间点 - Mssql

SDK类名：/timing/TimingRecovery;

SDK方法名：listTimingRecoveryMssqlTime

URL

/timing/recovery/rc_mssql_time

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
bk_uuid	String	否	, 备机节点uuid	B8566905-411E-B2CD-A742-77B1346D8E84
rc_data_path	String	否	, 备份数据路径	E:\mssqlBK\ts-11111111-1111-1111-1111-111111111111\
bk_storage	Number
obs_settings	Object
tape_pool_uuid	String		磁带池uuid
tape_name	String		磁带名
library_sn	String		序列号

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String	否	@mock=
ret	Number	否	@mock=200	200
data	Object	否
mssql_time_list	Array	否
code	Number	否	@mock=0	0
message	String	否	@mock=[0] success	[0] success

2-1 恢复 准备-3 恢复 获取Mssql初始信息

SDK方法名：describeTimingRecoveryMssqlInitInfo

URL

/timing/recovery/rc_mssql_init_info

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
bk_uuid	String	否	备机节点uuid	B8566905-411E-B2CD-A742-77B1346D8E84
rc_point_in_time	String	否	还原时间点 rawfile	2017-12-21_13-16-53
rc_data_path	String	否	备份数据路径

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
data	Object	否
message	String	否		[0] success
mssql_init_info	Object	否
src_db_name	String	否	[RC] 原数据库名称	141414
db_size	String	否	[RC] 数据库大小	12
user_id	String	否
instance_name	String	否
win_verify	String	否
tab_num	String	否
tab_info	String	否
ln_num	String	否
check_out	String	否
lgc_name	String	否	[RC] 原数据库逻辑名（多行以*隔开，与lgc_path一一对应）	test*test_log
lgc_path	String	否	[RC] 原数据库文件路径（多行以*隔开，与lgc_name一一对应）	C:\Program Files\Microsoft SQL Server\MSSQL12.MSSQLSERVER\MSSQL\DATA\test.mdf*C:\Program Files\Microsoft SQL Server\MSSQL12.MSSQLSERVER\MSSQL\DATA\test_log.ldf
lgc_num	Number	否	[RC] lgc_name 、lgc_path 的行数	2
code	Number	否		0
msg	String	否

2-1 恢复 准备-1 恢复 获取还原时间点 - 文件

SDK方法名：listTimingRecoveryPathList

URL

/timing/recovery/rc_path_list

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
bk_uuid	String	否	备机节点uuid	B8566905-411E-B2CD-A742-77B1346D8E84
rc_data_path	String	否	备份数据路径	C:\back\
backup_task_uuid	String	否	【RC】 备份的uuid，用来即时恢复，可选参数，服务集群定时任务时传，用来表示备份任务	11111111-1111-1111-1111-111111111111
volume_uuid	String		【RC】复制卷uuid，服务集群定时任务传，用于表示任务所在卷
bk_storage	String		备份存储类型： 0：文件系统； 1：对象存储； 2：磁带库； 3：重删池；
tape_pool_uuid	String
tape_name	String
library_sn	String
dedupe_uuid	String		重删池uuid

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
data	Object	否
code	Number	否		0
message	String	否		[0] success
mirr_blk_size	Number	否		32768
backup_task	Object	否
backup_type	Number	否		0
wk_path	Array	否	工作路径	E:
bk_path	Array	否	备份路径	F:\e\
task_uuid	String	否		F06D82E4-ACBE-56B9-5B02-75BDC30B41E7
blk_direct_copy	Number	否
mount_point	String		挂载点	/test
recovery_task	Object	否
wk_data_type	Number	否	源类型，0：块设备；1：文件；3：oracle；4：mssql；	13
rc_time_point_list	Array	否		['2018-01-02_10-54-42','2018-01-02_11-16-56','2018-01-02_11-27-31','2018-01-02_11-27-38','2018-01-02_11-28-43','2018-01-02_11-30-45','2018-01-02_11-31-44','2018-01-02_11-32-38','2018-01-02_11-34-29','2018-01-02_11-35-25','2018-01-02_11-41-25','2018-01-03_14-15-09','2018-01-05_13-16-19']
bk_data_type	Number	否	目标类型，1：文件；2：raw数据；	1
bk_path	Array	否	备份路径	F:\e\2018-01-02_10-54-42\E
res_by_path	String
volume_uuid	String		文件还原，复制卷uuid	B8566905-411E-B2CD-A742-77B1346D8E85
storage	Object		合成备份挂载恢复 存储信息
srcos	Number		源机操作系统
dstos	Number		备机操作系统
msg	String	否

2-1 恢复 准备-4 恢复 认证MsSql数据库

SDK方法名：verifyTimingRecoveryMssqlInfo

URL

/timing/recovery/rc_verify_mssql_info

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
mssql_settings	Object	否	, mssql 设置（基本设置）
win_verify	Number	否	@mock=0, 登录SQL Server服务器的信息：0：用mssql用户名密码；1：用winNT集成设置；	0
pass_word	String	否	, sql server 密码，用winNT集成设置不填	123456
instance_name	String	否	, sql server 实例名，默认是MSSQLSERVER	MSSQLSERVER
user_id	String	否	, sql server 用户名，用winNT集成设置不填	sa
data_source	String		主机名
port	String		当网络协议类型为TCP/IP时，默认值1433
protocol	Number		0:shared memory，1:TCP/IP，默认值 0
wk_uuid	String	否	@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 还原目标端id	67E33CDB-D75B-15B3-367D-50C764F5A26F

Response

名称	类型	必选	简介	Mock初始值	Mock规则
data	Object	否
message	String	否	@mock=[0] success	[0] success
code	Number	否	@mock=0	0
msg	String	否	@mock=
ret	Number	否	@mock=200	200

恢复 准备 获取oracle恢复点日志

SDK方法名：listTimingRecoveryOracleRcPointInfo;

URL

/timing/recovery/rc_sbt

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
page	Number	否	第几页
limit	Number	否	每页记录数
bk_uuid	String	否
bk_path	String	否

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String	否
ret	Number	否		200
data	Object	否
record_info	Object	否
total	Number	否		100
list	Array	否
log_thread	Number	否		1
log_seq	Number	否		527
scn	Number	否		18614069
time	String	否		2020/05/07-17:55:48
arch_file	String	否	[隐藏] 下发给底层用	info2_arch_s938_p1_t1039802149
range_info	Object	否
scn_min	Number	否		1
scn_max	Number	否		527
time_min	String	否		2020-05-07 17:55:48
time_max	String	否		2020-05-08 19:21:50
log_seq_max	Number
log_seq_min	Number
code	Number	否		0
message	String	否		[0] success

恢复 准备 获取MySQL备份目录信息

SDK方法名：describeRcMysqlInfo;

URL

/timing/recovery/rc_mysql_info

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
bk_uuid	String			B8566905-411E-B2CD-A742-77B1346D8E84
rc_data_path	String			E:\mssqlBK\ts-11111111-1111-1111-1111-111111111111\

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String
info_list	Object
pool_name	String
volume_name	String
volume_uuid	String
log_ccopy	String
log_volume_name	String
log_volume_uuid	String
log_pool_name	String

恢复 获取控制文件参数文件列表

SDK方法名：listSbtContrlFile;

URL

/timing/recovery/sbt_contrlfile

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rc_data_path	String
ora_content_type	Number		还原的选项，6：控制文件，7：参数文件
bk_uuid	String
bk_storage	String
tape_pool_uuid	String
tape_name	String
library_sn	String

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
data	Object
info_list	Array			["adfdasfda","adfdaf","adfdafdaf"]
message	String			[0] success
code	Number			0
msg	String

恢复 获取DBID

SDK方法名：describeSbtDbid;

URL

/timing/recovery/sbt_dbid

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
file_name	String		所选择的文件名称
bk_uuid	String

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
data	Object
dbid	String			test
message	String			[0] success
code	Number			0
msg	String

2-2 恢复 新建/编辑-1 恢复 新建

SDK方法名：createTimingRecovery

URL

/timing/recovery

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
timing_recovery	Object	否
task_name	String	否	任务名	task
backup_task_uuid	String	否	[RC] 备份的uuid，用来即时恢复
backup_type	Number	否	[RC] 还原方式（文件还原用），0：全备；1：增量；2：差异；	0
bk_data_type	Number	否	备机目录类型， 1：文件； 2：raw数据； 15: 对象存储	1
bk_uuid	String	否	备机节点uuid	B8566905-411E-B2CD-A742-77B1346D8E84
bk_path	Array	否	备机路径（在复制规则目标节点上），数据库还原不传	["E:\t\2019-01-15_15-49-00\E\test\"]
wk_data_type	Number	否	工作机目录类型： 0：块设备； 1：文件； 3：oracle； 4：mssql； 6：db2； 15: GaussDB100T; 18：GoldenDB； 21：KingbaseES；	1
wk_uuid	String	否	工作机节点uuid	67E33CDB-D75B-15B3-367D-50C764F5A26F
rc_style	Number	否	[RC] 恢复方式 blk_recovery_style， 0：恢复到工作机（合成备份改为普通恢复）； 1：在备机合到指定目录（合成备份隐藏）；2: 挂载恢复（合成备份显示）	1
wk_path	Array	否	[RC] 新数据库文件存放路径，也是“在备机合到指定目录”的目录。旧版：db_file_save_path	["E:\test\"]
excl_path	Array	否	排除路径数组
rc_point_in_time	String	否	[RC] 还原时间点 rawfile	2019-01-15_15-49-00
rc_data_path	String	否	[RC] 备份数据路径	E:\t\
blk_direct_copy	Number	否	块备份，直接拷贝，取值为 rc_path_list 返回的同名参数；
oracle_settings	Object	否	oracle 设置（基本设置）
ora_login_name	String	否	[RC] oracle验证账户
ora_login_pwd	String	否	[RC] oracle验证密码
ora_port	Number	否	【隐藏】Oracle监听端口	1
ora_passwd	String	否	【隐藏】Oracle SYS用户密码	Info1234
ora_sid_name	String	否	Oracle数据库实例名
ora_home_path	String	否	Oracle数据库Home目录
ora_content_type	Number	否	备份内容： 0：整库； 1：表空间； 2：数据文件； 3：PDBS； 4：CDB； 5：ARCHIVELOG； 6：CONTROLFILE； 7：SPFILE； 8：TABLE;	0
ora_do_restore	Number	否	[RC] 还原（还原选项）： 0：否； 1：是；	0
ora_rst_limit_thread	Number	否	[RC] 还原到备份：线程	1
ora_rst_type	Number	否	[RC] 还原类型： 0：到最新； 1：到指定；	0
ora_rst_recory_point	Number	否	[RC] 还原： 0：日志还原点选择 ； 1：时间/SCN还原点选择；
ora_rst_limit_type	Number	否	[RC] 还原到备份 类型： 0：日期； 1：SCN； 2：日志序列号；	0
ora_rst_limit_date	String	否	[RC] 还原到备份：日期	2017-12-21 13:26:00
ora_rst_limit_scn	Number	否	[RC] 还原到备份：SCN	0
ora_rst_limit_log_seq	String	否	[RC] 还原到备份：日志序列号
ora_rst_record	Object	否	[RC] 还原：已选恢复点日志信息
ora_do_recovery	Number	否	[RC] 恢复（还原选项）： 0：否； 1：是；	0
ora_rc_point_thread	Number	否	[RC] 恢复到备份：线程	1
ora_rc_type	Number	否	[RC] 恢复类型： 0：到最新； 1：到指定；	0
ora_rc_recory_point	Number	否	[RC] 恢复： 0：日志还原点选择； 1：时间/SCN还原点选择
ora_rc_point_type	Number	否	[RC] 恢复到备份 类型： 0：日期； 1：SCN； 2：日志序列号；	0
ora_rc_point_date	String	否	[RC] 恢复到备份：日期	2017-12-21 13:26:00
ora_rc_point_scn	Number	否	[RC] 恢复到备份：SCN	0
ora_rc_point_log_seq	String	否	[RC] 恢复到备份：日志序列号
ora_rc_record	Object	否	[RC] 恢复：已选恢复点日志信息
ora_pdbs_name	String	否	PDB，ora_content_type 为 PDBS 时必传，内容为逗号分隔的PDB名称
ora_rst_arch_limit_type	Number	否	归档日志还原到指定备份 类型，2： 日志序列号；
ora_rst_arch_limit_log_seq	Number	否	归档日志还原到备份 日志序列号 作为起始日志序列号
ora_rst_endarch_limit_log_seq	Number		结束日志序列号
ora_dbid	String	否	DBID
ora_rst_ctrl_name	String	否	控制文件的备份文件名称
ora_rst_spfile_path	String	否	还原之后spfile的存放位置和名称
ora_rst_spfile_name	String	否	参数文件的备份文件名称
snapshot_name	String		[RC] 恢复快照名称
snapshot_time	String		[RC] 恢复快照时间点
rst_control	Number		[RC] 是否恢复控制文件 勾选-1 不勾选-0
ora_tab_mode	Number		数据库模式 0：CDB模式； 1：CDBRoots模式； 2：PDBs模式；	0
ora_tab_pdb_name	String		选择PDBs模式后，输入PDB的名称	''
ora_tab_names	Array
user	String		用户名
ori_table	String		原表名
tgt_table	String		目标表名
ora_tab_aux_path	String		辅助实例存放路径
ora_open_mode	Number		恢复后打开数据库： 0：不open； 1：read only； 2：resetlogs； 3：直接open；	0
log_ccopy	Number		日志持续开关： 通过备份点信息获取
log_volume_uuid	String		日志卷uuid
log_mount_point	String		日志卷挂载点
mssql_settings	Object	否	mssql 设置（基本设置）
win_verify	Number	否	登录SQL Server服务器的信息：0：用mssql用户名密码；1：用winNT集成设置；	0
data_source	String		数据源名称
instance_name	String	否	sql server 实例名，默认是MSSQLSERVER
protocol	Number		0:shared memory，1:TCP/IP，默认值 0
port	String		当网络协议类型为TCP/IP时，默认值1433
user_id	String	否	sql server 用户名，用winNT集成设置不填
pass_word	String	否	sql server 密码，用winNT集成设置不填
time_out	String	否	连接超时设定(秒):
db_info	Array		库信息，同时用来存放子任务信息
src_db_name	String		[RC] 原数据库名称
db_name	String
lgc_infos	Array
lgc_name	String		[RC] 原数据库逻辑名	test
lgc_path	String		[RC] 原数据库文件路径	C:\Program Files\Microsoft SQL Server\MSSQL12.MSSQLSERVER\MSSQL\DATA\test.mdf
rc_point_in_time	String		[RC] 还原时间点 rawfile	2019-01-15_15-49-00
new_db_name	String		[RC] 目标数据库名称
db_file_save_path	String		[RC] 目标数据库文件存放路径
check_out	String		是否开启还原完成后校验： 0：关； 1：开；	0
db_size	String		[RC] 数据库大小
tab_num	String		[RC] 数据库表个数
tab_info	String		[RC] 数据库表名
ln_num	String		[RC] 数据库表行数
ldf_name	String		该字段从获取数据库心里接口返回（目标类型为合成备份）
mdf_name	String		该字段从获取数据库心里接口返回（目标类型为合成备份）
lanfree	Number		是否开启lanfree：（目标类型为合成备份） 0：否； 1：是；	0
data_fetch	Number		是否开启数据回迁 （目标类型为合成备份） 0：否； 1：是；	0
volume_uuid	String		复制卷uuid（目标类型为合成备份）
mount_point	String		挂载点（目标类型为合成备份）
rep_dir	String		目标目录（目标类型为合成备份）
db2_settings	Object	否	db2 设置(基本设置)
db2_user	String
db2_group	String
log_file_dir	String	否	日志文件路径
db_info	Array
db_name	String		源数据库名称
new_db_name	String		新数据库名
db_path	String		子任务数据库备份路径
rc_point_in_time	String		还原时间点
compress	String	否	压缩：0不开启；1，低；2，中；3，高
encrypt_switch	String	否	加密开关，0不开启，1开启
secret_key	String	否	加密key
data_ip_uuid	String		灾备机数据地址	B8566905-411E-B2CD-A742-77B1346D8E84
mysql_settings	Object
pool_uuid	String		存储池ID
pool_name	String		存储池名称
volume_uuid	String		复制卷ID
volume_name	String		复制卷名称
attach_point	String		挂载点
mysql_host	String		数据库IP	127.0.0.1
mysql_port	String		端口
mysql_user	String		用户名
mysql_passwd	String		密码
snapshot_name	String		快照名称
snapshot_time	String		恢复时间点
mysql_rc_type	Number		不完全恢复 （开1，关0）
mysql_rc_time	String		恢复时间点
time_out	Number		超时时间
mysql_path	String		MySQL执行目录
log_ccopy	Number		日志持续复制开关
log_volume_uuid	String		日志卷uuid
log_mount_point	String		日志卷在还原目标机的挂载点
data_dir	String
lanfree	Number		lanfree开关：0-不勾选 1-勾选
mysql_startup_instance	Number		启动mysql实例： 0：不启动； 1：启动；	1
backup_mode	Number		mysql备份方式： 0：物理备份； 1：逻辑备份；	0
tables	Array		表备份数组：格式： db.table
oracle_rman_settings	Object
rman_num_streams_df	Number		[RC] 并行流数
synthetic_bkup_settings	Object		合成备份参数
mount_dir	String		普通恢复 - 挂载点
storage	Object		该值从时间点接口获取
volume_uuid	String		该值从时间点接口获取	BE54F165-107C-4435-18E0-0D6471A87FDE
rc_dir	String		挂载恢复 - 挂载点
db_name	String		（GAUSS集群）数据库名称
content_type	Number		(gauss集群),0 整库 1 表	0
tables	String		数据表名称，多个表之间用空格隔开(gauss集群)
res_by_path	String			''
informix_settings	Object		informix 基本设置
oper_user	String		【BK】操作用户，默认为informix
is_ori_machine	Number		【RC】是否恢复到原机: 1-是 0-否
thread_num	Number		并行任务数	1
protocol	String		mysql 链路协议: iSCSI,FC
fc_initiator_wwpn	String		fc客户端wwpn
fc_target_wwpn	String		fc目标端wwpn
data_return	Number		Mysql、Oracle合成备份： 是否开启数据回传： 0：关； 1：开； 默认值为0;	0
data_dir	String		数据回传目录	''
dm_settings	Object
bk_type	Number		备份类型：0整库，1表空间，2表，3归档日志
dm_home	String		Home目录
host	String		主机
port	Number		端口
user	String		用户名
password	String		密码
is_create	String		是否新建数据库： 0：否，1：是;
ini_path	String		dm.int路径
intance_name	String		实例名
db_name	String		数据库名
data_dir	String		数据库目录
system_user	String		系统用户，用于执行还原脚本（只对linux系统生效）； 非表还原时必传
content_type	String		还原内容： 0：整库； 1：表空间； 2：表； 3：归档日志；
table_space	String		表空间名
restore_switch	Number		还原开关：0，1
is_restore_resent	Number		还原类型： 0：指定备份； 1：最新备份；
rt_point	String		还原时间点
is_restore_arch	String		是否开启归档还原： 0：否； 1：是；
arch_type	Number		归档还原类型： 0：全部； 1：选择时间；
restore_time_type	Number		归档还原，指定时间类型： 0：日期； 1：LSN；
restore_until_time	String		还原时间
restore_until_lsn	String		还原lsn号
is_rt_arch_to_dir	Number		是否还原到目标目录: 0,1
arch_dir	String		目标目录
schema_name	String		（表还原）模式名
table_name	String		（表还原）表名
is_index	Number		开启索引： 0：关 1：开；	0
is_constraint	Number		约束： 0：关 1：开；	1
is_table_struct	Number		表结构： 0：关 1：开；	0
is_table_data	Number		表数据： 0：关 1：开；	1
recover_switch	Number		恢复开关：0，1
arch_from	Number		恢复类型： 0 ：从备份集恢复； 1： 从指定归档恢复；	0
is_force	Number		强制执行： 0：否，1：是；	0
log_dirs	Array		归档目录	[]
magic_num	String		数据库Magic，可不填
recover_time_type	Number		恢复时间点，指定时间类型： 0：日期； 1：LSN；	0
recover_until_time	String		恢复时间
recover_until_lsn	String		恢复lsn号
encrypt_switch	Number		解密开关： 0：关，1开
encrypt_password	String		解密密码
encrypt_algorithm	String		加密算法
thread_num	Number		还原线程数1~64	4
rc_path_policy	Number		恢复任务 路径映射类型： 0：一对一； 1：多对一；	0
obs_settings	Object		obs相关设置-跟备份一致
is_remote_rc	Number		是否开启远程恢复	0
storage_uuid	String		存储节点uuid（远程恢复）
storage_pool_uuid	String		存储池uuid（远程恢复）
gsdbt_settings	Object		GaussDB100T设置
gsdbt_home	String
oper_user	String
user	String
password	String
port	String
bk_file_crypt	String		备端数据加密： 1：是（默认）； 0：否；
bk_crypt_type	String		备端数据加密类型： 1：Byte Invert 字节翻转加密（默认）； 2：aes； 3：sm4； 4：RC5；
bk_crypt_key	String		备端数据加密，密钥
tape_uuid	String		磁带库uuid
tape_pool_uuid	String		磁带池uuid
tape_pool_name	String		磁带池名称
tape_name	String		磁带名
library_sn	String		磁带序列号
ukey_crypt_switch	Number		是否启用ukey凭据 0-不启用 1-启用
ukey_cred_uuid	String		ueky凭据uuid
bk_storage	Number		备份存储类型： 0：文件系统； 1：对象存储； 2：磁带库； 3：重删池；
dedupe_uuid	String		重删池uuid
rc_method	Number		恢复方式
select_data_path	String		选择数据路径
pre_recover_script	String		恢复前置脚本
post_recover_script	String		恢复后置脚本
goldendb_settings	Object		GoldenDB选项
manager_user_name	String
manager_user_home_dir	String
tenant_name	String
db_user_name	String
db_user_passwd	String
custom_rc_point	Boolean		是否自设置恢复时间点	false
resultset_datetime	String		备份集时间点
backup_task_uuid	String		GoldenDB实例信息接口返回的backup_task_uuid
backup_task_name	String		GoldenDB实例信息接口返回的backup_task_name
custom_type	Number		自定义类型，GASS参数
kingbasees_settings	Object
kes_bin	String		KES二进制文件目录
kes_data	String		数据库data目录
oper_user	String		操作用户
force	Boolean	否

Response

名称	类型	必选	简介	Mock初始值	Mock规则
data	Object	否
code	Number	否	@mock=0	0
message	String	否	@mock=[0] success	[0] success
msg	String	否	@mock=
ret	Number	否	@mock=200	200

2-2 恢复 新建/编辑-3 恢复 修改

SDK方法名：modifyTimingRecovery

URL

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

Method

PUT

Request

名称	类型	必选	简介	Mock初始值	Mock规则
timing_recovery	Object	否
wk_uuid	String	否	@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 工作机节点uuid	7AD64D7A-7D1D-AC51-5DF1-29A58345A288
task_name	String	否	@mock=task, 任务名	task
random_str	String	否	@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 用于防止并发修改的随机串	0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
wk_path	Array	否	, [RC] 新数据库文件存放路径 db_file_save_path
bk_data_type	Number	否	@mock=1, 备机目录类型，1：文件；2：raw数据；	1
bk_path	Array	否	, 备机路径（在复制规则目标节点上），数据库还原不传
backup_type	Number	否	@mock=0, [RC] 还原方式，0：全备；1：增量；2：差异；	0
oracle_settings	Object	否	, oracle 设置（基本设置）
ora_rc_point_thread	Number	否	@mock=1, [RC] 恢复到备份 线程	1
ora_rc_point_date	String	否	@mock=2017-12-21 13:26:00, [RC] 恢复到备份 日期	2017-12-21 13:26:00
ora_passwd	String	否	@mock=Info1234, 【隐藏】Oracle SYS用户密码	Info1234
ora_port	Number	否	@mock=1, 【隐藏】Oracle监听端口	1
ora_rc_point_type	Number	否	@mock=0, [RC] 恢复到备份 类型，0：日期；1：SCN；2：日志序列号；	0
ora_do_recovery	Number	否	@mock=0, [RC] 恢复（还原选项），0：否；1：是；	0
ora_do_restore	Number	否	@mock=0, [RC] 还原（还原选项），0：否；1：是；	0
ora_home_path	String	否	@mock=, Oracle数据库Home目录
ora_rst_type	Number	否	@mock=0, [RC] 还原类型，0：到最新；1：到指定；	0
ora_rst_limit_type	Number	否	@mock=0, [RC] 还原到备份 类型，0：日期；1：SCN；2：日志序列号；	0
ora_sid_name	String	否	@mock=, Oracle数据库实例名
ora_rst_limit_thread	Number	否	@mock=1, [RC] 还原到备份 线程	1
ora_rst_limit_date	String	否	@mock=2017-12-21 13:26:00, [RC] 还原到备份 日期	2017-12-21 13:26:00
ora_content_type	Number	否	@mock=0, 0：整库；1：表空间；2：数据文件；	0
ora_rst_limit_log_seq	String	否	@mock=, [RC] 还原到备份 日志序列号
ora_rst_limit_scn	Number	否	@mock=0, [RC] 还原到备份 SCN	0
ora_rc_type	Number	否	@mock=0, [RC] 恢复类型，0：到最新；1：到指定；	0
ora_rc_point_log_seq	String	否	@mock=, [RC] 恢复到备份 日志序列号
ora_rc_point_scn	Number	否	@mock=0, [RC] 恢复到备份 SCN	0
bk_uuid	String	否	@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机节点uuid	0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
task_uuid	String	否	@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 任务id，如果节点和规则id都不传，则全部	7AD64D7A-7D1D-AC51-5DF1-29A58345A288
backup_task_uuid	String	否	@mock=, [RC] 备份的uuid，用来即时恢复
mssql_settings	Object	否	, mssql 设置（基本设置）
win_verify	Number	否	@mock=0, 登录SQL Server服务器的信息：0：用mssql用户名密码；1：用winNT集成设置；	0
mdf_name	String	否	@mock=, [RC] 原数据库逻辑名(MDF)
src_db_name	String	否	@mock=, [RC] 原数据库名称
user_id	String	否	, sql server 用户名，用winNT集成设置不填
ldf_name	String	否	@mock=, [RC] 原数据库逻辑名(LDF)
ldf_path	String	否	@mock=, [RC] 原数据库文件路径(LDF)
instance_name	String	否	, sql server 实例名，默认是MSSQLSERVER
pass_word	String	否	, sql server 密码，用winNT集成设置不填
db_file_save_path	String	否	@mock=, [RC] 新数据库文件存放路径
mdf_path	String	否	@mock=, [RC] 原数据库文件路径(MDF)
new_db_name	String	否	@mock=, [RC] 新数据库名称
db2_settings	Object	否
db2_user	String
db2_group	String
log_file_dir	String
db_info	Array
task_uuid	String
task_name	String
db_name	String
new_db_name	String
db_path	String
rc_point_in_time	String
rc_data_path	String	否	@mock=C:\back\, [RC] 备份数据路径	C:\back\
rc_style	Number	否	@mock=1, [RC] 恢复方式 blk_recovery_style，0：恢复到工作机；1：在备机合到指定目录；	1
wk_data_type	Number	否	@mock=0, 工作机目录类型，0：块设备；1：文件；3：oracle；4：mssql；	0
rc_point_in_time	String	否	@mock=2017-12-21_13-16-53, [RC] 还原时间点 rawfile	2017-12-21_13-16-53
excl_path	Array	否
data_ip_uuid	String		灾备机数据地址	7AD64D7A-7D1D-AC51-5DF1-29A58345A288
res_by_path	String			''
data_return	Number			0
data_dir	String			''
rc_path_policy	Number			0
bk_storage	String		备份存储类型： 0：文件系统； 1：对象存储； 2：磁带库； 3：重删池；
dedupe_uuid	String		重删池uuid
force	Boolean	否

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String	否	@mock=
data	Object	否
code	Number	否	@mock=0	0
message	String	否	@mock=[0] success	[0] success
ret	Number	否	@mock=200	200

2-2 恢复 新建/编辑-2 恢复 获取单个

SDK方法名：describeTimingRecovery

URL

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

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String	否	@mock=
ret	Number	否	@mock=200	200
data	Object	否
timing_recovery	Object	否
wk_data_type	Number	否	@mock=0, 工作机目录类型，0：块设备；1：文件；3：oracle；4：mssql；9: mysql;	3
backup_type	Number	否	@mock=0, [RC] 还原方式，0：全备；1：增量；2：差异；	0
task_uuid	String	否	@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 任务id，如果节点和规则id都不传，则全部	7AD64D7A-7D1D-AC51-5DF1-29A58345A288
backup_task_uuid	String	否	@mock=, [RC] 备份的uuid，用来即时恢复
wk_uuid	String	否	@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 工作机节点uuid	7AD64D7A-7D1D-AC51-5DF1-29A58345A288
bk_data_type	Number	否	@mock=1, 备机目录类型，1：文件；2：raw数据；10: 快照	10
rc_data_path	String	否	@mock=C:\back\, [RC] 备份数据路径	C:\back\
task_name	String	否	@mock=task, 任务名	task
oracle_settings	Object	否	, oracle 设置（基本设置）
ora_rc_point_thread	Number	否	@mock=1, [RC] 恢复到备份 线程	1
ora_rst_limit_date	String	否	@mock=2017-12-21 13:26:00, [RC] 还原到备份 日期	2017-12-21 13:26:00
ora_content_type	Number	否	@mock=0, 0：整库；1：表空间；2：数据文件；	0
ora_do_recovery	Number	否	@mock=0, [RC] 恢复（还原选项），0：否；1：是；	0
ora_sid_name	String	否	@mock=, Oracle数据库实例名
ora_rst_limit_thread	Number	否	@mock=1, [RC] 还原到备份 线程	1
ora_rst_limit_type	Number	否	@mock=0, [RC] 还原到备份 类型，0：日期；1：SCN；2：日志序列号；	0
ora_rc_type	Number	否	@mock=0, [RC] 恢复类型，0：到最新；1：到指定；	1
ora_rst_type	Number	否	@mock=0, [RC] 还原类型，0：到最新；1：到指定；	0
ora_rst_limit_log_seq	String	否	@mock=, [RC] 还原到备份 日志序列号
ora_home_path	String	否	@mock=, Oracle数据库Home目录
ora_do_restore	Number	否	@mock=0, [RC] 还原（还原选项），0：否；1：是；	0
ora_rc_point_date	String	否	@mock=2017-12-21 13:26:00, [RC] 恢复到备份 日期	2017-12-21 13:26:00
ora_rc_point_type	Number	否	@mock=0, [RC] 恢复到备份 类型，0：日期；1：SCN；2：日志序列号；	2
ora_rc_point_scn	Number	否	@mock=0, [RC] 恢复到备份 SCN	0
ora_rst_limit_scn	Number	否	@mock=0, [RC] 还原到备份 SCN	0
ora_passwd	String	否	@mock=Info1234, 【隐藏】Oracle SYS用户密码	Info1234
ora_rc_point_log_seq	String	否	@mock=, [RC] 恢复到备份 日志序列号	333
ora_port	Number	否	@mock=1, 【隐藏】Oracle监听端口	1
snapshot_time	String			2019-01-01 17:55:22
rc_point_in_time	String	否	@mock=2017-12-21_13-16-53, [RC] 还原时间点 rawfile	2017-12-21_13-16-53
rc_style	Number	否	@mock=1, [RC] 恢复方式 blk_recovery_style，0：恢复到工作机；1：在备机合到指定目录；	1
wk_path	Array	否	, [RC] 新数据库文件存放路径 db_file_save_path
random_str	String	否	@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 用于防止并发修改的随机串	0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
bk_path	Array	否	, 备机路径（在复制规则目标节点上），数据库还原不传
bk_uuid	String	否	@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机节点uuid	0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
db2_settings	Object	否
db2_user	String
db2_group	String
log_file_dir	String
db_info	Array	否		db2_test
task_uuid	String
task_name	String
db_name	String
new_db_name	String
db_path	String
rc_point_in_time	String
mssql_settings	Object	否	, mssql 设置（基本设置）
ldf_path	String	否	@mock=, [RC] 原数据库文件路径(LDF)
src_db_name	String	否	@mock=, [RC] 原数据库名称
mdf_name	String	否	@mock=, [RC] 原数据库逻辑名(MDF)
ldf_name	String	否	@mock=, [RC] 原数据库逻辑名(LDF)
new_db_name	String	否	@mock=, [RC] 新数据库名称
db_file_save_path	String	否	@mock=, [RC] 新数据库文件存放路径
mdf_path	String	否	@mock=, [RC] 原数据库文件路径(MDF)
instance_name	String	否	, sql server 实例名，默认是MSSQLSERVER
win_verify	Number	否	@mock=0, 登录SQL Server服务器的信息：0：用mssql用户名密码；1：用winNT集成设置；	0
data_ip_uuid	String		灾备机数据地址	0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
res_by_path	String			''
data_return	Number			0
data_dir	String			''
message	String	否	@mock=[0] success	[0] success
code	Number	否	@mock=0	0

2-3 恢复 列表-1 恢复 获取列表

SDK方法名：listTimingRecovery; 获取列表详细入参说明详见【节点管理-获取节点列表】接口说明；

URL

/timing/recovery

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
search_value	String	否	, 可选，搜索字段对应值（可以模糊）
page	Number	否	, 可选，不传就是全部
limit	Number	否	, 可选，不传就是全部
search_field	String	否	, 可选，搜索字段

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否	@mock=200	200
data	Object	否
info_list	Array	否
bk_node_name	String	否	@mock=@pick(["kevin", "Jane", "Grey"]), 备机节点名	@pick(["kevin", "Jane", "Grey"])
wk_node_name	String	否	@mock=@pick(["Smith", "Will", "Nary"]), 工作机节点名	@pick(["Smith", "Will", "Nary"])
task_name	String	否	@mock=task_name, 任务名	task_name
wk_uuid	String	否	@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机节点uuid	0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
username	String	否	@pick(["admin", "user"]), 所有者
user_uuid	String	否	@pick(["1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC","1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC"]), 操作者用户名uuid
task_uuid	String	否	@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 任务id，如果节点和规则id都不传，则全部	7AD64D7A-7D1D-AC51-5DF1-29A58345A288
bk_uuid	String	否	@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机节点uuid	0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
can_del	Number			1
can_up	Number			1
can_op	Number			1
wk_data_type	Number			9
group_uuid	String
is_group	Number			0
children	Array
message	String	否	@mock=[0] success	[0] success
code	Number	否	@mock=0	0
total	Number	否	@mock=100, 规则总数	100
msg	String	否	@mock=

2-3 恢复 列表-3 恢复 删除

SDK方法名：deleteTimingRecovery

URL

/timing/recovery

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
task_uuids	Array	否	, *规则数组	["11111111-1111-1111-1111-111111111111"]
force	Number		1 - 强制删除 0 - 非强制删除
del_clone	Number		快照备份，是否删除克隆卷： 0：不删除； 1：删除； 默认传0	0

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
data	Object
code	Number			11110001
message	String
fail_list	Array
code	Number			11110001
message	String			[-1] 离线
task_uuid	String			@guid
task_name	String			test1
success_list	Array
code	Number			11110001
message	String			[0] success
task_uuid	String			@guid
task_name	String			test2
ret	Number			200

2-3 恢复 列表-2 恢复 状态

SDK方法名：listTimingRecoveryStatus

URL

/timing/recovery/status

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
task_uuids	Array	否	, 必传，uuid数组，页面加载第一次获取状态一个一个获取，之后是批量获取；	["11111111-1111-1111-1111-111111111111"]
force_refresh	Number		点击操作栏刷新按钮必传，下发1，表示从rpc获取；其他情况不传

Response

名称	类型	必选	简介	Mock初始值	Mock规则
data	Object	否
message	String	否	@mock=[0] success	[0] success
code	Number	否	@mock=0	0
count	Number	否	@mock=0	0
status	Array	否
status	String	否	@mock=STOP, 状态文字	MIRROR
cur	Number	否	, 当前大小
progress	Number	否	@mock=0, 进度	0
f_total	Number	否	@mock=0, 文件总数	0
task_uuid	String	否	@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 任务id	7AD64D7A-7D1D-AC51-5DF1-29A58345A288
total	Number	否	@mock=100, 总大小	100
f_cur	Number	否	, 当前文件数
msg	String	否	@mock=
ret	Number	否	@mock=200	200

2-3 恢复 列表-4 恢复 操作

SDK方法名：

启动：startTimingRecovery;

停止：stopTimingRecovery;

URL

/timing/recovery/operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
task_uuids	Array	否	, start, stop 操作时必传，规则数组
operate	String	否	start：启动； stop：停止； unmount：快照备份，卸载文件系统； mount_logon: 合成备份挂载恢复-挂载 umount_logout: 合成备份挂载恢复-卸载	start
force	Number		强制操作标识

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String	否	@mock=
data	Object	否
code	Number	否	@mock=0	0
message	String	否	@mock=[0] success	[0] success
ret	Number	否	@mock=200	200

2-4 恢复 mssql 获取单个组

SDK方法名：describeGroupTimingRecovery;

URL

/timing/recovery/:uuid([A-F0-9-]+)/group

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
ret	Number			200
data	Object
timing_recovery	Object
wk_data_type	Number			3
task_name	String			task
backup_type	Number			0
task_uuid	String			7AD64D7A-7D1D-AC51-5DF1-29A58345A288
backup_task_uuid	String
wk_uuid	String			7AD64D7A-7D1D-AC51-5DF1-29A58345A288
bk_data_type	Number			10
rc_data_path	String			C:\back\
mssql_settings	Object
instance_name	String
win_verify	Number			0
user_id	String
pass_word	String
time_out	String
data_source	String
port	String
protocol	String
db_info	Array
src_db_name	String
lgc_names	Array
lgc_name	String
lgc_path	String
new_db_name	String
db_file_save_path	String
check_out	String
db_size	String
tab_num	String
tab_info	String
ln_num	String
oracle_settings	Object
ora_rc_point_thread	Number			1
ora_rst_limit_date	String			2017-12-21 13:26:00
ora_content_type	Number			0
ora_do_recovery	Number			0
ora_sid_name	String
ora_rst_limit_thread	Number			1
ora_rst_limit_type	Number			0
ora_rc_type	Number			1
ora_rst_type	Number			0
ora_rst_limit_log_seq	String
ora_home_path	String
ora_do_restore	Number			0
ora_rc_point_date	String			2017-12-21 13:26:00
ora_rc_point_type	Number			2
ora_rc_point_scn	Number			0
ora_rst_limit_scn	Number			0
ora_passwd	String			Info1234
ora_rc_point_log_seq	String			333
ora_port	Number			1
snapshot_time	String			2019-01-01 17:55:22
rc_point_in_time	String			2017-12-21_13-16-53
rc_style	Number			1
wk_path	Array
random_str	String			0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
bk_path	Array
bk_uuid	String			0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
db2_settings	Object
new_db_name	String			db2_test
data_ip_uuid	String			0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
res_by_path	String			''
group_uuid	String
message	String			[0] success
code	Number			0

恢复 检查 目录是否存在

SDK方法名：timingRecoveryCheckDir;

URL

/timing/recovery/check_dir

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
node_uuid	String		节点uuid
check_type	Number		1：检测Mysql执行目录 2：检测数据回传目录 or 数据目录
file_dir	Array		检测目录

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
message	String			[0] success
code	Number		0代表检测成功	0

2-5 恢复 多库备份获取数据库列表

SDK方法名：listTimingRecoveryDbInfo;

URL

/timing/recovery/db_info

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
bk_uuid	String		备份服务器uuid
rc_data_path	String		恢复数据路径
wk_data_type	String		目标类型： 4：mssql； 6：db2； 不传默认为4	4
bk_storage	Number		备份存储类型: 0：文件系统； 1：对象存储； 2：磁带库；
obs_settings	Object		备份存储设置
tape_uuid	String		磁带库uuid
tape_pool_uuid	String		磁带池uuid
tape_name	String		磁带名
library_sn	String		磁带序列号

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
ret	Number			200
data	Object
db_infos	Array		数据库信息列表
db_name	String		数据库名称	aaa
db_path	String		数据库备份路径，用来作为获取备份时间点的参数	/afds
rc_point_in_time	String		最新备份时间点，格式：2021-06-02_11-00-04	2021-06-02_11-00-04
lgc_infos	Array
lgc_name	String		源逻辑文件名
lgc_path	String		源物理文件路径
bk_mode	String
db_size	String		数据库大小
login_mode	String		登录模式，Windows NT或用户名密码登录
inst_name	String		实例名
message	String			[0] success
code	Number			0

（废弃）策略 新建/编辑-1 策略 新建

URL

/policy

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
policy	Object	否
policy_type	Number	否	策略类型: timing: 0	0
policy_name	String	否	策略名	test
bkup_policy	Number	否	备份策略，2 立即，0 定时，1 循环；	0
bkup_window	Object	否	运行时间范围
sched_time_start	String	否	运行时间范围 开始	@time('HH:mm')
sched_time_end	String	否	运行时间范围 结束	@time('HH:mm')
bkup_one_time	Number	否	定时任务，执行时间（备份策略）	1515568566
policy_uuid	String	否	策略uuid	38FFA6E2-2A40-31D6-7A94-E8168EBA9FF1
bkup_schedule	Array	否	周期任务（备份策略）
limit	Number	否	数据保留期限（天）	@integer(1, 64)
sched_day	Array	否	哪几天	"@integer(1, 31)"
sched_every	Number	否	0：每天；1：每周：2：每月；3：每隔；	2
sched_time	Array	否	哪几点	@time('HH:mm')
sched_gap_min	Number	否	间隔分钟数	@integer(1, 64)

Response

名称	类型	必选	简介	Mock初始值	Mock规则
data	Object	否
message	String	否	@mock=[0] success	[0] success
code	Number	否	@mock=0	0
ret	Number	否	@mock=200	200
msg	String	否	@mock=

（废弃）策略 新建/编辑-2 策略 获取单个

URL

/reg:/policy/[A-F0-9-]+

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否	@mock=200	200
msg	String	否	@mock=
data	Object	否
code	Number	否	@mock=0	0
message	String	否	@mock=[0] success	[0] success
policy	Object	否
create_time	Number	否	@mock=1515568566, 任务创建时间	1515568566
policy_uuid	String	否	@mock=38FFA6E2-2A40-31D6-7A94-E8168EBA9FF1, 策略uuid	38FFA6E2-2A40-31D6-7A94-E8168EBA9FF1
user_uuid	String	否	@mock=@pick(["1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC","1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC"]), 操作者用户名uuid	@pick(["1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC","1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC"])
policy_type	Number	否	@mock=0, 策略类型: timing: 0	0
bkup_policy	Number	否	@mock=0, 备份策略，2 立即，0 定时，1 循环；	0
bkup_schedule	Array	否	, 周期任务（备份策略）
sched_time	Array	否	@mock=@time('HH:mm'), 哪几点	@time('HH:mm')
sched_day	Array	否	@mock="@integer(1, 31)", 哪几天	"@integer(1, 31)"
sched_every	Number	否	@mock=2, 0：每天；1：每周：2：每月；3：每隔；	2
limit	Number	否	@mock=@integer(1, 64), 数据保留期限（天）	@integer(1, 64)
sched_gap_min	Number	否	@mock=@integer(1, 64), 间隔分钟数	@integer(1, 64)
bkup_window	Object	否	, 运行时间范围
sched_time_end	String	否	@mock=@time('HH:mm'), 运行时间范围 结束	@time('HH:mm')
sched_time_start	String	否	@mock=@time('HH:mm'), 运行时间范围 开始	@time('HH:mm')
bkup_one_time	Number	否	@mock=1515568566, 定时任务，执行时间（备份策略）	1515568566
policy_name	String	否	@mock=test, 策略名	test

（废弃）策略 新建/编辑-3 策略 修改

URL

/reg:/policy/[A-F0-9-]+

Method

PUT

Request

名称	类型	必选	简介	Mock初始值	Mock规则
policy	Object	否
user_uuid	String	否	@mock=@pick(["1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC","1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC"]), 操作者用户名uuid	@pick(["1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC","1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC"])
bkup_policy	Number	否	@mock=0, 备份策略，2 立即，0 定时，1 循环；	0
bkup_schedule	Array	否	, 周期任务（备份策略）
sched_time	Array	否	@mock=@time('HH:mm'), 哪几点	@time('HH:mm')
limit	Number	否	@mock=@integer(1, 64), 数据保留期限（天）	@integer(1, 64)
sched_day	Array	否	@mock="@integer(1, 31)", 哪几天	"@integer(1, 31)"
sched_every	Number	否	@mock=2, 0：每天；1：每周：2：每月；3：每隔；	2
sched_gap_min	Number	否	@mock=@integer(1, 64), 间隔分钟数	@integer(1, 64)
create_time	Number	否	@mock=1515568566, 任务创建时间	1515568566
policy_name	String	否	@mock=test, 策略名	test
bkup_one_time	Number	否	@mock=1515568566, 定时任务，执行时间（备份策略）	1515568566
policy_type	Number	否	@mock=0, 策略类型: timing: 0	0
policy_uuid	String	否	@mock=38FFA6E2-2A40-31D6-7A94-E8168EBA9FF1, 策略uuid	38FFA6E2-2A40-31D6-7A94-E8168EBA9FF1
bkup_window	Object	否	, 运行时间范围
sched_time_end	String	否	@mock=@time('HH:mm'), 运行时间范围 结束	@time('HH:mm')
sched_time_start	String	否	@mock=@time('HH:mm'), 运行时间范围 开始	@time('HH:mm')

Response

名称	类型	必选	简介	Mock初始值	Mock规则
data	Object	否
code	Number	否	@mock=0	0
message	String	否	@mock=[0] success	[0] success
msg	String	否	@mock=
ret	Number	否	@mock=200	200

（废弃）策略 列表-1 策略 获取列表

获取列表详细入参说明详见【节点管理-获取节点列表】接口说明；

URL

/policy

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
limit	Number	否	, 可选，不传就是全部
like_args	Array	否	, 可选，多重搜索 , 字段 => 搜索值或值的数组
page	Number	否	, 可选，不传就是全部
where_args	Array	否	, 可选，多重搜索 , 字段 => 搜索值或值的数组

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否	@mock=200	200
msg	String	否	@mock=
data	Object	否
message	String	否	@mock=[0] success	[0] success
total	Number	否	@mock=100, 规则总数	100
info_list	Array	否			10
bkup_policy	Number	否	@mock=0, 备份策略，2 立即，0 定时，1 循环；	0
user_uuid	String	否	@mock=@pick(["1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC","1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC"]), 操作者用户名uuid	@pick(["1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC","1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC"])
policy_name	String	否	@mock=test, 策略名	test
policy_uuid	String	否	@mock=38FFA6E2-2A40-31D6-7A94-E8168EBA9FF1, 策略uuid	38FFA6E2-2A40-31D6-7A94-E8168EBA9FF1
bkup_schedule	Array	否	, 周期任务（备份策略）
sched_every	Number	否	@mock=2, 0：每天；1：每周：2：每月；3：每隔；	2
sched_day	Array	否	@mock="@integer(1, 31)", 哪几天	"@integer(1, 31)"
sched_time	Array	否	@mock=@time('HH:mm'), 哪几点	@time('HH:mm')
sched_gap_min	Number	否	@mock=@integer(1, 64), 间隔分钟数	@integer(1, 64)
limit	Number	否	@mock=@integer(1, 64), 数据保留期限（天）	@integer(1, 64)
policy_type	Number	否	@mock=0, 策略类型: timing: 0	0
bind_num	Number	否	@mock=3, 绑定的任务数量	3
create_time	Number	否	@mock=1515568566, 任务创建时间	1515568566
bkup_window	Object	否	, 运行时间范围
sched_time_end	String	否	@mock=@time('HH:mm'), 运行时间范围 结束	@time('HH:mm')
sched_time_start	String	否	@mock=@time('HH:mm'), 运行时间范围 开始	@time('HH:mm')
bkup_one_time	Number	否	@mock=1515568566, 定时任务，执行时间（备份策略）	1515568566
code	Number	否	@mock=0	0

（废弃）策略 列表-3 策略 删除

URL

/policy

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
policy_uuids	Array	否	, *策略数组

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String	否	@mock=
ret	Number	否	@mock=200	200
data	Object	否
code	Number	否	@mock=0	0
message	String	否	@mock=[0] success	[0] success

恢复 - 准备1 - DB2获取时间列表

SDK方法名：listTimingRecoveryDb2Time

URL

/timing/recovery/rc_db2_time

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
bk_uuid	String	否		B8566905-411E-B2CD-A742-77B1346D8E84
rc_data_path	String	否		E:\mssqlBK\ts-11111111-1111-1111-1111-111111111111\

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String	否
ret	Number	否		200
data	Object	否
db2_time_list	Array	否
code	Number	否		0
message	String	否		[0] success

（废弃）策略 列表-4 策略 操作

URL

/policy/operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
policy_uuids	Array	否	, *策略数组
operate	String	否	@mock=bind, *bind	bind

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String	否	@mock=
data	Object	否
code	Number	否	@mock=0	0
message	String	否	@mock=[0] success	[0] success
ret	Number	否	@mock=200	200

恢复 获取GAUSS还原时间点

SDK方法名：listTimingRecoveryGaussTime;

URL

/timing/recovery/gaussdb_rc_time

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuid	String		灾备机uuid
bk_path	String		备份路径

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
ret	Number			200
data	Object
code	Number			0
message	String			[0] success
timelist	Array
	String

达梦 获取备份集信息

SDK方法名：describeTimingRecoveryDmBackupInfo;

URL

/timing/recovery/dm_backup_info

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
node_uuid	String		节点uuid
bk_path	String		备份目录

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
ret	Number			200
data	Object
bk_info	Object
content_type	String		备份类型： 0：整库； 1：表空间； 2：表； 3：归档日志；
table_spaces	Array		表空间列表
table_name	String		表名
from_lsn	String		开始lsn号
until_lsn	String		截止lsn号
from_time	String		开始时间
until_time	String		截止时间
schema_name	String		模式名
time_stamps	Array		还原时间点列表
code	Number			0
message	String			[0] success

还原 - 临时挂载复制卷

SDK方法名：operateVolume;

URL

/timing/recovery/volume_operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
volume_uuid	String		复制卷uuid
node_uuid	String		服务集群uuid
operate	String		mount表示挂载复制卷, status表示查询挂载任务状态	mount

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] success
status	String		MOUNTED表示已挂载，可以进行选择目录了	MOUNTED
rc_data_path	String		如果状态为MOUNTED，可直接使用该值作为备份数据目录

备份 - 获取备份点信息

SDK方法名：listTimingBackupPoint;

URL

/timing/backup/bkup_point_list

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
ret	Number			200
data	Object
list	Array
time	String		时间点	2022-03-17 09:40:43
backup_type	String		备份类型，增量(i或1)，全量(o或0)，差异(d或2)等，需统一定义。 f 整盘 m erge 合成 n ull 未知 增加定义（2021-02-22）：数据（data），日志（log）。	i
size	Number		大小	10240000
message	String			[0] success
code	Number			0

备份 - 删除备份时间点

SDK方法名：deleteTimingBackupPoint;

URL

/timing/backup/bkup_point

Method

DELETE

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
data	Object
code	Number			0
message	String
msg	String
ret	Number			200

文件还原 - 挂载路径动作

SDK方法名：taskMountDir;

URL

/timing/recovery/task_mount_dir

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
node_uuid	String		灾备机uuid
bakdir	String		备份数据目录
rc_point	String		还原时间点
bk_storage	String
tape_pool_uuid	String
tape_name	String
library_sn	String

Response

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

合成恢复获取还原时间点列表

SDK方法名：listFileSnapshot;

URL

/timing/recovery/file_snapshot_list

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
volume_uuid	String		复制卷uuid

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
ret	Number			200
data	Object
code	Number			0
message	String			[0] success
snap_list	Array			["2022-05-11_13-24-59","2022-05-11_13-43-06","2022-05-11_13-44-15"]

合成恢复获取备份点数据库详细信息

SDK方法名：listDbNames;

URL

/timing/recovery/db_names

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
volume_uuid	String		复制卷uuid
rc_point_in_time	String		还原时间点
mount_point	String		挂载路径
lanfree	Number
node_uuid	String		恢复时传，指定rpc下发节点uuid

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	String
message	String			[0] success
db_names	Array
src_db_name	String		数据库名称
ldf_name	String		ldf文件名
mdf_name	String		mdf文件名
login_msg	Object		登录信息
win_verify	Number		登录模式
instance_name	String		实例名
user_id	String		登录用户
protocol	String		协议类型
port	String		端口号

Mysql表恢复 - 获取数据库表信息

SDK方法名：listMysqlDbTableInfo;

URL

/timing/recovery/mysql_db_table_info

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rc_time	String		还原时间点
bk_path	String		备份路径
bk_uuid	String		备机uuid

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。
tables	Array		备份点备份的表信息数组，格式：db.table	['a.tb1', 'a.t2']

手动归档 - 获取备份时间点

SDK方法名：listBakVer;

URL

/timing/backup/bak_ver_list

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
task_uuid	String		备份规则uuid

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
ret	Number			200
data	Object
code	Number			0
message	String
list	Array				1-10
time	String		备份时间点	@datetime('yyyy-MM-dd_HH-mm-ss')
size	String		备份大小	@integer(1000, 100000)
data_type	String		备份类型： o：全量	o
list_map	Array		全量时间点对应的增量或差异时间点		1-4
time	String		备份时间点	@datetime('yyyy-MM-dd_HH-mm-ss')
size	String		备份大小	@integer(100, 1000)
data_type	String		备份类型： i：增量； d：差异；	@pick(i, d)

手动归档

SDK方法名：bakDataArchive;

URL

/timing/backup/bak_data_archive

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
task_uuid	String		备份规则uuid
list	Array		备份点列表
time	String
size	String
data_type	String		备份类型： o：全量； i：增量； d：差异；
list_map	Array			[]

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
ret	Number			200
data	Object
code	Number			0
message	String

GoldenDB 查询实例信息

SDK方法名：describeGoldebDBInfo;

URL

/timing/backup/goldendb_info

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
node_uuid	String		节点uuid
is_backup	String		是否备份新规则： 0：恢复规则； 1 ：备份规则；
backup_task_uuid	String		备份规则uuid（创建恢复任务，从备份规则点击创建时传）
tenant_name	String		租户名称（创建恢复任务，从备份规则点击创建时传）

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
ret	Number			200
data	Object
code	Number			0
message	String			[0] success
manager_user	Array		管理用户数组		3
user_name	String		管理用户名	i2manager
home_dir	String		管理用户家目录	/home/goldendb/i2manager
tenant	Array		租户数据库列表		2
name	String		名称
bak_rules	Array		备份信息（还原选项）
backup_task_uuid	String		备份点对应的备份规则uuid
backup_task_name	String		备份点对应的备份规则name（需要用来显示到页面上的）
bak_dir	Array		备份目标路径
name	String		备份目录
backup_resultsets	Array		备份时间点列表
resultset_datetime	String		备份时间点	"2018-01-02_11-27-31"
backup_type	String
backup_data_size	String		byte
binlog_range	Object		可使用的还原时间点范围
start_time	String		开始时间	1675676448
end_time	String		结束时间	1675676448
rep_dir	Array		备份目标路径（备份选项）	['/qwe', '/zxcvz']

GoldenDB 校验实例

SDK方法名：verifyGoldebDB;

URL

/timing/backup/goldendb_verify

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
node_uuid	String		节点uuid
is_backup	Number		是否备份新规则： 0：恢复规则； 1 ：备份规则；
bak_dir	String		备份数据目录
golden_db_opt	Object		GoldenDB配置选项（同新建）
manager_user_name	String		管理用户名
manager_user_home_dir	String		管理用户家目录
tenant_name	String		租户名
db_user_name	String		租户数据库用户名
db_user_passwd	String		租户数据库用户密码（RSA加密）

Response

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

获取自定义数据类型

SDK方法名：listCustomTypes;

URL

/timing/backup/custom_type

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
ret	Number			200
data	Object
code	Number			0
message	String			[0] success
list	Array		自定义源类型/目标类型 列表		1-4
data_type	Number		数字类型		1-6
name	String		名称	@cword(2, 6)DB

------ 作业任务 ------

URL

/dash/timing/work

Method

GET

Request

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

Response

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

3-1 作业任务 列表

SDK方法名：listTimingWork;

URL

/timing/work

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
page	Number
limit	Number
where_args[task_uuid]	String		按备份规则过滤
search_field	String		按规则名称搜索：work_name
search_value	String

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
info_list	Array				2-8
work_id	String		任务id	@increment
work_type	Number		任务类型： 0：归档； 1：清空磁带； 2：格式化磁带； 3：重构catalog；		0-3
status	String		状态： FINISH：完成； STOP：停止； WORKING：进行中；	@pick('FINISH', 'STOP', 'WORKING')
work_uuid	String		任务uuid	@uuid
work_name	String		任务名称	@cword(1,12)
wk_name	String		工作机名称	@first
bk_name	String		灾备机名称	@last
start	Number		开始时间，unix时间戳或者null	@integer(1681820444, 1681999444)
end	Number		结束时间，unix时间戳或者null	1681894444
detail	Object		详细信息
can_del	Number				0-1
progress	String		进度
total	String		总数据量
current	String		当前数据量
ftotal	String		总文件数
fcur	String		当前文件数
message	String			[0] success
code	Number			0
total	Number			100

3-2 作业任务 删除

SDK方法名：deleteTimingWork

URL

/timing/work

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
work_uuids	Array		作业任务uuid

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
ret	Number			200
data	Object
code	Number			11110001
message	String
fail_list	Array
code	Number			11110001
message	String			[-1] 离线
work_uuid	String			@guid
work_name	String			test1
success_list	Array
code	Number			11110001
message	String			[0] success
work_uuid	String			@guid
work_name	String			test2