定时任务
SDK类名:/timing/TimingBackup;
1-1 备份 准备-4 备份 获取MsSql数据源
SDK方法名:describeTimingBackupMssqlSource;
URL
Method
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
Method
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
Method
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
Method
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
Method
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] 数据源名称 | |
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= | |
-------------------------- 分隔线 --------------------------
URL
Method
Request
Response
1-2 备份 新建/编辑-1 备份 新建
SDK方法名:createTimingBackup
URL
Method
Request
| 名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
| timing_backup | Object | 否 | | | |
| mirr_sync_attr | Number | 否 | 1 | 文件安全属性,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; | |
| 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目录 | |
| wk_data_type | Number | 否 | 1 | 源类型,0:块设备;1:文件;3:oracle;4:mssql; | |
| 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_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 | |
| compress | Number | 否 | 0 | 压缩,0关;1:低;2:中;3:高; | |
| encrypt_switch | Number | 否 | 0 | 是否加密,0:不开启;1:开启; | |
| wk_path | Array | 否 | ["E:\test\"] | 工作路径 | |
| excl_path | Array | 否 | [] | 源机排除目录 | |
| bk_data_type | Number | 否 | 1 | 目标类型,1:文件;2:raw数据; | |
| 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 | 否 | | 连接超时设定(秒): | |
| check_out | Number | 否 | 1 | 开启校验功能:0关1开 | |
| data_source | String | 否 | | [BK] 数据源名称 | |
| db_name | String | 否 | | [BK] 备份数据库名称 | |
| 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 | 块大小 | |
| db2_settings | Object | 否 | | db2 基本设置 | |
| db_name | String | 否 | | 备份数据库名称 | |
| db2_user | String | 否 | | db2用户,db2时必传 | |
| db2_group | String | 否 | | db2组,db2时必传 | |
| timeout | Number | 否 | | 超时时间,超过这个时间还没备完则产生告警, 默认0, 大小0 - 168之间 | |
Response
| 名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
| data | Object | 否 | | | |
| code | Number | 否 | 0 | @mock=0 | |
| message | String | 否 | [0] success | @mock=[0] success | |
| ret | Number | 否 | 200 | @mock=200 | |
| msg | String | 否 | | @mock= | |
1-2 备份 新建/编辑-2 备份 获取单个
SDK方法名:describeTimingBackup
URL
Method
Request
Response
| 名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
| msg | String | 否 | | | |
| data | Object | 否 | | | |
| 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_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; | |
| message | String | 否 | [0] success | | |
| code | Number | 否 | 0 | | |
| ret | Number | 否 | 200 | | |
1-2 备份 新建/编辑-3 备份 修改
SDK方法名:modifyTimingBackup
URL
Method
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_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 | 新建不传 | |
Response
| 名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
| data | Object | 否 | | | |
| message | String | 否 | [0] success | @mock=[0] success | |
| code | Number | 否 | 0 | @mock=0 | |
| ret | Number | 否 | 200 | @mock=200 | |
| msg | String | 否 | | @mock= | |
1-3 备份 列表-1 备份 获取列表
SDK方法名:listTimingBackup; 获取列表详细入参说明详见【节点管理-获取节点列表】接口说明;
URL
Method
Request
| 名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
| search_field | String | 否 | | , 可选,搜索字段 | |
| limit | Number | 否 | 10 | , 可选,不传就是全部 | |
| page | Number | 否 | 1 | , 可选,不传就是全部 | |
| search_value | String | 否 | | , 可选,搜索字段对应值(可以模糊) | |
| type | Number | 否 | 0 | 任务类型:备份任务:0;还原任务:1;备份任务模板:10; | |
Response
| 名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
| msg | String | 否 | | | |
| data | Object | 否 | | | |
| info_list | Array | 否 | | | |
| 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_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 | | |
| message | String | 否 | [0] success | | |
| code | Number | 否 | 0 | | |
| ret | Number | 否 | 200 | | |
1-3 备份 列表-2 备份 状态
SDK方法名:listTimingBackupStatus
URL
Method
Request
| 名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
| task_uuids | Array | 否 | ["11111111-1111-1111-1111-111111111111"] | 必传,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 | Object | 否 | | | |
| status | String | 否 | STOP | @mock=STOP, 状态文字 | |
| progress | Number | 否 | 0 | @mock=0, 进度 | |
| total | Number | 否 | 100 | @mock=100, 总大小 | |
| cur | Number | 否 | | , 当前大小 | |
| f_cur | Number | 否 | | , 当前文件数 | |
| task_uuid | String | 否 | 7AD64D7A-7D1D-AC51-5DF1-29A58345A288 | @mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 任务id | |
| f_total | Number | 否 | 0 | @mock=0, 文件总数 | |
| ret | Number | 否 | 200 | @mock=200 | |
1-3 备份 列表-3 备份 删除
SDK方法名:deleteTimingBackup
URL
Method
Request
| 名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
| task_uuids | Array | 否 | ["11111111-1111-1111-1111-111111111111"] | *规则数组 | |
| del_policy | Number | 否 | | *删除策略,0:不开启;1:开启; | |
Response
| 名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
| ret | Number | 否 | 200 | @mock=200 | |
| msg | String | 否 | | @mock= | |
| data | Object | 否 | | | |
| message | String | 否 | [0] success | @mock=[0] success | |
| code | Number | 否 | 0 | @mock=0 | |
1-3 备份 列表-4 备份 操作
SDK方法名:[action] + 'TimingBackup'
URL
Method
Request
| 名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
| operate | String | 否 | start | start, stop, start_immediately | |
| task_uuids | Array | 否 | ["11111111-1111-1111-1111-111111111111"] | 必传,规则数组 | |
| bk_type | String | 否 | | 立即执行操作(start_immediately)必传,取值为,备份策略 - 周期任务 - 备份方式;0:全备,1:增量,2:差异 | |
Response
| 名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
| data | Object | 否 | | | |
| code | Number | 否 | 0 | @mock=0 | |
| message | String | 否 | [0] success | @mock=[0] success | |
| msg | String | 否 | | @mock= | |
| ret | Number | 否 | 200 | @mock=200 | |
-------------------------- 分隔线 --------------------------
URL
Method
Request
Response
2-1 恢复 准备-2 恢复 获取还原时间点 - Mssql
SDK类名:/timing/TimingRecovery;
SDK方法名:listTimingRecoveryMssqlTime
URL
Method
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
Method
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
Method
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 | 否 | | | |
| recovery_task | Object | 否 | | | |
| wk_data_type | Number | 否 | 0 | 源类型,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'] | | +1 |
| bk_data_type | Number | 否 | 1 | 目标类型,1:文件;2:raw数据; | |
| bk_path | Array | 否 | F:\e\2018-01-02_10-54-42\E | 备份路径 | |
| msg | String | 否 | | | |
2-1 恢复 准备-4 恢复 认证MsSql数据库
SDK方法名:verifyTimingRecoveryMssqlInfo
URL
Method
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集成设置不填 | |
| 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 | |
-------------------------- 分隔线 --------------------------
URL
Method
Request
Response
2-2 恢复 新建/编辑-1 恢复 新建
SDK方法名:createTimingRecovery
URL
Method
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_rst_limit_scn | Number | 否 | 0 | [RC] 还原到备份 SCN | |
| ora_rc_point_scn | Number | 否 | 0 | [RC] 恢复到备份 SCN | |
| ora_rst_limit_thread | Number | 否 | 1 | [RC] 还原到备份 线程 | |
| ora_rc_point_log_seq | String | 否 | | [RC] 恢复到备份 日志序列号 | |
| ora_rst_limit_date | String | 否 | 2017-12-21 13:26:00 | [RC] 还原到备份 日期 | |
| ora_rst_limit_type | Number | 否 | 0 | [RC] 还原到备份 类型,0:日期;1:SCN;2:日志序列号; | |
| ora_home_path | String | 否 | | Oracle数据库Home目录 | |
| ora_rc_point_type | Number | 否 | 0 | [RC] 恢复到备份 类型,0:日期;1:SCN;2:日志序列号; | |
| ora_passwd | String | 否 | Info1234 | 【隐藏】Oracle SYS用户密码 | |
| ora_port | Number | 否 | 1 | 【隐藏】Oracle监听端口 | |
| ora_rc_point_date | String | 否 | 2017-12-21 13:26:00 | [RC] 恢复到备份 日期 | |
| ora_do_restore | Number | 否 | 0 | [RC] 还原(还原选项),0:否;1:是; | |
| ora_rst_limit_log_seq | String | 否 | | [RC] 还原到备份 日志序列号 | |
| ora_content_type | Number | 否 | 0 | 备份内容:0:整库;1:表空间;2:数据文件;3:PDBS;4:CDB;5:ARCHIVELOG;6:CONTROLFILE;7:SPFILE; | |
| ora_pdbs_name | String | 否 | | PDB,ora_content_type 为 PDBS 时必传,内容为逗号分隔的PDB名称 | |
| ora_rc_point_thread | Number | 否 | 1 | [RC] 恢复到备份 线程 | |
| ora_sid_name | String | 否 | | Oracle数据库实例名 | |
| ora_do_recovery | Number | 否 | 0 | [RC] 恢复(还原选项),0:否;1:是; | |
| ora_rc_type | Number | 否 | 0 | [RC] 恢复类型,0:到最新;1:到指定; | |
| ora_rst_type | Number | 否 | 0 | [RC] 还原类型,0:到最新;1:到指定; | |
| 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 | 否 | | 参数文件的备份文件名称 | |
| 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 | 否 | | 连接超时设定(秒): | |
| check_out | String | 否 | | 开启还原完成后校验功能(开1,关0) | |
| db_file_save_path | String | 否 | | [RC] 新数据库文件存放路径 | |
| src_db_name | String | 否 | | [RC] 原数据库名称 | |
| new_db_name | String | 否 | | [RC] 新数据库名称 | |
| db_size | String | 否 | | [RC] 数据库大小 | |
| tab_num | String | 否 | | [RC] 数据库表个数 | |
| tab_info | String | 否 | | [RC] 数据库表名 | |
| ln_num | String | 否 | | [RC] 数据库表行数 | |
| 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 的行数 | | | | | |
| db2_settings | Object | 否 | | db2 设置(基本设置) | |
| new_db_name | String | 否 | dbtest1 | 新数据库名称 | |
| log_file_dir | String | 否 | | 日志文件路径 | |
| compress | String | 否 | | 压缩:0不开启;1,低;2,中;3,高 | |
| encrypt_switch | String | 否 | | 加密开关,0不开启,1开启 | |
| secret_key | String | 否 | | 加密key | |
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
Method
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 | 否 | | | |
| new_db_name | String | 否 | db2_test | 新数据库名称 | |
| log_file_dir | 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 | 否 | | | |
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
Method
Request
Response
| 名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
| msg | String | 否 | | @mock= | |
| ret | Number | 否 | 200 | @mock=200 | |
| data | Object | 否 | | | |
| timing_recovery | Object | 否 | | | |
| wk_data_type | Number | 否 | 0 | @mock=0, 工作机目录类型,0:块设备;1:文件;3:oracle;4:mssql; | |
| 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 | 否 | 1 | @mock=1, 备机目录类型,1:文件;2:raw数据; | |
| 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 | 否 | 0 | @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 | 否 | 0 | @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 | 否 | | @mock=, [RC] 恢复到备份 日志序列号 | |
| ora_port | Number | 否 | 1 | @mock=1, 【隐藏】Oracle监听端口 | |
| 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 | 否 | | | |
| new_db_name | String | 否 | db2_test | | |
| 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集成设置; | |
| message | String | 否 | [0] success | @mock=[0] success | |
| code | Number | 否 | 0 | @mock=0 | |
2-3 恢复 列表-1 恢复 获取列表
SDK方法名:listTimingRecovery; 获取列表详细入参说明详见【节点管理-获取节点列表】接口说明;
URL
Method
Request
| 名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
| search_value | String | 否 | | , 可选,搜索字段对应值(可以模糊) | |
| page | Number | 否 | | , 可选,不传就是全部 | |
| limit | Number | 否 | | , 可选,不传就是全部 | |
| search_field | String | 否 | | , 可选,搜索字段 | |
Response
| 名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
| ret | Number | 否 | 200 | @mock=200 | |
| data | Object | 否 | | | |
| info_list | Array | 否 | | | 10 |
| 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 | |
| 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
Method
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 | Object | 否 | | | |
| status | String | 否 | STOP | @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
Method
Request
| 名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
| task_uuids | Array | 否 | ["11111111-1111-1111-1111-111111111111"] | , *规则数组 | |
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-3 恢复 列表-4 恢复 操作
SDK方法名:[action] + 'TimingRecovery'
URL
Method
Request
| 名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
| task_uuids | Array | 否 | | , start, stop 操作时必传,规则数组 | |
| operate | String | 否 | start | @mock=start, *start, stop | |
Response
| 名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
| msg | String | 否 | | @mock= | |
| data | Object | 否 | | | |
| code | Number | 否 | 0 | @mock=0 | |
| message | String | 否 | [0] success | @mock=[0] success | |
| ret | Number | 否 | 200 | @mock=200 | |
(废弃)策略 新建/编辑-1 策略 新建
URL
Method
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
Method
Request
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
Method
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
Method
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
Method
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 | |
(废弃)策略 列表-4 策略 操作
URL
Method
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 | |
-------------------------- 分隔线 --------------------------
URL
Method
Request
Response
恢复 - 准备1 - DB2获取时间列表
SDK方法名:listTimingRecoveryDb2Time
URL
Method
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 | | |