定时任务
定时任务
SDK类名:/timing/TimingBackup;
------ 备份 ------
URL
/dash/timing/backup
Method
GET
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
1-1 备份 准备-4 备份 获取MsSql数据源
SDK方法名:describeTimingBackupMssqlSource;
URL
/timing/backup/mssql_source
Method
GET
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
wk_uuid | String | 否 | 22D03E06-94D0-5E2C-336E-4BEEC2D28EC4 | 工作机节点uuid |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
data | Object | 否 | |||
data_source | String | 否 | sql | @mock=sql | |
code | Number | 否 | 0 | @mock=0 | |
message | String | 否 | [0] success | @mock=[0] success | |
msg | String | 否 | @mock= | ||
ret | Number | 否 | 200 | @mock=200 |
1-1 备份 准备-1 备份/恢复 认证Oracle信息(目前未使用)
SDK方法名:verifyTimingBackupOracleInfo
URL
/timing/backup/verify_oracle_info
Method
POST
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
oracle_settings | Object | 否 | oracle 设置(基本设置) | ||
ora_sid_name | String | 否 | Oracle数据库实例名 | ||
ora_port | Number | 否 | 1 | 【隐藏】Oracle监听端口 | |
ora_home_path | String | 否 | Oracle数据库Home目录 | ||
ora_passwd | String | 否 | Info1234 | 【隐藏】Oracle SYS用户密码 | |
wk_uuid | String | 否 | 67E33CDB-D75B-15B3-367D-50C764F5A26F | 节点uuid |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
data | Object | 否 | |||
oracle_info | String | 否 | @mock= | ||
code | Number | 否 | 0 | @mock=0 | |
message | String | 否 | [0] success | @mock=[0] success | |
msg | String | 否 | @mock= | ||
ret | Number | 否 | 200 | @mock=200 |
1-1 备份 准备-2 备份/恢复 获取Oracle表空间(目前未使用)
SDK方法名:describeTimingBackupOracleContent
URL
/timing/backup/oracle_content
Method
POST
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
oracle_settings | Object | 否 | oracle 设置(基本设置) | ||
ora_passwd | String | 否 | Info1234 | 【隐藏】Oracle SYS用户密码 | |
ora_port | Number | 否 | 1 | 【隐藏】Oracle监听端口 | |
ora_sid_name | String | 否 | Oracle数据库实例名 | ||
ora_content_type | Number | 否 | 0 | 0:整库;1:表空间;2:数据文件; | |
wk_uuid | String | 否 | 67E33CDB-D75B-15B3-367D-50C764F5A26F | 节点uuid |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 否 | 200 | @mock=200 | |
data | Object | 否 | |||
code | Number | 否 | 0 | @mock=0 | |
message | String | 否 | [0] success | @mock=[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规则 |
---|---|---|---|---|---|
wk_uuid | String | 否 | 67E33CDB-D75B-15B3-367D-50C764F5A26F | 工作机节点uuid |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 否 | 200 | @mock=200 | |
msg | String | 否 | @mock= | ||
data | Object | 否 | |||
code | Number | 否 | 0 | @mock=0 | |
message | String | 否 | [0] success | @mock=[0] success | |
script_path | String | 否 | @mock= |
1-1 备份 准备-5 备份 获取MsSql数据库列表
SDK方法名:listTimingBackupMssqlDbList
URL
/timing/backup/mssql_db_list
Method
POST
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
wk_uuid | String | 否 | 67E33CDB-D75B-15B3-367D-50C764F5A26F | 工作机节点uuid | |
mssql_settings | Object | 否 | |||
win_verify | Number | 否 | 0 | 登录SQL Server服务器的信息:0:用mssql用户名密码;1:用winNT集成设置; | |
instance_name | String | 否 | MSSQLSERVER | sql server 实例名,默认是MSSQLSERVER | |
user_id | String | 否 | sa | sql server 用户名,用winNT集成设置不填 | |
pass_word | String | 否 | 123456 | sql server 密码,用winNT集成设置不填 | |
data_source | String | 否 | WIN-EGKN86NF3PM | [BK] 数据源名称 | |
port | String | 当网络协议类型为TCP/IP时,默认值1433 | |||
protocol | Number | 0:shared memory,1:TCP/IP,默认值 0 |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 否 | 200 | @mock=200 | |
data | Object | 否 | |||
code | Number | 否 | 0 | @mock=0 | |
message | String | 否 | [0] success | @mock=[0] success | |
mssql_db_list | Array | 否 | ['master','tempdb','model','msdb','ReportServer','ReportServerTempDB','test'] | @mock=$order('master','tempdb','model','msdb','ReportServer','ReportServerTempDB','test') | +1 |
msg | String | 否 | @mock= |
备份 准备 验证oracle登陆认证
SDK方法名:verifyTimingBackupOracleLogin;
URL
/timing/backup/oracle_login
Method
POST
Request
名称 | 类型 | 必选 | 初始值 | 简介 | 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规则 |
---|---|---|---|---|---|
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规则 |
---|---|---|---|---|---|
timing_backup | Object | 否 | |||
mirr_sync_attr | Number | 否 | 1 | 文件安全属性,0:不同步;1:同步; | |
mirr_file_check | Number | 0 | 校验方式, 0: 严格校验, 1: 时间校验 | ||
oracle_settings | Object | 否 | oracle 设置(基本设置) | ||
ora_sid_name | String | 否 | Oracle数据库实例名 | ||
ora_content_type | Number | 否 | 0 | 备份内容:0:整库;1:表空间;2:数据文件;3:PDBS;4:CDB;5:ARCHIVELOG;6:CONTROLFILE;7:SPFILE;8:TABLE; | |
ora_pdbs_name | String | 否 | PDB,ora_content_type 为 PDBS 时必传,内容为逗号分隔的PDB名称 | ||
ora_use_script | Number | 否 | 0 | [BK] 使用脚本 | |
ora_port | Number | 否 | 1 | 【隐藏】Oracle监听端口 | |
ora_script_path | String | 否 | [BK] 脚本路径 | ||
ora_passwd | String | 否 | Info1234 | 【隐藏】Oracle SYS用户密码 | |
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 | 日志序列号 | |||
wk_data_type | Number | 否 | 1 | 源类型: 0:块设备; 1:文件; 3:oracle; 4:mssql; 9:MySQL; 12:高斯db; 13: informix; 14: 复制卷; | |
task_name | String | 否 | testTiming | 任务名 | |
backup_type | Number | 否 | 0 | 备份策略里非全备的备份类型,0:全备(没策略或策略只有全备);1:增量(策略中存在增量);2:差异(策略中存在); | |
del_policy | Number | 否 | 0 | 删除策略,0:不开启;1:开启; | |
mirr_sync_flag | Number | 否 | 0 | 错误处理方式,0:出错停止;1:出错继续; | |
snap_type | Number | 否 | 0 | 源端快照类型,0:none,1:vss | |
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 | 否 | 0 | 表空间选项,备份集大小(KB) | |
rman_set_limit_arch_flag | Number | 否 | 0 | 归档选项,指定最高限额 | |
rman_skip_readonly | Number | 否 | 0 | 表空间选项,跳过脱机数据文件 | |
rman_maxsetsize_arch | Number | 否 | 0 | 归档选项,备份集大小(KB) | |
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 | 目标类型,1:文件;2:raw数据;10:备份快照; 11: 合成备份 | |
compress | Number | 否 | 0 | 压缩,0关;1:低;2:中;3:高; | |
encrypt_switch | Number | 否 | 0 | 是否加密,0:不开启;1:开启; | |
encrypt | Number | 1 | 加密类型 1:aes, 2:sm4 | ||
secret_key | String | 否 | 密钥 | ||
bk_path | Array | 否 | ["E:\t\"] | 备份路径 | |
blk_direct_copy | Number | 否 | 0 | 块设备,1:直接拷贝; | |
mirr_open_type | Number | 否 | 0 | 文件打开方式,0:普通文件;1:自动选择;2:MFT; | |
mssql_settings | Object | 否 | mssql 设置(基本设置) | ||
instance_name | String | 否 | MSSQLSERVER | sql server 实例名,默认是MSSQLSERVER | |
win_verify | Number | 否 | 1 | 登录SQL Server服务器的信息:0:用mssql用户名密码;1:用winNT集成设置; | |
user_id | String | 否 | sql server 用户名,用winNT集成设置不填 | ||
pass_word | String | 否 | sql server 密码,用winNT集成设置不填 | ||
time_out | String | 否 | 连接超时设定(秒): | ||
data_source | String | 否 | [BK] 数据源名称 | ||
port | String | 当网络协议类型为TCP/IP时,默认值1433 | |||
protocol | Number | 0:shared memory,1:TCP/IP,默认值 0 | |||
db_info | Array | 库信息,同时用来存放子任务信息 | |||
db_name | String | [BK] 备份数据库名称 | |||
check_out | Number | 1 | 开启校验功能:0关1开 | ||
wk_uuid | String | 否 | 67E33CDB-D75B-15B3-367D-50C764F5A26F | @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机节点uuid | |
bk_uuid | String | 否 | B8566905-411E-B2CD-A742-77B1346D8E84 | @mock=@pick(["kevin", "Jane", "Grey"]), 备机节点uuid | |
bkup_policy | Number | 否 | 2 | 备份策略,2 立即,0 定时,1 循环; | |
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 | 否 | 2 | 0:每天;1:每周:2:每月;3:每隔 | |
sched_time | Array | 否 | @time('HH:mm') | 哪几点 | |
sched_gap_min | Number | 否 | @integer(1, 64) | 间隔分钟数 | |
backup_type | Number | 否 | 备份类型,0:全备/数据备份;1:增量/日志备份;2:差异; | ||
task_type | Number | 否 | 0 | 任务类型:备份任务:0;还原任务:1;备份任务模板:10; | |
file_check_dir | String | 否 | 校验目录 | ||
random_str | String | 否 | 11111111-1111-1111-1111-111111111111 | 新建不传 | |
file_check_switch | Number | 否 | 0 | 文件校验开关,0关1开; | |
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 | 0 | 备端数据加密,1是,0否;默认为0 | ||
bk_crypt_type | Number | 1 | 备端数据加密类型: 1:aes, 2:sm4 | ||
bk_crypt_key | String | '' | 备端数据加密,密钥 | ||
mysql_settings | Object | mysql基本设置 | |||
pool_uuid | String | 存储池uuid | |||
pool_name | String | 存储池名称 | |||
volume_uuid | String | 复制卷uuid | |||
volume_name | String | 复制卷名称 | |||
attach_point | String | 挂载点 | |||
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 | 配置文件路径 | ||
archive_pen | Number | 0 | 是否开启备份归档:0否了是 | ||
tape_uuid | String | E8566905-411E-B2CD-A742-77B1346D8E84 | 磁带库uuid | ||
library_sn | String | SYZZY_A | 磁带序列号 | ||
db_name | String | 备份数据库名称(gauss集群) | |||
content_type | Number | 备份内容类型(gauss集群),0 整库 1 表 | |||
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 | 并行任务数 | ||
timeout | Number | 否 | 超时时间,超过这个时间还没备完则产生告警, 默认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 | Number | 开启LAN-FREE开关 |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
msg | String | 否 | @mock= | ||
ret | Number | 否 | 200 | @mock=200 | |
data | Object | 否 | |||
code | Number | 否 | 0 | @mock=0 | |
message | String | 否 | [0] success | @mock=[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规则 |
---|
Response
名称 | 类型 | 必选 | 初始值 | 简介 | 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 | |||
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 | 任务类型:备份任务:0;还原任务:1;备份任务模板:10; | |
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规则 |
---|---|---|---|---|---|
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 | 任务类型:备份任务:0;还原任务:1;备份任务模板:10; | |
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 |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
msg | String | 否 | @mock= | ||
ret | Number | 否 | 200 | @mock=200 | |
data | Object | 否 | |||
message | String | 否 | [0] success | @mock=[0] success | |
code | Number | 否 | 0 | @mock=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规则 |
---|---|---|---|---|---|
search_field | String | 否 | , 可选,搜索字段 | ||
limit | Number | 否 | 10 | , 可选,不传就是全部 | |
page | Number | 否 | 1 | , 可选,不传就是全部 | |
search_value | String | 否 | , 可选,搜索字段对应值(可以模糊) | ||
type | Number | 否 | 0 | 任务类型:备份任务:0;还原任务:1;备份任务模板:10; | |
where_args[timing_type] | Number | 否 | 0 - 普通定时任务 1 - 集群[RAC] |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
msg | String | 否 | |||
data | Object | 否 | |||
info_list | Array | 否 | |||
oracle_settings | Object | 否 | ORACLE配置信息 | ||
ora_sid_name | String | 否 | Oracle数据库实例名 | ||
ora_content_type | Number | 否 | 0 | 备份内容: 0:整库: 1:表空间: 2:数据文件: 3:PDBS: 4:CDB: 5:ARCHIVELOG: 6:CONTROLFILE: 7:SPFILE: 8:TABLE; | |
ora_use_script | Number | 否 | 0 | [BK] 使用脚本 | |
ora_port | Number | 否 | 1 | 【隐藏】Oracle监听端口 | |
ora_script_path | String | 否 | [BK] 脚本路径 | ||
ora_passwd | String | 否 | Info1234 | 【隐藏】Oracle SYS用户密码 | |
ora_home_path | String | 否 | Oracle数据库Home目录 | ||
wk_data_type | Number | 否 | 9 | 源类型: 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; | |
task_name | String | 否 | 规则名称 | ||
backup_type | Number | 否 | 1 | 规则类型: 0:备份; 10:备份模板; | |
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 | 否 | 0 | 表空间选项,备份集大小(KB) | |
rman_set_limit_arch_flag | Number | 否 | 0 | 归档选项,指定最高限额 | |
rman_skip_readonly | Number | 否 | 0 | 表空间选项,跳过脱机数据文件 | |
rman_maxsetsize_arch | Number | 否 | 0 | 归档选项,备份集大小(KB) | |
rman_cold_bkup | Number | 否 | 0 | 表空间选项,离线(冷)数据库备份 | |
rman_filespertset_df | Number | 否 | 20 | 表空间选项,每个备份集文件数 | |
bk_data_type | Number | 否 | 1 | 目标类型: 1:文件; 2:raw; 10:备份快照; 11:合成备份; | |
mssql_settings | Object | 否 | MSSQL配置信息 | ||
instance_name | String | 否 | sql server 实例名,默认是MSSQLSERVER | ||
time_out | String | 否 | 2 | 连接超时设定(秒): | |
data_source | String | 否 | [BK] 数据源名称 | ||
dbsize | String | 否 | |||
win_verify | Number | 否 | 0 | 登录SQL Server服务器的信息:0:用mssql用户名密码;1:用winNT集成设置; | |
user_id | String | 否 | sql server 用户名,用winNT集成设置不填 | ||
db_info | Array | 否 | 库信息,同时用来存放子任务信息 | ||
task_uuid | String | 子规则uuid | |||
db_name | String | [BK] 备份数据库名称 | |||
pass_word | String | 否 | sql server 密码,用winNT集成设置不填 | ||
wk_uuid | String | 否 | 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 | 工作机uuid | |
bk_uuid | String | 否 | Grey | 灾备机uuid | |
bkup_policy | Number | 否 | 0 | 策略类型: 0:一次性; 1:周期; 2:立即执行; | |
bkup_schedule | Array | 否 | |||
limit | Number | 否 | 50 | 数据保留期限(天) | |
sched_day | Number | 否 | 24 | 哪几天 | |
sched_every | Number | 否 | 2 | 周期策略: 0:每天; 1:每周: 2:每月; 3:每隔 | |
sched_time | String | 否 | 17:16 | 哪几点 | |
sched_gap_min | Number | 否 | 41 | 间隔分钟数 | |
task_type | Number | 否 | 0 | 规则类型: 0:备份; 10:备份模板; | |
can_op | Number | 1 | 是否可操作: 0:否; 1:是; | ||
can_up | Number | 1 | 是否可更新: 0:否; 1:是; | ||
can_del | Number | 1 | 是否可删除: 0:否; 1:是; | ||
task_uuid | String | 38FFA6E2-2A40-31D6-7A94-E8168EBA9FF2 | 规则uuid | ||
last_result | Object | 上次执行结果 | |||
backup_type | String | o | 备份类型: o:全量; i:增量; d:差异; | ||
end_time | String | 2020-09-14 19:00:00 | 结束时间 | ||
result | String | 0 | 结果: 0:成功; 小于0:失败; | ||
last_success_result | Object | ||||
backup_type | String | o | 备份类型: o:全量; i:增量; d:差异; | ||
end_time | String | 2020-09-14 19:00:00 | 结束时间 | ||
result | String | 0 | 结果: 0:成功; 小于0:失败; | ||
archive_pen | Number | 是否开启磁带库归档: 0:否; 1:是; | |||
tape_uuid | String | 带库uuid | |||
library_sn | String | 带库序列号 | |||
tape_node_uuid | String | 磁带库关联节点uuid | |||
group_uuid | String | 组uuid(mssql多库) | |||
is_group | Number | 0 | 多库备份 - 是否组规则: 0:否; 1:是; | ||
children | Array | 子任务列表 | |||
message | String | 否 | [0] success | ||
code | Number | 否 | 0 | ||
ret | Number | 否 | 200 |
1-3 备份 列表-2 备份 状态
SDK方法名:listTimingBackupStatus
URL
/timing/backup/status
Method
GET
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
task_uuids | Array | 否 | ["11111111-1111-1111-1111-111111111111"] | 必传,uuid数组,页面加载第一次获取状态一个一个获取,之后是批量获取; (不论组还是子,都传task_uuid) |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
msg | String | 否 | @mock= | ||
data | Object | 否 | |||
code | Number | 否 | 0 | @mock=0 | |
message | String | 否 | [0] success | @mock=[0] success | |
count | Number | 否 | 0 | @mock=0 | |
status | Array | 否 | |||
status | String | 否 | MIRROR | 状态文字: UNKNOWN:未知; FINISH:完成; STOP:停止; PENDING:等待; MIRROR:镜像; CALC:计算; PREPARING:准备; | |
progress | Number | 否 | 0 | @mock=0, 进度 | |
total | Number | 否 | 100 | @mock=100, 总大小 | |
cur | Number | 否 | , 当前大小 | ||
f_cur | Number | 否 | , 当前文件数 | ||
task_uuid | String | 否 | 38FFA6E2-2A40-31D6-7A94-E8168EBA9FF2 | @mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 任务UUID | |
f_total | Number | 否 | 0 | @mock=0, 文件总数 | |
ret | Number | 否 | 200 | @mock=200 |
1-3 备份 列表-3 备份 删除
SDK方法名:deleteTimingBackup
URL
/timing/backup
Method
DELETE
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
task_uuids | Array | 否 | ["11111111-1111-1111-1111-111111111111"] | *规则数组 | |
del_policy | Number | 否 | *删除策略,0:不开启;1:开启; | ||
force | Number | 1 - 强制删除 0 - 非强制删除 |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | 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规则 |
---|---|---|---|---|---|
operate | String | 否 | start | start, stop, start_immediately | |
task_uuids | Array | 否 | ["11111111-1111-1111-1111-111111111111"] | 必传,规则数组 | |
bk_type | Number | 否 | 立即执行操作(start_immediately)必传,取值为,备份策略 - 周期任务 - 备份方式;0:全备,1:增量,2:差异 |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
data | Object | 否 | |||
code | Number | 否 | 0 | @mock=0 | |
message | String | 否 | [0] success | @mock=[0] success | |
success_list | Array | ||||
fail_list | Array | ||||
task_uuid | String | ||||
code | String | ||||
message | String | ||||
task_name | String | ||||
msg | String | 否 | @mock= | ||
ret | Number | 否 | 200 | @mock=200 |
------ 还原 ------
URL
/dash/timing/recovery
Method
GET
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
2-1 恢复 准备-2 恢复 获取还原时间点 - Mssql
SDK类名:/timing/TimingRecovery;
SDK方法名:listTimingRecoveryMssqlTime
URL
/timing/recovery/rc_mssql_time
Method
GET
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
bk_uuid | String | 否 | B8566905-411E-B2CD-A742-77B1346D8E84 | , 备机节点uuid | |
rc_data_path | String | 否 | E:\mssqlBK\ts-11111111-1111-1111-1111-111111111111\ | , 备份数据路径 |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
msg | String | 否 | @mock= | ||
ret | Number | 否 | 200 | @mock=200 | |
data | Object | 否 | |||
mssql_time_list | Array | 否 | |||
code | Number | 否 | 0 | @mock=0 | |
message | String | 否 | [0] success | @mock=[0] success |
2-1 恢复 准备-3 恢复 获取Mssql初始信息
SDK方法名:describeTimingRecoveryMssqlInitInfo
URL
/timing/recovery/rc_mssql_init_info
Method
GET
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
bk_uuid | String | 否 | B8566905-411E-B2CD-A742-77B1346D8E84 | 备机节点uuid | |
rc_point_in_time | String | 否 | 2017-12-21_13-16-53 | 还原时间点 rawfile | |
rc_data_path | String | 否 | 备份数据路径 |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 否 | 200 | ||
data | Object | 否 | |||
message | String | 否 | [0] success | ||
mssql_init_info | Object | 否 | |||
src_db_name | String | 否 | 141414 | [RC] 原数据库名称 | |
db_size | String | 否 | 12 | [RC] 数据库大小 | |
user_id | String | 否 | |||
instance_name | String | 否 | |||
win_verify | String | 否 | |||
tab_num | String | 否 | |||
tab_info | String | 否 | |||
ln_num | String | 否 | |||
check_out | String | 否 | |||
lgc_name | String | 否 | test*test_log | [RC] 原数据库逻辑名(多行以*隔开,与lgc_path一一对应) | |
lgc_path | String | 否 | 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 | [RC] 原数据库文件路径(多行以*隔开,与lgc_name一一对应) | |
lgc_num | Number | 否 | 2 | [RC] lgc_name 、lgc_path 的行数 | |
code | Number | 否 | 0 | ||
msg | String | 否 |
2-1 恢复 准备-1 恢复 获取还原时间点 - 文件
SDK方法名:listTimingRecoveryPathList
URL
/timing/recovery/rc_path_list
Method
GET
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
bk_uuid | String | 否 | B8566905-411E-B2CD-A742-77B1346D8E84 | 备机节点uuid | |
rc_data_path | String | 否 | C:\back\ | 备份数据路径 | |
backup_task_uuid | String | 否 | 11111111-1111-1111-1111-111111111111 | [RC] 备份的uuid,用来即时恢复,可选参数 |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | 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 | 否 | 13 | 源类型,0:块设备;1:文件;3:oracle;4:mssql; | |
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 | 目标类型,1:文件;2:raw数据; | |
bk_path | Array | 否 | F:\e\2018-01-02_10-54-42\E | 备份路径 | |
res_by_path | String | ||||
volume_uuid | String | B8566905-411E-B2CD-A742-77B1346D8E85 | 文件还原,复制卷uuid | ||
msg | String | 否 |
2-1 恢复 准备-4 恢复 认证MsSql数据库
SDK方法名:verifyTimingRecoveryMssqlInfo
URL
/timing/recovery/rc_verify_mssql_info
Method
POST
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
mssql_settings | Object | 否 | , mssql 设置(基本设置) | ||
win_verify | Number | 否 | 0 | @mock=0, 登录SQL Server服务器的信息:0:用mssql用户名密码;1:用winNT集成设置; | |
pass_word | String | 否 | 123456 | , sql server 密码,用winNT集成设置不填 | |
instance_name | String | 否 | MSSQLSERVER | , sql server 实例名,默认是MSSQLSERVER | |
user_id | String | 否 | sa | , sql server 用户名,用winNT集成设置不填 | |
data_source | String | 主机名 | |||
port | String | 当网络协议类型为TCP/IP时,默认值1433 | |||
protocol | Number | 0:shared memory,1:TCP/IP,默认值 0 | |||
wk_uuid | String | 否 | 67E33CDB-D75B-15B3-367D-50C764F5A26F | @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 还原目标端id |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
data | Object | 否 | |||
message | String | 否 | [0] success | @mock=[0] success | |
code | Number | 否 | 0 | @mock=0 | |
msg | String | 否 | @mock= | ||
ret | Number | 否 | 200 | @mock=200 |
恢复 准备 获取oracle恢复点日志
SDK方法名:listTimingRecoveryOracleRcPointInfo;
URL
/timing/recovery/rc_sbt
Method
GET
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
page | Number | 否 | 第几页 | ||
limit | Number | 否 | 每页记录数 | ||
bk_uuid | String | 否 | |||
bk_path | String | 否 |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | 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规则 |
---|---|---|---|---|---|
bk_uuid | String | B8566905-411E-B2CD-A742-77B1346D8E84 | |||
rc_data_path | String | E:\mssqlBK\ts-11111111-1111-1111-1111-111111111111\ |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | 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规则 |
---|---|---|---|---|---|
rc_data_path | String | ||||
ora_content_type | Number | 还原的选项,6:控制文件,7:参数文件 | |||
bk_uuid | String |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | 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规则 |
---|---|---|---|---|---|
file_name | String | 所选择的文件名称 | |||
bk_uuid | String |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | 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规则 |
---|---|---|---|---|---|
timing_recovery | Object | 否 | |||
task_name | String | 否 | task | 任务名 | |
backup_task_uuid | String | 否 | [RC] 备份的uuid,用来即时恢复 | ||
backup_type | Number | 否 | 0 | [RC] 还原方式(文件还原用),0:全备;1:增量;2:差异; | |
bk_data_type | Number | 否 | 1 | 备机目录类型,1:文件;2:raw数据; | |
bk_uuid | String | 否 | B8566905-411E-B2CD-A742-77B1346D8E84 | 备机节点uuid | |
bk_path | Array | 否 | ["E:\t\2019-01-15_15-49-00\E\test\"] | 备机路径(在复制规则目标节点上),数据库还原不传 | |
wk_data_type | Number | 否 | 1 | 工作机目录类型,0:块设备;1:文件;3:oracle;4:mssql;6:db2; | |
wk_uuid | String | 否 | 67E33CDB-D75B-15B3-367D-50C764F5A26F | 工作机节点uuid | |
rc_style | Number | 否 | 1 | [RC] 恢复方式 blk_recovery_style,0:恢复到工作机;1:在备机合到指定目录; | |
wk_path | Array | 否 | ["E:\test\"] | [RC] 新数据库文件存放路径,也是“在备机合到指定目录”的目录。旧版:db_file_save_path | |
excl_path | Array | 否 | 排除路径数组 | ||
rc_point_in_time | String | 否 | 2019-01-15_15-49-00 | [RC] 还原时间点 rawfile | |
rc_data_path | String | 否 | E:\t\ | [RC] 备份数据路径 | |
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 | 否 | 1 | 【隐藏】Oracle监听端口 | |
ora_passwd | String | 否 | Info1234 | 【隐藏】Oracle SYS用户密码 | |
ora_sid_name | String | 否 | Oracle数据库实例名 | ||
ora_home_path | String | 否 | Oracle数据库Home目录 | ||
ora_content_type | Number | 否 | 0 | 备份内容: 0:整库; 1:表空间; 2:数据文件; 3:PDBS; 4:CDB; 5:ARCHIVELOG; 6:CONTROLFILE; 7:SPFILE; 8:TABLE; | |
ora_do_restore | Number | 否 | 0 | [RC] 还原(还原选项): 0:否; 1:是; | |
ora_rst_limit_thread | Number | 否 | 1 | [RC] 还原到备份:线程 | |
ora_rst_type | Number | 否 | 0 | [RC] 还原类型: 0:到最新; 1:到指定; | |
ora_rst_recory_point | Number | 否 | [RC] 还原: 0:日志还原点选择 ; 1:时间/SCN还原点选择; | ||
ora_rst_limit_type | Number | 否 | 0 | [RC] 还原到备份 类型: 0:日期; 1:SCN; 2:日志序列号; | |
ora_rst_limit_date | String | 否 | 2017-12-21 13:26:00 | [RC] 还原到备份:日期 | |
ora_rst_limit_scn | Number | 否 | 0 | [RC] 还原到备份:SCN | |
ora_rst_limit_log_seq | String | 否 | [RC] 还原到备份:日志序列号 | ||
ora_rst_record | Object | 否 | [RC] 还原:已选恢复点日志信息 | ||
ora_do_recovery | Number | 否 | 0 | [RC] 恢复(还原选项): 0:否; 1:是; | |
ora_rc_point_thread | Number | 否 | 1 | [RC] 恢复到备份:线程 | |
ora_rc_type | Number | 否 | 0 | [RC] 恢复类型: 0:到最新; 1:到指定; | |
ora_rc_recory_point | Number | 否 | [RC] 恢复: 0:日志还原点选择; 1:时间/SCN还原点选择 | ||
ora_rc_point_type | Number | 否 | 0 | [RC] 恢复到备份 类型: 0:日期; 1:SCN; 2:日志序列号; | |
ora_rc_point_date | String | 否 | 2017-12-21 13:26:00 | [RC] 恢复到备份:日期 | |
ora_rc_point_scn | Number | 否 | 0 | [RC] 恢复到备份:SCN | |
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_type | Number | 否 | 归档日志还原类型,0:到最新;1:到指定; | ||
ora_rst_arch_limit_type | Number | 否 | 归档日志还原到指定备份 类型,2: 日志序列号; | ||
ora_rst_arch_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 | 数据库模式 0:CDB模式; 1:CDBRoots模式; 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 | 辅助实例存放路径 | |||
mssql_settings | Object | 否 | mssql 设置(基本设置) | ||
instance_name | String | 否 | sql server 实例名,默认是MSSQLSERVER | ||
win_verify | Number | 否 | 0 | 登录SQL Server服务器的信息:0:用mssql用户名密码;1:用winNT集成设置; | |
user_id | String | 否 | sql server 用户名,用winNT集成设置不填 | ||
pass_word | String | 否 | sql server 密码,用winNT集成设置不填 | ||
time_out | String | 否 | 连接超时设定(秒): | ||
data_source | String | 数据源名称 | |||
port | String | 当网络协议类型为TCP/IP时,默认值1433 | |||
protocol | Number | 0:shared memory,1:TCP/IP,默认值 0 | |||
db_info | Array | 库信息,同时用来存放子任务信息 | |||
src_db_name | String | [RC] 原数据库名称 | |||
db_name | String | ||||
lgc_infos | Array | ||||
lgc_name | String | test | [RC] 原数据库逻辑名 | ||
lgc_path | String | C:\Program Files\Microsoft SQL Server\MSSQL12.MSSQLSERVER\MSSQL\DATA\test.mdf | [RC] 原数据库文件路径 | ||
rc_point_in_time | String | 2019-01-15_15-49-00 | [RC] 还原时间点 rawfile | ||
new_db_name | String | [RC] 目标数据库名称 | |||
db_file_save_path | String | [RC] 目标数据库文件存放路径 | |||
check_out | String | 0 | 是否开启还原完成后校验: 0:关; 1:开; | ||
db_size | String | [RC] 数据库大小 | |||
tab_num | String | [RC] 数据库表个数 | |||
tab_info | String | [RC] 数据库表名 | |||
ln_num | String | [RC] 数据库表行数 | |||
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_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 | ||||
oracle_rman_settings | Object | ||||
rman_num_streams_df | Number | [RC] 并行流数 | |||
synthetic_bkup_settings | Object | 合成备份参数 | |||
mount_dir | String | 挂载点 | |||
db_name | String | (GAUSS集群)数据库名称 | |||
content_type | Number | 0 | (gauss集群),0 整库 1 表 | ||
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 | 0 | Mysql、Oracle合成备份: 是否开启数据回传: 0:关; 1:开; 默认值为0; | ||
data_dir | String | '' | 数据回传目录 | ||
force | Boolean | 否 |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
data | Object | 否 | |||
code | Number | 否 | 0 | @mock=0 | |
message | String | 否 | [0] success | @mock=[0] success | |
msg | String | 否 | @mock= | ||
ret | Number | 否 | 200 | @mock=200 |
2-2 恢复 新建/编辑-3 恢复 修改
SDK方法名:modifyTimingRecovery
URL
/timing/recovery/:uuid([A-F0-9-]+)
Method
PUT
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
timing_recovery | Object | 否 | |||
wk_uuid | String | 否 | 7AD64D7A-7D1D-AC51-5DF1-29A58345A288 | @mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 工作机节点uuid | |
task_name | String | 否 | task | @mock=task, 任务名 | |
random_str | String | 否 | 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 | @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 用于防止并发修改的随机串 | |
wk_path | Array | 否 | , [RC] 新数据库文件存放路径 db_file_save_path | ||
bk_data_type | Number | 否 | 1 | @mock=1, 备机目录类型,1:文件;2:raw数据; | |
bk_path | Array | 否 | , 备机路径(在复制规则目标节点上),数据库还原不传 | ||
backup_type | Number | 否 | 0 | @mock=0, [RC] 还原方式,0:全备;1:增量;2:差异; | |
oracle_settings | Object | 否 | , oracle 设置(基本设置) | ||
ora_rc_point_thread | Number | 否 | 1 | @mock=1, [RC] 恢复到备份 线程 | |
ora_rc_point_date | String | 否 | 2017-12-21 13:26:00 | @mock=2017-12-21 13:26:00, [RC] 恢复到备份 日期 | |
ora_passwd | String | 否 | Info1234 | @mock=Info1234, 【隐藏】Oracle SYS用户密码 | |
ora_port | Number | 否 | 1 | @mock=1, 【隐藏】Oracle监听端口 | |
ora_rc_point_type | Number | 否 | 0 | @mock=0, [RC] 恢复到备份 类型,0:日期;1:SCN;2:日志序列号; | |
ora_do_recovery | Number | 否 | 0 | @mock=0, [RC] 恢复(还原选项),0:否;1:是; | |
ora_do_restore | Number | 否 | 0 | @mock=0, [RC] 还原(还原选项),0:否;1:是; | |
ora_home_path | String | 否 | @mock=, Oracle数据库Home目录 | ||
ora_rst_type | Number | 否 | 0 | @mock=0, [RC] 还原类型,0:到最新;1:到指定; | |
ora_rst_limit_type | Number | 否 | 0 | @mock=0, [RC] 还原到备份 类型,0:日期;1:SCN;2:日志序列号; | |
ora_sid_name | String | 否 | @mock=, Oracle数据库实例名 | ||
ora_rst_limit_thread | Number | 否 | 1 | @mock=1, [RC] 还原到备份 线程 | |
ora_rst_limit_date | String | 否 | 2017-12-21 13:26:00 | @mock=2017-12-21 13:26:00, [RC] 还原到备份 日期 | |
ora_content_type | Number | 否 | 0 | @mock=0, 0:整库;1:表空间;2:数据文件; | |
ora_rst_limit_log_seq | String | 否 | @mock=, [RC] 还原到备份 日志序列号 | ||
ora_rst_limit_scn | Number | 否 | 0 | @mock=0, [RC] 还原到备份 SCN | |
ora_rc_type | Number | 否 | 0 | @mock=0, [RC] 恢复类型,0:到最新;1:到指定; | |
ora_rc_point_log_seq | String | 否 | @mock=, [RC] 恢复到备份 日志序列号 | ||
ora_rc_point_scn | Number | 否 | 0 | @mock=0, [RC] 恢复到备份 SCN | |
bk_uuid | String | 否 | 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 | @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机节点uuid | |
task_uuid | String | 否 | 7AD64D7A-7D1D-AC51-5DF1-29A58345A288 | @mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 任务id,如果节点和规则id都不传,则全部 | |
backup_task_uuid | String | 否 | @mock=, [RC] 备份的uuid,用来即时恢复 | ||
mssql_settings | Object | 否 | , mssql 设置(基本设置) | ||
win_verify | Number | 否 | 0 | @mock=0, 登录SQL Server服务器的信息:0:用mssql用户名密码;1:用winNT集成设置; | |
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 | 否 | C:\back\ | @mock=C:\back\, [RC] 备份数据路径 | |
rc_style | Number | 否 | 1 | @mock=1, [RC] 恢复方式 blk_recovery_style,0:恢复到工作机;1:在备机合到指定目录; | |
wk_data_type | Number | 否 | 0 | @mock=0, 工作机目录类型,0:块设备;1:文件;3:oracle;4:mssql; | |
rc_point_in_time | String | 否 | 2017-12-21_13-16-53 | @mock=2017-12-21_13-16-53, [RC] 还原时间点 rawfile | |
excl_path | Array | 否 | |||
data_ip_uuid | String | 7AD64D7A-7D1D-AC51-5DF1-29A58345A288 | 灾备机数据地址 | ||
res_by_path | String | '' | |||
data_return | Number | 0 | |||
data_dir | String | '' | |||
force | Boolean | 否 |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
msg | String | 否 | @mock= | ||
data | Object | 否 | |||
code | Number | 否 | 0 | @mock=0 | |
message | String | 否 | [0] success | @mock=[0] success | |
ret | Number | 否 | 200 | @mock=200 |
2-2 恢复 新建/编辑-2 恢复 获取单个
SDK方法名:describeTimingRecovery
URL
/timing/recovery/:uuid([A-F0-9-]+)
Method
GET
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
msg | String | 否 | @mock= | ||
ret | Number | 否 | 200 | @mock=200 | |
data | Object | 否 | |||
timing_recovery | Object | 否 | |||
wk_data_type | Number | 否 | 3 | @mock=0, 工作机目录类型,0:块设备;1:文件;3:oracle;4:mssql;9: mysql; | |
backup_type | Number | 否 | 0 | @mock=0, [RC] 还原方式,0:全备;1:增量;2:差异; | |
task_uuid | String | 否 | 7AD64D7A-7D1D-AC51-5DF1-29A58345A288 | @mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 任务id,如果节点和规则id都不传,则全部 | |
backup_task_uuid | String | 否 | @mock=, [RC] 备份的uuid,用来即时恢复 | ||
wk_uuid | String | 否 | 7AD64D7A-7D1D-AC51-5DF1-29A58345A288 | @mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 工作机节点uuid | |
bk_data_type | Number | 否 | 10 | @mock=1, 备机目录类型,1:文件;2:raw数据;10: 快照 | |
rc_data_path | String | 否 | C:\back\ | @mock=C:\back\, [RC] 备份数据路径 | |
task_name | String | 否 | task | @mock=task, 任务名 | |
oracle_settings | Object | 否 | , oracle 设置(基本设置) | ||
ora_rc_point_thread | Number | 否 | 1 | @mock=1, [RC] 恢复到备份 线程 | |
ora_rst_limit_date | String | 否 | 2017-12-21 13:26:00 | @mock=2017-12-21 13:26:00, [RC] 还原到备份 日期 | |
ora_content_type | Number | 否 | 0 | @mock=0, 0:整库;1:表空间;2:数据文件; | |
ora_do_recovery | Number | 否 | 0 | @mock=0, [RC] 恢复(还原选项),0:否;1:是; | |
ora_sid_name | String | 否 | @mock=, Oracle数据库实例名 | ||
ora_rst_limit_thread | Number | 否 | 1 | @mock=1, [RC] 还原到备份 线程 | |
ora_rst_limit_type | Number | 否 | 0 | @mock=0, [RC] 还原到备份 类型,0:日期;1:SCN;2:日志序列号; | |
ora_rc_type | Number | 否 | 1 | @mock=0, [RC] 恢复类型,0:到最新;1:到指定; | |
ora_rst_type | Number | 否 | 0 | @mock=0, [RC] 还原类型,0:到最新;1:到指定; | |
ora_rst_limit_log_seq | String | 否 | @mock=, [RC] 还原到备份 日志序列号 | ||
ora_home_path | String | 否 | @mock=, Oracle数据库Home目录 | ||
ora_do_restore | Number | 否 | 0 | @mock=0, [RC] 还原(还原选项),0:否;1:是; | |
ora_rc_point_date | String | 否 | 2017-12-21 13:26:00 | @mock=2017-12-21 13:26:00, [RC] 恢复到备份 日期 | |
ora_rc_point_type | Number | 否 | 2 | @mock=0, [RC] 恢复到备份 类型,0:日期;1:SCN;2:日志序列号; | |
ora_rc_point_scn | Number | 否 | 0 | @mock=0, [RC] 恢复到备份 SCN | |
ora_rst_limit_scn | Number | 否 | 0 | @mock=0, [RC] 还原到备份 SCN | |
ora_passwd | String | 否 | Info1234 | @mock=Info1234, 【隐藏】Oracle SYS用户密码 | |
ora_rc_point_log_seq | String | 否 | 333 | @mock=, [RC] 恢复到备份 日志序列号 | |
ora_port | Number | 否 | 1 | @mock=1, 【隐藏】Oracle监听端口 | |
snapshot_time | String | 2019-01-01 17:55:22 | |||
rc_point_in_time | String | 否 | 2017-12-21_13-16-53 | @mock=2017-12-21_13-16-53, [RC] 还原时间点 rawfile | |
rc_style | Number | 否 | 1 | @mock=1, [RC] 恢复方式 blk_recovery_style,0:恢复到工作机;1:在备机合到指定目录; | |
wk_path | Array | 否 | , [RC] 新数据库文件存放路径 db_file_save_path | ||
random_str | String | 否 | 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 | @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 用于防止并发修改的随机串 | |
bk_path | Array | 否 | , 备机路径(在复制规则目标节点上),数据库还原不传 | ||
bk_uuid | String | 否 | 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 | @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机节点uuid | |
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 | 否 | 0 | @mock=0, 登录SQL Server服务器的信息:0:用mssql用户名密码;1:用winNT集成设置; | |
data_ip_uuid | String | 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 | 灾备机数据地址 | ||
res_by_path | String | '' | |||
data_return | Number | 0 | |||
data_dir | String | '' | |||
message | String | 否 | [0] success | @mock=[0] success | |
code | Number | 否 | 0 | @mock=0 |
2-3 恢复 列表-1 恢复 获取列表
SDK方法名:listTimingRecovery; 获取列表详细入参说明详见【节点管理-获取节点列表】接口说明;
URL
/timing/recovery
Method
GET
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
search_value | String | 否 | , 可选,搜索字段对应值(可以模糊) | ||
page | Number | 否 | , 可选,不传就是全部 | ||
limit | Number | 否 | , 可选,不传就是全部 | ||
search_field | String | 否 | , 可选,搜索字段 |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 否 | 200 | @mock=200 | |
data | Object | 否 | |||
info_list | Array | 否 | |||
bk_node_name | String | 否 | @pick(["kevin", "Jane", "Grey"]) | @mock=@pick(["kevin", "Jane", "Grey"]), 备机节点名 | |
wk_node_name | String | 否 | @pick(["Smith", "Will", "Nary"]) | @mock=@pick(["Smith", "Will", "Nary"]), 工作机节点名 | |
task_name | String | 否 | task_name | @mock=task_name, 任务名 | |
wk_uuid | String | 否 | 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 | @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机节点uuid | |
username | String | 否 | @pick(["admin", "user"]), 所有者 | ||
user_uuid | String | 否 | @pick(["1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC","1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC"]), 操作者用户名uuid | ||
task_uuid | String | 否 | 7AD64D7A-7D1D-AC51-5DF1-29A58345A288 | @mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 任务id,如果节点和规则id都不传,则全部 | |
bk_uuid | String | 否 | 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 | @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机节点uuid | |
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 | 否 | [0] success | @mock=[0] success | |
code | Number | 否 | 0 | @mock=0 | |
total | Number | 否 | 100 | @mock=100, 规则总数 | |
msg | String | 否 | @mock= |
2-3 恢复 列表-2 恢复 状态
SDK方法名:listTimingRecoveryStatus
URL
/timing/recovery/status
Method
GET
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
task_uuids | Array | 否 | ["11111111-1111-1111-1111-111111111111"] | , 必传,uuid数组,页面加载第一次获取状态一个一个获取,之后是批量获取; |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
data | Object | 否 | |||
message | String | 否 | [0] success | @mock=[0] success | |
code | Number | 否 | 0 | @mock=0 | |
count | Number | 否 | 0 | @mock=0 | |
status | Array | 否 | |||
status | String | 否 | MIRROR | @mock=STOP, 状态文字 | |
cur | Number | 否 | , 当前大小 | ||
progress | Number | 否 | 0 | @mock=0, 进度 | |
f_total | Number | 否 | 0 | @mock=0, 文件总数 | |
task_uuid | String | 否 | 7AD64D7A-7D1D-AC51-5DF1-29A58345A288 | @mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 任务id | |
total | Number | 否 | 100 | @mock=100, 总大小 | |
f_cur | Number | 否 | , 当前文件数 | ||
msg | String | 否 | @mock= | ||
ret | Number | 否 | 200 | @mock=200 |
2-3 恢复 列表-3 恢复 删除
SDK方法名:deleteTimingRecovery
URL
/timing/recovery
Method
DELETE
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
task_uuids | Array | 否 | ["11111111-1111-1111-1111-111111111111"] | , *规则数组 | |
force | Number | 1 - 强制删除 0 - 非强制删除 | |||
del_clone | Number | 0 | 快照备份,是否删除克隆卷: 0:不删除; 1:删除; 默认传0 |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | 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 恢复 列表-4 恢复 操作
SDK方法名:
启动:startTimingRecovery;
停止:stopTimingRecovery;
URL
/timing/recovery/operate
Method
POST
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
task_uuids | Array | 否 | , start, stop 操作时必传,规则数组 | ||
operate | String | 否 | start | start:启动; stop:停止; unmount:快照备份,卸载; |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
msg | String | 否 | @mock= | ||
data | Object | 否 | |||
code | Number | 否 | 0 | @mock=0 | |
message | String | 否 | [0] success | @mock=[0] success | |
ret | Number | 否 | 200 | @mock=200 |
2-4 恢复 mssql 获取单个组
SDK方法名:describeGroupTimingRecovery;
URL
/timing/recovery/:uuid([A-F0-9-]+)/group
Method
GET
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 初始值 | 简介 | 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 |
2-5 恢复 多库备份获取数据库列表
URL
/timing/recovery/db_info
Method
GET
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
bk_uuid | String | 备份服务器uuid | |||
rc_data_path | String | 恢复数据路径 | |||
wk_data_type | String | 4 | 目标类型: 4:mssql; 6:db2; 不传默认为4 |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | 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规则 |
---|---|---|---|---|---|
policy | Object | 否 | |||
policy_type | Number | 否 | 0 | 策略类型: timing: 0 | |
policy_name | String | 否 | test | 策略名 | |
bkup_policy | Number | 否 | 0 | 备份策略,2 立即,0 定时,1 循环; | |
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 | 否 | 38FFA6E2-2A40-31D6-7A94-E8168EBA9FF1 | 策略uuid | |
bkup_schedule | Array | 否 | 周期任务(备份策略) | ||
limit | Number | 否 | @integer(1, 64) | 数据保留期限(天) | |
sched_day | Array | 否 | "@integer(1, 31)" | 哪几天 | |
sched_every | Number | 否 | 2 | 0:每天;1:每周:2:每月;3:每隔; | |
sched_time | Array | 否 | @time('HH:mm') | 哪几点 | |
sched_gap_min | Number | 否 | @integer(1, 64) | 间隔分钟数 |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
data | Object | 否 | |||
message | String | 否 | [0] success | @mock=[0] success | |
code | Number | 否 | 0 | @mock=0 | |
ret | Number | 否 | 200 | @mock=200 | |
msg | String | 否 | @mock= |
(废弃)策略 新建/编辑-2 策略 获取单个
URL
/reg:/policy/[A-F0-9-]+
Method
GET
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 否 | 200 | @mock=200 | |
msg | String | 否 | @mock= | ||
data | Object | 否 | |||
code | Number | 否 | 0 | @mock=0 | |
message | String | 否 | [0] success | @mock=[0] success | |
policy | Object | 否 | |||
create_time | Number | 否 | 1515568566 | @mock=1515568566, 任务创建时间 | |
policy_uuid | String | 否 | 38FFA6E2-2A40-31D6-7A94-E8168EBA9FF1 | @mock=38FFA6E2-2A40-31D6-7A94-E8168EBA9FF1, 策略uuid | |
user_uuid | String | 否 | @pick(["1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC","1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC"]) | @mock=@pick(["1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC","1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC"]), 操作者用户名uuid | |
policy_type | Number | 否 | 0 | @mock=0, 策略类型: timing: 0 | |
bkup_policy | Number | 否 | 0 | @mock=0, 备份策略,2 立即,0 定时,1 循环; | |
bkup_schedule | Array | 否 | , 周期任务(备份策略) | ||
sched_time | Array | 否 | @time('HH:mm') | @mock=@time('HH:mm'), 哪几点 | |
sched_day | Array | 否 | "@integer(1, 31)" | @mock="@integer(1, 31)", 哪几天 | |
sched_every | Number | 否 | 2 | @mock=2, 0:每天;1:每周:2:每月;3:每隔; | |
limit | Number | 否 | @integer(1, 64) | @mock=@integer(1, 64), 数据保留期限(天) | |
sched_gap_min | Number | 否 | @integer(1, 64) | @mock=@integer(1, 64), 间隔分钟数 | |
bkup_window | Object | 否 | , 运行时间范围 | ||
sched_time_end | String | 否 | @time('HH:mm') | @mock=@time('HH:mm'), 运行时间范围 结束 | |
sched_time_start | String | 否 | @time('HH:mm') | @mock=@time('HH:mm'), 运行时间范围 开始 | |
bkup_one_time | Number | 否 | 1515568566 | @mock=1515568566, 定时任务,执行时间(备份策略) | |
policy_name | String | 否 | test | @mock=test, 策略名 |
(废弃)策略 新建/编辑-3 策略 修改
URL
/reg:/policy/[A-F0-9-]+
Method
PUT
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
policy | Object | 否 | |||
user_uuid | String | 否 | @pick(["1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC","1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC"]) | @mock=@pick(["1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC","1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC"]), 操作者用户名uuid | |
bkup_policy | Number | 否 | 0 | @mock=0, 备份策略,2 立即,0 定时,1 循环; | |
bkup_schedule | Array | 否 | , 周期任务(备份策略) | ||
sched_time | Array | 否 | @time('HH:mm') | @mock=@time('HH:mm'), 哪几点 | |
limit | Number | 否 | @integer(1, 64) | @mock=@integer(1, 64), 数据保留期限(天) | |
sched_day | Array | 否 | "@integer(1, 31)" | @mock="@integer(1, 31)", 哪几天 | |
sched_every | Number | 否 | 2 | @mock=2, 0:每天;1:每周:2:每月;3:每隔; | |
sched_gap_min | Number | 否 | @integer(1, 64) | @mock=@integer(1, 64), 间隔分钟数 | |
create_time | Number | 否 | 1515568566 | @mock=1515568566, 任务创建时间 | |
policy_name | String | 否 | test | @mock=test, 策略名 | |
bkup_one_time | Number | 否 | 1515568566 | @mock=1515568566, 定时任务,执行时间(备份策略) | |
policy_type | Number | 否 | 0 | @mock=0, 策略类型: timing: 0 | |
policy_uuid | String | 否 | 38FFA6E2-2A40-31D6-7A94-E8168EBA9FF1 | @mock=38FFA6E2-2A40-31D6-7A94-E8168EBA9FF1, 策略uuid | |
bkup_window | Object | 否 | , 运行时间范围 | ||
sched_time_end | String | 否 | @time('HH:mm') | @mock=@time('HH:mm'), 运行时间范围 结束 | |
sched_time_start | String | 否 | @time('HH:mm') | @mock=@time('HH:mm'), 运行时间范围 开始 |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
data | Object | 否 | |||
code | Number | 否 | 0 | @mock=0 | |
message | String | 否 | [0] success | @mock=[0] success | |
msg | String | 否 | @mock= | ||
ret | Number | 否 | 200 | @mock=200 |
(废弃)策略 列表-1 策略 获取列表
获取列表详细入参说明详见【节点管理-获取节点列表】接口说明;
URL
//policy
Method
GET
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
limit | Number | 否 | , 可选,不传就是全部 | ||
like_args | Array | 否 | , 可选,多重搜索 , 字段 => 搜索值或值的数组 | ||
page | Number | 否 | , 可选,不传就是全部 | ||
where_args | Array | 否 | , 可选,多重搜索 , 字段 => 搜索值或值的数组 |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 否 | 200 | @mock=200 | |
msg | String | 否 | @mock= | ||
data | Object | 否 | |||
message | String | 否 | [0] success | @mock=[0] success | |
total | Number | 否 | 100 | @mock=100, 规则总数 | |
info_list | Array | 否 | 10 | ||
bkup_policy | Number | 否 | 0 | @mock=0, 备份策略,2 立即,0 定时,1 循环; | |
user_uuid | String | 否 | @pick(["1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC","1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC"]) | @mock=@pick(["1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC","1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC"]), 操作者用户名uuid | |
policy_name | String | 否 | test | @mock=test, 策略名 | |
policy_uuid | String | 否 | 38FFA6E2-2A40-31D6-7A94-E8168EBA9FF1 | @mock=38FFA6E2-2A40-31D6-7A94-E8168EBA9FF1, 策略uuid | |
bkup_schedule | Array | 否 | , 周期任务(备份策略) | ||
sched_every | Number | 否 | 2 | @mock=2, 0:每天;1:每周:2:每月;3:每隔; | |
sched_day | Array | 否 | "@integer(1, 31)" | @mock="@integer(1, 31)", 哪几天 | |
sched_time | Array | 否 | @time('HH:mm') | @mock=@time('HH:mm'), 哪几点 | |
sched_gap_min | Number | 否 | @integer(1, 64) | @mock=@integer(1, 64), 间隔分钟数 | |
limit | Number | 否 | @integer(1, 64) | @mock=@integer(1, 64), 数据保留期限(天) | |
policy_type | Number | 否 | 0 | @mock=0, 策略类型: timing: 0 | |
bind_num | Number | 否 | 3 | @mock=3, 绑定的任务数量 | |
create_time | Number | 否 | 1515568566 | @mock=1515568566, 任务创建时间 | |
bkup_window | Object | 否 | , 运行时间范围 | ||
sched_time_end | String | 否 | @time('HH:mm') | @mock=@time('HH:mm'), 运行时间范围 结束 | |
sched_time_start | String | 否 | @time('HH:mm') | @mock=@time('HH:mm'), 运行时间范围 开始 | |
bkup_one_time | Number | 否 | 1515568566 | @mock=1515568566, 定时任务,执行时间(备份策略) | |
code | Number | 否 | 0 | @mock=0 |
(废弃)策略 列表-3 策略 删除
URL
//policy
Method
DELETE
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
policy_uuids | Array | 否 | , *策略数组 |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
msg | String | 否 | @mock= | ||
ret | Number | 否 | 200 | @mock=200 | |
data | Object | 否 | |||
code | Number | 否 | 0 | @mock=0 | |
message | String | 否 | [0] success | @mock=[0] success |
恢复 - 准备1 - DB2获取时间列表
SDK方法名:listTimingRecoveryDb2Time
URL
/timing/recovery/rc_db2_time
Method
GET
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
bk_uuid | String | 否 | B8566905-411E-B2CD-A742-77B1346D8E84 | ||
rc_data_path | String | 否 | E:\mssqlBK\ts-11111111-1111-1111-1111-111111111111\ | ||
Response
名称 | 类型 | 必选 | 初始值 | 简介 | 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规则 |
---|---|---|---|---|---|
policy_uuids | Array | 否 | , *策略数组 | ||
operate | String | 否 | bind | @mock=bind, *bind |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
msg | String | 否 | @mock= | ||
data | Object | 否 | |||
code | Number | 否 | 0 | @mock=0 | |
message | String | 否 | [0] success | @mock=[0] success | |
ret | Number | 否 | 200 | @mock=200 |
恢复 获取GAUSS还原时间点
SDK方法名:listTimingRecoveryGaussTime;
URL
/timing/recovery/gaussdb_rc_time
Method
GET
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
uuid | String | 灾备机uuid | |||
bk_path | String | 备份路径 |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|---|---|---|---|---|
msg | String | ||||
ret | Number | 200 | |||
data | Object | ||||
code | Number | 0 | |||
message | String | [0] success | |||
timelist | Array | ||||
String |