定时任务

November 23, 2021About 58 min

定时任务

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_uuidString22D03E06-94D0-5E2C-336E-4BEEC2D28EC4工作机节点uuid

Response

名称类型必选初始值简介Mock规则
dataObject
  data_sourceStringsql@mock=sql
  codeNumber0@mock=0
  messageString[0] success@mock=[0] success
msgString@mock=
retNumber200@mock=200

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

SDK方法名:verifyTimingBackupOracleInfo

URL

/timing/backup/verify_oracle_info

Method

POST

Request

名称类型必选初始值简介Mock规则
oracle_settingsObjectoracle 设置(基本设置)
  ora_sid_nameStringOracle数据库实例名
  ora_portNumber1【隐藏】Oracle监听端口
  ora_home_pathStringOracle数据库Home目录
  ora_passwdStringInfo1234【隐藏】Oracle SYS用户密码
wk_uuidString67E33CDB-D75B-15B3-367D-50C764F5A26F节点uuid

Response

名称类型必选初始值简介Mock规则
dataObject
  oracle_infoString@mock=
  codeNumber0@mock=0
  messageString[0] success@mock=[0] success
msgString@mock=
retNumber200@mock=200

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

SDK方法名:describeTimingBackupOracleContent

URL

/timing/backup/oracle_content

Method

POST

Request

名称类型必选初始值简介Mock规则
oracle_settingsObjectoracle 设置(基本设置)
  ora_passwdStringInfo1234【隐藏】Oracle SYS用户密码
  ora_portNumber1【隐藏】Oracle监听端口
  ora_sid_nameStringOracle数据库实例名
  ora_content_typeNumber00:整库;1:表空间;2:数据文件;
wk_uuidString67E33CDB-D75B-15B3-367D-50C764F5A26F节点uuid

Response

名称类型必选初始值简介Mock规则
retNumber200@mock=200
dataObject
  codeNumber0@mock=0
  messageString[0] success@mock=[0] success
  oracle_contentArray@mock=
msgString@mock=

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

SDK方法名:descibeTimingBackupOracleSriptPath

URL

/timing/backup/oracle_script_path

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
retNumber200@mock=200
msgString@mock=
dataObject
  codeNumber0@mock=0
  messageString[0] success@mock=[0] success
  script_pathString@mock=

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

SDK方法名:listTimingBackupMssqlDbList

URL

/timing/backup/mssql_db_list

Method

POST

Request

名称类型必选初始值简介Mock规则
wk_uuidString67E33CDB-D75B-15B3-367D-50C764F5A26F工作机节点uuid
mssql_settingsObject
  win_verifyNumber0登录SQL Server服务器的信息:0:用mssql用户名密码;1:用winNT集成设置;
  instance_nameStringMSSQLSERVERsql server 实例名,默认是MSSQLSERVER
  user_idStringsasql server 用户名,用winNT集成设置不填
  pass_wordString123456sql server 密码,用winNT集成设置不填
  data_sourceStringWIN-EGKN86NF3PM[BK] 数据源名称
  portString当网络协议类型为TCP/IP时,默认值1433
  protocolNumber0:shared memory,1:TCP/IP,默认值 0

Response

名称类型必选初始值简介Mock规则
retNumber200@mock=200
dataObject
  codeNumber0@mock=0
  messageString[0] success@mock=[0] success
  mssql_db_listArray['master','tempdb','model','msdb','ReportServer','ReportServerTempDB','test']@mock=$order('master','tempdb','model','msdb','ReportServer','ReportServerTempDB','test')+1
msgString@mock=

备份 准备 验证oracle登陆认证

SDK方法名:verifyTimingBackupOracleLogin;

URL

/timing/backup/oracle_login

Method

POST

Request

名称类型必选初始值简介Mock规则
wk_uuidString
oracle_settingsObject
  ora_sid_nameStringoracle的sid
  ora_login_nameStringoracle的用户名
  ora_login_pwdStringoracle的密码
  ora_server_nameStringoracle的实例名
  ora_server_portStringoracle的服务端口

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功

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

SDK方法名:createTimingBackup

URL

/timing/backup

Method

POST

Request

名称类型必选初始值简介Mock规则
timing_backupObject
  mirr_sync_attrNumber1文件安全属性,0:不同步;1:同步;
  mirr_file_checkNumber0校验方式, 0: 严格校验, 1: 时间校验
  oracle_settingsObjectoracle 设置(基本设置)
    ora_sid_nameStringOracle数据库实例名
    ora_content_typeNumber0备份内容:0:整库;1:表空间;2:数据文件;3:PDBS;4:CDB;5:ARCHIVELOG;6:CONTROLFILE;7:SPFILE;8:TABLE;
    ora_pdbs_nameStringPDB,ora_content_type 为 PDBS 时必传,内容为逗号分隔的PDB名称
    ora_use_scriptNumber0[BK] 使用脚本
    ora_portNumber1【隐藏】Oracle监听端口
    ora_script_pathString[BK] 脚本路径
    ora_passwdStringInfo1234【隐藏】Oracle SYS用户密码
    ora_home_pathStringOracle数据库Home目录
    ora_login_nameString
    ora_login_pwdString
    ora_server_nameString
    ora_server_portString
    pool_uuidString存储池uuid
    pool_nameString存储池名称
    volume_uuidString复制卷uuid
    volume_nameString复制卷名称
    attach_pointString挂载点
    ora_tab_modeNumber数据库模式:
0:non-CDB;
1:CDBRoot;
2:PDBs;
    ora_tab_pdb_nameStringPDBs模式后,输入PDB的名称
    ora_tab_namesArray
      userString用户名
      ori_tableString原表名
      tgt_tableString目标表名
    ora_tab_aux_pathString辅助实例存放路径
    ora_tab_rctypeNumber恢复表指定备份
0:日期;
1:SCN;
2:日志序列号;
    ora_tab_timeString时间
    ora_tab_scnStringSCN
    ora_tab_logString日志序列号
  wk_data_typeNumber1源类型:
0:块设备;
1:文件;
3:oracle;
4:mssql;
9:MySQL;
12:高斯db;
13: informix;
14: 复制卷;
  task_nameStringtestTiming任务名
  backup_typeNumber0备份策略里非全备的备份类型,0:全备(没策略或策略只有全备);1:增量(策略中存在增量);2:差异(策略中存在);
  del_policyNumber0删除策略,0:不开启;1:开启;
  mirr_sync_flagNumber0错误处理方式,0:出错停止;1:出错继续;
  snap_typeNumber0源端快照类型,0:none,1:vss
  oracle_rman_settingsObjectoracle rman 设置(备份选项)
    rman_skip_offlineNumber0表空间选项,跳过脱机数据文件
    rman_num_streams_archNumber20归档选项,并行流数
    rman_del_archNumber1归档选项,备份后删除
    rman_arch_retainNumber3归档选项,保留天数
    rman_include_arch_flagNumber1归档选项,将归档重做日志包括在全备的和增量的备份计划中
    rman_num_streams_dfNumber1表空间选项,并行流数
    rman_filespertset_archNumber20归档选项,每个备份集文件数
    rman_maxsetsize_dfNumber0表空间选项,备份集大小(KB)
    rman_set_limit_arch_flagNumber0归档选项,指定最高限额
    rman_skip_readonlyNumber0表空间选项,跳过脱机数据文件
    rman_maxsetsize_archNumber0归档选项,备份集大小(KB)
    rman_cold_bkupNumber0表空间选项,离线(冷)数据库备份
    rman_filespertset_dfNumber20表空间选项,每个备份集文件数
    rman_db_readonlyNumber0源端数据库只读
    rman_compress_dfNumber表空间选项,压缩,开启传1,关闭传0
    rman_include_spfile_flagNumber参数文件选项,将参数文件包括在全备的和增量的备份计划中,开启传1,关闭传0
  wk_pathArray["E:\test\"]工作路径
  excl_pathArray[]源机排除目录
  bk_data_typeNumber1目标类型,1:文件;2:raw数据;10:备份快照; 11: 合成备份
  compressNumber0压缩,0关;1:低;2:中;3:高;
  encrypt_switchNumber0是否加密,0:不开启;1:开启;
  encryptNumber1加密类型
1:aes,
2:sm4
  secret_keyString密钥
  bk_pathArray["E:\t\"]备份路径
  blk_direct_copyNumber0块设备,1:直接拷贝;
  mirr_open_typeNumber0文件打开方式,0:普通文件;1:自动选择;2:MFT;
  mssql_settingsObjectmssql 设置(基本设置)
    instance_nameStringMSSQLSERVERsql server 实例名,默认是MSSQLSERVER
    win_verifyNumber1登录SQL Server服务器的信息:0:用mssql用户名密码;1:用winNT集成设置;
    user_idStringsql server 用户名,用winNT集成设置不填
    pass_wordStringsql server 密码,用winNT集成设置不填
    time_outString连接超时设定(秒):
    data_sourceString[BK] 数据源名称
    portString当网络协议类型为TCP/IP时,默认值1433
    protocolNumber0:shared memory,1:TCP/IP,默认值 0
    db_infoArray库信息,同时用来存放子任务信息
      db_nameString[BK] 备份数据库名称
      check_outNumber1开启校验功能:0关1开
  wk_uuidString67E33CDB-D75B-15B3-367D-50C764F5A26F@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机节点uuid
  bk_uuidStringB8566905-411E-B2CD-A742-77B1346D8E84@mock=@pick(["kevin", "Jane", "Grey"]), 备机节点uuid
  bkup_policyNumber2备份策略,2 立即,0 定时,1 循环;
  bkup_windowObject运行时间范围
    sched_time_startString00:00运行时间范围 开始
    sched_time_endString00:00运行时间范围 结束
  bkup_one_timeNumber1547538235定时任务,执行时间(备份策略)
  bkup_scheduleArray周期任务(备份策略)
    limitNumber@integer(1, 64)数据保留期限(天)
    sched_dayArray"@integer(1, 31)"哪几天
    sched_everyNumber20:每天;1:每周:2:每月;3:每隔
    sched_timeArray@time('HH:mm')哪几点
    sched_gap_minNumber@integer(1, 64)
间隔分钟数
    backup_typeNumber备份类型,0:全备/数据备份;1:增量/日志备份;2:差异;
  task_typeNumber0任务类型:备份任务:0;还原任务:1;备份任务模板:10;
  file_check_dirString校验目录
  random_strString11111111-1111-1111-1111-111111111111新建不传
  file_check_switchNumber0文件校验开关,0关1开;
  mirr_blk_sizeNumber0块大小
  timing_typeNumber定时任务类型:
0 - 普通定时任务;
1 - 集群定时任务(RAC);
2 - 集群定时任务(GAUSS);
3 - 集群定时任务(英方服务集群);
  data_ip_uuidStringB8566905-411E-B2CD-A742-77B1346D8E84灾备机数据地址
  bk_file_cryptNumber0备端数据加密,1是,0否;默认为0
  bk_crypt_typeNumber1备端数据加密类型:
1:aes,
2:sm4
  bk_crypt_keyString''
备端数据加密,密钥
  mysql_settingsObjectmysql基本设置
    pool_uuidString存储池uuid
    pool_nameString存储池名称
    volume_uuidString复制卷uuid
    volume_nameString复制卷名称
    attach_pointString挂载点
    mysql_portString端口
    mysql_userString用户名
    mysql_passwdString密码
    time_outNumber超时时间
    mysql_pathStringMySQL执行目录
    log_ccopyNumber日志持续复制开关
    log_volume_uuidString日志卷
    log_volume_nameString
    log_mount_pointString日志卷在工作机的挂载点
    data_dirString数据目录
    config_pathString/etc/my.cnf配置文件路径
  archive_penNumber0是否开启备份归档:0否了是
  tape_uuidStringE8566905-411E-B2CD-A742-77B1346D8E84磁带库uuid
  library_snStringSYZZY_A磁带序列号
  db_nameString备份数据库名称(gauss集群)
  content_typeNumber备份内容类型(gauss集群),0 整库 1 表
  tablesString数据表名称,多个表之间用空格隔开(gauss集群)
  informix_settingsObjectinformix 基本设置
    oper_userString操作用户,默认为informix
    is_ori_machineNumber【RC】【弃用】是否恢复到原机: 1-是 0-否
    config_recoverNumber【RC】恢复关键文件 1:还原,0不还原 默认为0
    verify_onlyNumber【RC】仅验证,0是需要还原数据,1是仅验证
    informix_instanceObject
      is_defaultNumber默认实例,1是默认,0是非默认
      install_dirString安装目录路径
      instance_nameString实例名
      onconfig_nameString配置文件名
  thread_numNumber0并行任务数
timeoutNumber超时时间,超过这个时间还没备完则产生告警, 默认0, 大小0 - 168之间
db2_settingsObjectdb2 基本设置
  db2_userStringdb2用户,db2时必传
  db2_groupStringdb2组,db2时必传
  db_infoArray
    db_nameString备份数据库名称
synthetic_bkup_settingsObject合成备份 基本设置
  pool_uuidString存储池UUID
  pool_nameString存储池名称
  volume_uuidString复制卷uuid
  volume_nameString复制卷名称
  lanfreeNumber开启LAN-FREE开关

Response

名称类型必选初始值简介Mock规则
msgString@mock=
retNumber200@mock=200
dataObject
  codeNumber0@mock=0
  messageString[0] success@mock=[0] success
  success_listArray
    db_nameString
  fail_listArray失败的列表
    db_nameString
    messageString

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

SDK方法名:describeTimingBackup

URL

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

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
msgString
dataObject
  timing_backupObject
    mirr_sync_attrNumber1
    secret_keyString
    oracle_settingsObject
      ora_sid_nameStringorcl
      ora_content_typeNumber0
      ora_use_scriptNumber0
      ora_portNumber1
      ora_script_pathString
      ora_passwdStringInfo1234
      ora_home_pathString/test
      attach_pointString/data
      pool_nameStringRichard Hall
      pool_uuidString5C9D7fB7-91AB-cB5D-d267-C5EE4593cfcc
      volume_nameStringcopy-volume1
      volume_uuidStringE95CB20B-917C-57F4-F926-751ECE95F869
    policy_uuidString38FFA6E2-2A40-31D6-7A94-E8168EBA9FF1
    wk_data_typeNumber1
    task_nameString@name
    backup_typeNumber1
    del_policyNumber0
    mirr_sync_flagNumber0
    snap_typeNumber0
    oracle_rman_settingsObject
      rman_skip_offlineNumber0
      rman_num_streams_archNumber1
      rman_del_archNumber1
      rman_arch_retainNumber3
      rman_include_arch_flagNumber1
      rman_num_streams_dfNumber1
      rman_filespertset_archNumber20
      rman_maxsetsize_dfNumber0
      rman_set_limit_arch_flagNumber0
      rman_skip_readonlyNumber0
      rman_maxsetsize_archNumber0
      rman_cold_bkupNumber0
      rman_filespertset_dfNumber20
    compressNumber0
    encrypt_switchNumber0
    wk_pathArray
    excl_pathArray
    bk_data_typeNumber11
    mirr_blk_sizeNumber0
    bk_pathArray['/test1','/test2']
    blk_direct_copyNumber0
    mirr_open_typeNumber0
    mssql_settingsObject
      instance_nameString
      time_outString2
      data_sourceString
      dbsizeString
      win_verifyNumber0
      user_idString
      db_infoArray
        db_nameString
      pass_wordString
    wk_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
    bk_uuidStringGrey
    bkup_policyNumber0
    bkup_windowObject
      sched_time_startString18:47
      sched_time_endString21:05
    bkup_one_timeNumber1515568566
    bkup_scheduleArray
      limitNumber50
      sched_dayNumber24
      sched_everyNumber2
      sched_timeString17:16
      sched_gap_minNumber41
    task_typeNumber0任务类型:备份任务:0;还原任务:1;备份任务模板:10;
    data_ip_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3灾备机数据地址
    band_widthString000:00-23:592k,100:00-23:594k
    task_uuidString@uuid
    db2_settingsObject
      db2_userString
      db2_groupString
      db_infoArray
        task_nameString
        task_uuidString
        db_nameString
    synthetic_bkup_settingsObject
      pool_uuidStringFEaF20d4-FAf6-c4e3-F2dB-55D8dC44E10e
      pool_nameStringGary Hernandez
      volume_uuidStringFEaF20d4-FAf6-c4e3-F2dB-55D8dC44E10e
      volume_nameStringcopy-volume1
      attach_pointString/data
      lanfreeNumber1
  messageString[0] success
  codeNumber0
retNumber200

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

SDK方法名:modifyTimingBackup

URL

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

Method

PUT

Request

名称类型必选初始值简介Mock规则
timing_backupObject
  mirr_sync_attrNumber1
  secret_keyString
  oracle_settingsObject
    ora_sid_nameString
    ora_content_typeNumber0
    ora_use_scriptNumber0
    ora_portNumber1
    ora_script_pathString
    ora_passwdStringInfo1234
    ora_home_pathString
  policy_uuidString38FFA6E2-2A40-31D6-7A94-E8168EBA9FF1
  wk_data_typeNumber0
  task_nameString
  backup_typeNumber1
  del_policyNumber0
  mirr_sync_flagNumber0
  snap_typeNumber0
  oracle_rman_settingsObject
    rman_skip_offlineNumber0
    rman_num_streams_archNumber1
    rman_del_archNumber1
    rman_include_arch_flagNumber1
    rman_num_streams_dfNumber1
    rman_filespertset_archNumber20
    rman_maxsetsize_dfNumber0
    rman_set_limit_arch_flagNumber0
    rman_skip_readonlyNumber0
    rman_maxsetsize_archNumber0
    rman_cold_bkupNumber0
    rman_filespertset_dfNumber20
  compressNumber0
  encrypt_switchNumber0
  wk_pathArray
  excl_pathArray
  bk_data_typeNumber1
  mirr_blk_sizeNumber0
  bk_pathArray
  blk_direct_copyNumber0
  mirr_open_typeNumber0
  mssql_settingsObject
    instance_nameString
    time_outString2
    data_sourceString
    dbsizeString
    win_verifyNumber0
    user_idString
    db_infoArray
      db_nameString
    pass_wordString
  wk_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
  bk_uuidStringJane
  bkup_policyNumber0
  bkup_windowObject
    sched_time_startString15:18
    sched_time_endString14:37
  bkup_one_timeNumber1515568566
  bkup_scheduleArray
    limitNumber25
    sched_dayNumber24
    sched_everyNumber2
    sched_timeString04:07
    sched_gap_minNumber49
  task_typeNumber0任务类型:备份任务:0;还原任务:1;备份任务模板:10;
  random_strString11111111-1111-1111-1111-111111111111新建不传
  data_ip_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3灾备机数据地址
  db2_settingsObject
    db2_userString
    db2_groupString
    db_infoArray
      task_uuidString
      task_nameString
      db_nameString

Response

名称类型必选初始值简介Mock规则
msgString@mock=
retNumber200@mock=200
dataObject
  messageString[0] success@mock=[0] success
  codeNumber0@mock=0
  success_listArray
    db_nameString
  fail_listArray
    db_nameString
    codeString
    messageString

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

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

URL

/timing/backup

Method

GET

Request

名称类型必选初始值简介Mock规则
search_fieldString, 可选,搜索字段
limitNumber10, 可选,不传就是全部
pageNumber1, 可选,不传就是全部
search_valueString, 可选,搜索字段对应值(可以模糊)
typeNumber0任务类型:备份任务:0;还原任务:1;备份任务模板:10;
where_args[timing_type]Number0 - 普通定时任务
1 - 集群[RAC]

Response

名称类型必选初始值简介Mock规则
msgString
dataObject
  info_listArray
    oracle_settingsObjectORACLE配置信息
      ora_sid_nameStringOracle数据库实例名
      ora_content_typeNumber0备份内容:
0:整库:
1:表空间:
2:数据文件:
3:PDBS:
4:CDB:
5:ARCHIVELOG:
6:CONTROLFILE:
7:SPFILE:
8:TABLE;
      ora_use_scriptNumber0[BK] 使用脚本
      ora_portNumber1【隐藏】Oracle监听端口
      ora_script_pathString[BK] 脚本路径
      ora_passwdStringInfo1234【隐藏】Oracle SYS用户密码
      ora_home_pathStringOracle数据库Home目录
    wk_data_typeNumber9源类型:
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_nameString规则名称
    backup_typeNumber1规则类型:
0:备份;
10:备份模板;
    oracle_rman_settingsObjectORACLE RMAN配置信息
      rman_skip_offlineNumber0表空间选项,跳过脱机数据文件
      rman_num_streams_archNumber1归档选项,并行流数
      rman_del_archNumber1归档选项,备份后删除
      rman_include_arch_flagNumber1归档选项,将归档重做日志包括在全备的和增量的备份计划中
      rman_num_streams_dfNumber1表空间选项,并行流数
      rman_filespertset_archNumber20归档选项,每个备份集文件数
      rman_maxsetsize_dfNumber0表空间选项,备份集大小(KB)
      rman_set_limit_arch_flagNumber0归档选项,指定最高限额
      rman_skip_readonlyNumber0表空间选项,跳过脱机数据文件
      rman_maxsetsize_archNumber0归档选项,备份集大小(KB)
      rman_cold_bkupNumber0表空间选项,离线(冷)数据库备份
      rman_filespertset_dfNumber20表空间选项,每个备份集文件数
    bk_data_typeNumber1目标类型:
1:文件;
2:raw;
10:备份快照;
11:合成备份;
    mssql_settingsObjectMSSQL配置信息
      instance_nameStringsql server 实例名,默认是MSSQLSERVER
      time_outString2连接超时设定(秒):
      data_sourceString[BK] 数据源名称
      dbsizeString
      win_verifyNumber0登录SQL Server服务器的信息:0:用mssql用户名密码;1:用winNT集成设置;
      user_idStringsql server 用户名,用winNT集成设置不填
      db_infoArray库信息,同时用来存放子任务信息
        task_uuidString子规则uuid
        db_nameString[BK] 备份数据库名称
      pass_wordStringsql server 密码,用winNT集成设置不填
    wk_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3工作机uuid
    bk_uuidStringGrey灾备机uuid
    bkup_policyNumber0策略类型:
0:一次性;
1:周期;
2:立即执行;
    bkup_scheduleArray
      limitNumber50数据保留期限(天)
      sched_dayNumber24哪几天
      sched_everyNumber2周期策略:
0:每天;
1:每周:
2:每月;
3:每隔
      sched_timeString17:16哪几点
      sched_gap_minNumber41间隔分钟数
    task_typeNumber0规则类型:
0:备份;
10:备份模板;
    can_opNumber1是否可操作:
0:否;
1:是;
    can_upNumber1是否可更新:
0:否;
1:是;
    can_delNumber1是否可删除:
0:否;
1:是;
    task_uuidString38FFA6E2-2A40-31D6-7A94-E8168EBA9FF2规则uuid
    last_resultObject上次执行结果
      backup_typeStringo备份类型:
o:全量;
i:增量;
d:差异;
      end_timeString2020-09-14 19:00:00结束时间
      resultString0结果:
0:成功;
小于0:失败;
    last_success_resultObject
      backup_typeStringo备份类型:
o:全量;
i:增量;
d:差异;
      end_timeString2020-09-14 19:00:00结束时间
      resultString0结果:
0:成功;
小于0:失败;
    archive_penNumber是否开启磁带库归档:
0:否;
1:是;
    tape_uuidString带库uuid
    library_snString带库序列号
    tape_node_uuidString磁带库关联节点uuid
    group_uuidString组uuid(mssql多库)
    is_groupNumber0多库备份 - 是否组规则:
0:否;
1:是;
    childrenArray子任务列表
  messageString[0] success
  codeNumber0
retNumber200

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

SDK方法名:listTimingBackupStatus

URL

/timing/backup/status

Method

GET

Request

名称类型必选初始值简介Mock规则
task_uuidsArray["11111111-1111-1111-1111-111111111111"]必传,uuid数组,页面加载第一次获取状态一个一个获取,之后是批量获取;
(不论组还是子,都传task_uuid)

Response

名称类型必选初始值简介Mock规则
msgString@mock=
dataObject
  codeNumber0@mock=0
  messageString[0] success@mock=[0] success
  countNumber0@mock=0
  statusArray
    statusStringMIRROR状态文字:
UNKNOWN:未知;
FINISH:完成;
STOP:停止;
PENDING:等待;
MIRROR:镜像;
CALC:计算;
PREPARING:准备;
    progressNumber0@mock=0, 进度
    totalNumber100@mock=100, 总大小
    curNumber, 当前大小
    f_curNumber, 当前文件数
    task_uuidString38FFA6E2-2A40-31D6-7A94-E8168EBA9FF2@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 任务UUID
    f_totalNumber0@mock=0, 文件总数
retNumber200@mock=200

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

SDK方法名:deleteTimingBackup

URL

/timing/backup

Method

DELETE

Request

名称类型必选初始值简介Mock规则
task_uuidsArray["11111111-1111-1111-1111-111111111111"]*规则数组
del_policyNumber*删除策略,0:不开启;1:开启;
forceNumber1 - 强制删除 0 - 非强制删除

Response

名称类型必选初始值简介Mock规则
msgString
dataObject
  codeNumber11110001
  messageString
  fail_listArray
    codeNumber11110001
    messageString[-1] 离线
    task_uuidString@guid
    task_nameStringtest2
  success_listArray
    codeNumber11110001
    messageString[0] success
    task_uuidString@guid
    task_nameStringtest1
retNumber200

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

SDK方法名:

启动:startTimingBackup;

停止:stopTimingBackup;

立即执行:startImmediateTimingBackup;

URL

/timing/backup/operate

Method

POST

Request

名称类型必选初始值简介Mock规则
operateStringstartstart, stop, start_immediately
task_uuidsArray["11111111-1111-1111-1111-111111111111"]必传,规则数组
bk_typeNumber立即执行操作(start_immediately)必传,取值为,备份策略 - 周期任务 - 备份方式;0:全备,1:增量,2:差异

Response

名称类型必选初始值简介Mock规则
dataObject
  codeNumber0@mock=0
  messageString[0] success@mock=[0] success
  success_listArray
  fail_listArray
    task_uuidString
    codeString
    messageString
    task_nameString
msgString@mock=
retNumber200@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_uuidStringB8566905-411E-B2CD-A742-77B1346D8E84, 备机节点uuid
rc_data_pathStringE:\mssqlBK\ts-11111111-1111-1111-1111-111111111111\, 备份数据路径

Response

名称类型必选初始值简介Mock规则
msgString@mock=
retNumber200@mock=200
dataObject
  mssql_time_listArray
  codeNumber0@mock=0
  messageString[0] success@mock=[0] success

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

SDK方法名:describeTimingRecoveryMssqlInitInfo

URL

/timing/recovery/rc_mssql_init_info

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
retNumber200
dataObject
  messageString[0] success
  mssql_init_infoObject
    src_db_nameString141414[RC] 原数据库名称
    db_sizeString12[RC] 数据库大小
    user_idString
    instance_nameString
    win_verifyString
    tab_numString
    tab_infoString
    ln_numString
    check_outString
    lgc_nameStringtest*test_log[RC] 原数据库逻辑名(多行以*隔开,与lgc_path一一对应)
    lgc_pathStringC:\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_numNumber2[RC] lgc_name 、lgc_path 的行数
  codeNumber0
msgString

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

SDK方法名:listTimingRecoveryPathList

URL

/timing/recovery/rc_path_list

Method

GET

Request

名称类型必选初始值简介Mock规则
bk_uuidStringB8566905-411E-B2CD-A742-77B1346D8E84备机节点uuid
rc_data_pathStringC:\back\备份数据路径
backup_task_uuidString11111111-1111-1111-1111-111111111111[RC] 备份的uuid,用来即时恢复,可选参数

Response

名称类型必选初始值简介Mock规则
retNumber200
dataObject
  codeNumber0
  messageString[0] success
  mirr_blk_sizeNumber32768
  backup_taskObject
    backup_typeNumber0
    wk_pathArrayE:工作路径
    bk_pathArrayF:\e\备份路径
    task_uuidStringF06D82E4-ACBE-56B9-5B02-75BDC30B41E7
    blk_direct_copyNumber
    mount_pointString/test挂载点
  recovery_taskObject
    wk_data_typeNumber13源类型,0:块设备;1:文件;3:oracle;4:mssql;
    rc_time_point_listArray['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_typeNumber1目标类型,1:文件;2:raw数据;
    bk_pathArrayF:\e\2018-01-02_10-54-42\E备份路径
    res_by_pathString
    volume_uuidStringB8566905-411E-B2CD-A742-77B1346D8E85文件还原,复制卷uuid
msgString

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

SDK方法名:verifyTimingRecoveryMssqlInfo

URL

/timing/recovery/rc_verify_mssql_info

Method

POST

Request

名称类型必选初始值简介Mock规则
mssql_settingsObject, mssql 设置(基本设置)
  win_verifyNumber0@mock=0, 登录SQL Server服务器的信息:0:用mssql用户名密码;1:用winNT集成设置;
  pass_wordString123456, sql server 密码,用winNT集成设置不填
  instance_nameStringMSSQLSERVER, sql server 实例名,默认是MSSQLSERVER
  user_idStringsa, sql server 用户名,用winNT集成设置不填
  data_sourceString主机名
  portString当网络协议类型为TCP/IP时,默认值1433
  protocolNumber0:shared memory,1:TCP/IP,默认值 0
wk_uuidString67E33CDB-D75B-15B3-367D-50C764F5A26F@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 还原目标端id

Response

名称类型必选初始值简介Mock规则
dataObject
  messageString[0] success@mock=[0] success
  codeNumber0@mock=0
msgString@mock=
retNumber200@mock=200

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

SDK方法名:listTimingRecoveryOracleRcPointInfo;

URL

/timing/recovery/rc_sbt

Method

GET

Request

名称类型必选初始值简介Mock规则
pageNumber第几页
limitNumber每页记录数
bk_uuidString
bk_pathString

Response

名称类型必选初始值简介Mock规则
msgString
retNumber200
dataObject
  record_infoObject
    totalNumber100
    listArray
      log_threadNumber1
      log_seqNumber527
      scnNumber18614069
      timeString2020/05/07-17:55:48
      arch_fileStringinfo2_arch_s938_p1_t1039802149[隐藏] 下发给底层用
  range_infoObject
    scn_minNumber1
    scn_maxNumber527
    time_minString2020-05-07 17:55:48
    time_maxString2020-05-08 19:21:50
    log_seq_maxNumber
    log_seq_minNumber
  codeNumber0
  messageString[0] success

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

SDK方法名:describeRcMysqlInfo;

URL

/timing/recovery/rc_mysql_info

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString
  info_listObject
    pool_nameString
    volume_nameString
    volume_uuidString
    log_ccopyString
    log_volume_nameString
    log_volume_uuidString
    log_pool_nameString

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

SDK方法名:listSbtContrlFile;

URL

/timing/recovery/sbt_contrlfile

Method

GET

Request

名称类型必选初始值简介Mock规则
rc_data_pathString
ora_content_typeNumber还原的选项,6:控制文件,7:参数文件
bk_uuidString

Response

名称类型必选初始值简介Mock规则
retNumber200
dataObject
  info_listArray["adfdasfda","adfdaf","adfdafdaf"]
  messageString[0] success
  codeNumber0
msgString

恢复 获取DBID

SDK方法名:describeSbtDbid;

URL

/timing/recovery/sbt_dbid

Method

GET

Request

名称类型必选初始值简介Mock规则
file_nameString所选择的文件名称
bk_uuidString

Response

名称类型必选初始值简介Mock规则
retNumber200
dataObject
  dbidStringtest
  messageString[0] success
  codeNumber0
msgString

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

SDK方法名:createTimingRecovery

URL

/timing/recovery

Method

POST

Request

名称类型必选初始值简介Mock规则
timing_recoveryObject
  task_nameStringtask任务名
  backup_task_uuidString[RC] 备份的uuid,用来即时恢复
  backup_typeNumber0[RC] 还原方式(文件还原用),0:全备;1:增量;2:差异;
  bk_data_typeNumber1备机目录类型,1:文件;2:raw数据;
  bk_uuidStringB8566905-411E-B2CD-A742-77B1346D8E84备机节点uuid
  bk_pathArray["E:\t\2019-01-15_15-49-00\E\test\"]备机路径(在复制规则目标节点上),数据库还原不传
  wk_data_typeNumber1工作机目录类型,0:块设备;1:文件;3:oracle;4:mssql;6:db2;
  wk_uuidString67E33CDB-D75B-15B3-367D-50C764F5A26F工作机节点uuid
  rc_styleNumber1[RC] 恢复方式 blk_recovery_style,0:恢复到工作机;1:在备机合到指定目录;
  wk_pathArray["E:\test\"][RC] 新数据库文件存放路径,也是“在备机合到指定目录”的目录。旧版:db_file_save_path
  excl_pathArray排除路径数组
  rc_point_in_timeString2019-01-15_15-49-00[RC] 还原时间点 rawfile
  rc_data_pathStringE:\t\[RC] 备份数据路径
  blk_direct_copyNumber块备份,直接拷贝,取值为 rc_path_list 返回的同名参数;
  oracle_settingsObjectoracle 设置(基本设置)
    ora_login_nameString[RC] oracle验证账户
    ora_login_pwdString[RC] oracle验证密码
    ora_portNumber1【隐藏】Oracle监听端口
    ora_passwdStringInfo1234【隐藏】Oracle SYS用户密码
    ora_sid_nameStringOracle数据库实例名
    ora_home_pathStringOracle数据库Home目录
    ora_content_typeNumber0备份内容:
0:整库;
1:表空间;
2:数据文件;
3:PDBS;
4:CDB;
5:ARCHIVELOG;
6:CONTROLFILE;
7:SPFILE;
8:TABLE;
    ora_do_restoreNumber0[RC] 还原(还原选项):
0:否;
1:是;
    ora_rst_limit_threadNumber1[RC] 还原到备份:线程
    ora_rst_typeNumber0[RC] 还原类型:
0:到最新;
1:到指定;
    ora_rst_recory_pointNumber[RC] 还原:
0:日志还原点选择 ;
1:时间/SCN还原点选择;
    ora_rst_limit_typeNumber0[RC] 还原到备份 类型:
0:日期;
1:SCN;
2:日志序列号;
    ora_rst_limit_dateString2017-12-21 13:26:00[RC] 还原到备份:日期
    ora_rst_limit_scnNumber0[RC] 还原到备份:SCN
    ora_rst_limit_log_seqString[RC] 还原到备份:日志序列号
    ora_rst_recordObject[RC] 还原:已选恢复点日志信息
    ora_do_recoveryNumber0[RC] 恢复(还原选项):
0:否;
1:是;
    ora_rc_point_threadNumber1[RC] 恢复到备份:线程
    ora_rc_typeNumber0[RC] 恢复类型:
0:到最新;
1:到指定;
    ora_rc_recory_pointNumber[RC] 恢复:
0:日志还原点选择;
1:时间/SCN还原点选择
    ora_rc_point_typeNumber0[RC] 恢复到备份 类型:
0:日期;
1:SCN;
2:日志序列号;
    ora_rc_point_dateString2017-12-21 13:26:00[RC] 恢复到备份:日期
    ora_rc_point_scnNumber0[RC] 恢复到备份:SCN
    ora_rc_point_log_seqString[RC] 恢复到备份:日志序列号
    ora_rc_recordObject[RC] 恢复:已选恢复点日志信息
    ora_pdbs_nameStringPDB,ora_content_type 为 PDBS 时必传,内容为逗号分隔的PDB名称
    ora_rst_arch_typeNumber归档日志还原类型,0:到最新;1:到指定;
    ora_rst_arch_limit_typeNumber归档日志还原到指定备份 类型,2: 日志序列号;
    ora_rst_arch_limit_log_seqNumber归档日志还原到备份 日志序列号
    ora_dbidStringDBID
    ora_rst_ctrl_nameString控制文件的备份文件名称
    ora_rst_spfile_pathString还原之后spfile的存放位置和名称
    ora_rst_spfile_nameString参数文件的备份文件名称
    snapshot_nameString[RC] 恢复快照名称
    snapshot_timeString[RC] 恢复快照时间点
    rst_controlNumber[RC] 是否恢复控制文件 勾选-1 不勾选-0
    ora_tab_modeNumber0数据库模式
0:CDB模式;
1:CDBRoots模式;
2:PDBs模式;
    ora_tab_pdb_nameString''选择PDBs模式后,输入PDB的名称
    ora_tab_namesArray
      userString用户名
      ori_tableString原表名
      tgt_tableString目标表名
    ora_tab_aux_pathString辅助实例存放路径
  mssql_settingsObjectmssql 设置(基本设置)
    instance_nameStringsql server 实例名,默认是MSSQLSERVER
    win_verifyNumber0登录SQL Server服务器的信息:0:用mssql用户名密码;1:用winNT集成设置;
    user_idStringsql server 用户名,用winNT集成设置不填
    pass_wordStringsql server 密码,用winNT集成设置不填
    time_outString连接超时设定(秒):
    data_sourceString数据源名称
    portString当网络协议类型为TCP/IP时,默认值1433
    protocolNumber0:shared memory,1:TCP/IP,默认值 0
    db_infoArray库信息,同时用来存放子任务信息
      src_db_nameString[RC] 原数据库名称
      db_nameString
      lgc_infosArray
        lgc_nameStringtest[RC] 原数据库逻辑名
        lgc_pathStringC:\Program Files\Microsoft SQL Server\MSSQL12.MSSQLSERVER\MSSQL\DATA\test.mdf[RC] 原数据库文件路径
      rc_point_in_timeString2019-01-15_15-49-00[RC] 还原时间点 rawfile
      new_db_nameString[RC] 目标数据库名称
      db_file_save_pathString[RC] 目标数据库文件存放路径
      check_outString0是否开启还原完成后校验:
0:关;
1:开;
      db_sizeString[RC] 数据库大小
      tab_numString[RC] 数据库表个数
      tab_infoString[RC] 数据库表名
      ln_numString[RC] 数据库表行数
  db2_settingsObjectdb2 设置(基本设置)
    db2_userString
    db2_groupString
    log_file_dirString日志文件路径
    db_infoArray
      db_nameString源数据库名称
      new_db_nameString新数据库名
      db_pathString子任务数据库备份路径
      rc_point_in_timeString还原时间点
  compressString压缩:0不开启;1,低;2,中;3,高
  encrypt_switchString加密开关,0不开启,1开启
  secret_keyString加密key
  data_ip_uuidStringB8566905-411E-B2CD-A742-77B1346D8E84灾备机数据地址
  mysql_settingsObject
    pool_uuidString存储池ID
    pool_nameString存储池名称
    volume_uuidString复制卷ID
    volume_nameString复制卷名称
    attach_pointString挂载点
    mysql_portString端口
    mysql_userString用户名
    mysql_passwdString密码
    snapshot_nameString快照名称
    snapshot_timeString恢复时间点
    mysql_rc_typeNumber不完全恢复 (开1,关0)
    mysql_rc_timeString恢复时间点
    time_outNumber超时时间
    mysql_pathStringMySQL执行目录
    log_ccopyNumber日志持续复制开关
    log_volume_uuidString日志卷uuid
    log_mount_pointString日志卷在还原目标机的挂载点
    data_dirString
  oracle_rman_settingsObject
    rman_num_streams_dfNumber[RC] 并行流数
  synthetic_bkup_settingsObject合成备份参数
    mount_dirString挂载点
  db_nameString(GAUSS集群)数据库名称
  content_typeNumber0(gauss集群),0 整库 1 表
  tablesString数据表名称,多个表之间用空格隔开(gauss集群)
  res_by_pathString''
  informix_settingsObjectinformix 基本设置
    oper_userString【BK】操作用户,默认为informix
    is_ori_machineNumber【RC】是否恢复到原机: 1-是 0-否
  thread_numNumber1并行任务数
  protocolStringmysql 链路协议:
iSCSI,FC
  fc_initiator_wwpnStringfc客户端wwpn
  fc_target_wwpnStringfc目标端wwpn
  data_returnNumber0Mysql、Oracle合成备份:
是否开启数据回传:
0:关;
1:开;
默认值为0;
  data_dirString''数据回传目录
forceBoolean

Response

名称类型必选初始值简介Mock规则
dataObject
  codeNumber0@mock=0
  messageString[0] success@mock=[0] success
msgString@mock=
retNumber200@mock=200

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

SDK方法名:modifyTimingRecovery

URL

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

Method

PUT

Request

名称类型必选初始值简介Mock规则
timing_recoveryObject
  wk_uuidString7AD64D7A-7D1D-AC51-5DF1-29A58345A288@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 工作机节点uuid
  task_nameStringtask@mock=task, 任务名
  random_strString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 用于防止并发修改的随机串
  wk_pathArray, [RC] 新数据库文件存放路径 db_file_save_path
  bk_data_typeNumber1@mock=1, 备机目录类型,1:文件;2:raw数据;
  bk_pathArray, 备机路径(在复制规则目标节点上),数据库还原不传
  backup_typeNumber0@mock=0, [RC] 还原方式,0:全备;1:增量;2:差异;
  oracle_settingsObject, oracle 设置(基本设置)
    ora_rc_point_threadNumber1@mock=1, [RC] 恢复到备份 线程
    ora_rc_point_dateString2017-12-21 13:26:00@mock=2017-12-21 13:26:00, [RC] 恢复到备份 日期
    ora_passwdStringInfo1234@mock=Info1234, 【隐藏】Oracle SYS用户密码
    ora_portNumber1@mock=1, 【隐藏】Oracle监听端口
    ora_rc_point_typeNumber0@mock=0, [RC] 恢复到备份 类型,0:日期;1:SCN;2:日志序列号;
    ora_do_recoveryNumber0@mock=0, [RC] 恢复(还原选项),0:否;1:是;
    ora_do_restoreNumber0@mock=0, [RC] 还原(还原选项),0:否;1:是;
    ora_home_pathString@mock=, Oracle数据库Home目录
    ora_rst_typeNumber0@mock=0, [RC] 还原类型,0:到最新;1:到指定;
    ora_rst_limit_typeNumber0@mock=0, [RC] 还原到备份 类型,0:日期;1:SCN;2:日志序列号;
    ora_sid_nameString@mock=, Oracle数据库实例名
    ora_rst_limit_threadNumber1@mock=1, [RC] 还原到备份 线程
    ora_rst_limit_dateString2017-12-21 13:26:00@mock=2017-12-21 13:26:00, [RC] 还原到备份 日期
    ora_content_typeNumber0@mock=0, 0:整库;1:表空间;2:数据文件;
    ora_rst_limit_log_seqString@mock=, [RC] 还原到备份 日志序列号
    ora_rst_limit_scnNumber0@mock=0, [RC] 还原到备份 SCN
    ora_rc_typeNumber0@mock=0, [RC] 恢复类型,0:到最新;1:到指定;
    ora_rc_point_log_seqString@mock=, [RC] 恢复到备份 日志序列号
    ora_rc_point_scnNumber0@mock=0, [RC] 恢复到备份 SCN
  bk_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机节点uuid
  task_uuidString7AD64D7A-7D1D-AC51-5DF1-29A58345A288@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 任务id,如果节点和规则id都不传,则全部
  backup_task_uuidString@mock=, [RC] 备份的uuid,用来即时恢复
  mssql_settingsObject, mssql 设置(基本设置)
    win_verifyNumber0@mock=0, 登录SQL Server服务器的信息:0:用mssql用户名密码;1:用winNT集成设置;
    mdf_nameString@mock=, [RC] 原数据库逻辑名(MDF)
    src_db_nameString@mock=, [RC] 原数据库名称
    user_idString, sql server 用户名,用winNT集成设置不填
    ldf_nameString@mock=, [RC] 原数据库逻辑名(LDF)
    ldf_pathString@mock=, [RC] 原数据库文件路径(LDF)
    instance_nameString, sql server 实例名,默认是MSSQLSERVER
    pass_wordString, sql server 密码,用winNT集成设置不填
    db_file_save_pathString@mock=, [RC] 新数据库文件存放路径
    mdf_pathString@mock=, [RC] 原数据库文件路径(MDF)
    new_db_nameString@mock=, [RC] 新数据库名称
  db2_settingsObject
    db2_userString
    db2_groupString
    log_file_dirString
    db_infoArray
      task_uuidString
      task_nameString
      db_nameString
      new_db_nameString
      db_pathString
      rc_point_in_timeString
  rc_data_pathStringC:\back\@mock=C:\back\, [RC] 备份数据路径
  rc_styleNumber1@mock=1, [RC] 恢复方式 blk_recovery_style,0:恢复到工作机;1:在备机合到指定目录;
  wk_data_typeNumber0@mock=0, 工作机目录类型,0:块设备;1:文件;3:oracle;4:mssql;
  rc_point_in_timeString2017-12-21_13-16-53@mock=2017-12-21_13-16-53, [RC] 还原时间点 rawfile
  excl_pathArray
  data_ip_uuidString7AD64D7A-7D1D-AC51-5DF1-29A58345A288灾备机数据地址
  res_by_pathString''
  data_returnNumber0
  data_dirString''
forceBoolean

Response

名称类型必选初始值简介Mock规则
msgString@mock=
dataObject
  codeNumber0@mock=0
  messageString[0] success@mock=[0] success
retNumber200@mock=200

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

SDK方法名:describeTimingRecovery

URL

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

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
msgString@mock=
retNumber200@mock=200
dataObject
  timing_recoveryObject
    wk_data_typeNumber3@mock=0, 工作机目录类型,0:块设备;1:文件;3:oracle;4:mssql;9: mysql;
    backup_typeNumber0@mock=0, [RC] 还原方式,0:全备;1:增量;2:差异;
    task_uuidString7AD64D7A-7D1D-AC51-5DF1-29A58345A288@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 任务id,如果节点和规则id都不传,则全部
    backup_task_uuidString@mock=, [RC] 备份的uuid,用来即时恢复
    wk_uuidString7AD64D7A-7D1D-AC51-5DF1-29A58345A288@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 工作机节点uuid
    bk_data_typeNumber10@mock=1, 备机目录类型,1:文件;2:raw数据;10: 快照
    rc_data_pathStringC:\back\@mock=C:\back\, [RC] 备份数据路径
    task_nameStringtask@mock=task, 任务名
    oracle_settingsObject, oracle 设置(基本设置)
      ora_rc_point_threadNumber1@mock=1, [RC] 恢复到备份 线程
      ora_rst_limit_dateString2017-12-21 13:26:00@mock=2017-12-21 13:26:00, [RC] 还原到备份 日期
      ora_content_typeNumber0@mock=0, 0:整库;1:表空间;2:数据文件;
      ora_do_recoveryNumber0@mock=0, [RC] 恢复(还原选项),0:否;1:是;
      ora_sid_nameString@mock=, Oracle数据库实例名
      ora_rst_limit_threadNumber1@mock=1, [RC] 还原到备份 线程
      ora_rst_limit_typeNumber0@mock=0, [RC] 还原到备份 类型,0:日期;1:SCN;2:日志序列号;
      ora_rc_typeNumber1@mock=0, [RC] 恢复类型,0:到最新;1:到指定;
      ora_rst_typeNumber0@mock=0, [RC] 还原类型,0:到最新;1:到指定;
      ora_rst_limit_log_seqString@mock=, [RC] 还原到备份 日志序列号
      ora_home_pathString@mock=, Oracle数据库Home目录
      ora_do_restoreNumber0@mock=0, [RC] 还原(还原选项),0:否;1:是;
      ora_rc_point_dateString2017-12-21 13:26:00@mock=2017-12-21 13:26:00, [RC] 恢复到备份 日期
      ora_rc_point_typeNumber2@mock=0, [RC] 恢复到备份 类型,0:日期;1:SCN;2:日志序列号;
      ora_rc_point_scnNumber0@mock=0, [RC] 恢复到备份 SCN
      ora_rst_limit_scnNumber0@mock=0, [RC] 还原到备份 SCN
      ora_passwdStringInfo1234@mock=Info1234, 【隐藏】Oracle SYS用户密码
      ora_rc_point_log_seqString333@mock=, [RC] 恢复到备份 日志序列号
      ora_portNumber1@mock=1, 【隐藏】Oracle监听端口
      snapshot_timeString2019-01-01 17:55:22
    rc_point_in_timeString2017-12-21_13-16-53@mock=2017-12-21_13-16-53, [RC] 还原时间点 rawfile
    rc_styleNumber1@mock=1, [RC] 恢复方式 blk_recovery_style,0:恢复到工作机;1:在备机合到指定目录;
    wk_pathArray, [RC] 新数据库文件存放路径 db_file_save_path
    random_strString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 用于防止并发修改的随机串
    bk_pathArray, 备机路径(在复制规则目标节点上),数据库还原不传
    bk_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机节点uuid
    db2_settingsObject
      db2_userString
      db2_groupString
      log_file_dirString
      db_infoArraydb2_test
        task_uuidString
        task_nameString
        db_nameString
        new_db_nameString
        db_pathString
        rc_point_in_timeString
    mssql_settingsObject, mssql 设置(基本设置)
      ldf_pathString@mock=, [RC] 原数据库文件路径(LDF)
      src_db_nameString@mock=, [RC] 原数据库名称
      mdf_nameString@mock=, [RC] 原数据库逻辑名(MDF)
      ldf_nameString@mock=, [RC] 原数据库逻辑名(LDF)
      new_db_nameString@mock=, [RC] 新数据库名称
      db_file_save_pathString@mock=, [RC] 新数据库文件存放路径
      mdf_pathString@mock=, [RC] 原数据库文件路径(MDF)
      instance_nameString, sql server 实例名,默认是MSSQLSERVER
      win_verifyNumber0@mock=0, 登录SQL Server服务器的信息:0:用mssql用户名密码;1:用winNT集成设置;
    data_ip_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3灾备机数据地址
    res_by_pathString''
    data_returnNumber0
    data_dirString''
  messageString[0] success@mock=[0] success
  codeNumber0@mock=0

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

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

URL

/timing/recovery

Method

GET

Request

名称类型必选初始值简介Mock规则
search_valueString, 可选,搜索字段对应值(可以模糊)
pageNumber, 可选,不传就是全部
limitNumber, 可选,不传就是全部
search_fieldString, 可选,搜索字段

Response

名称类型必选初始值简介Mock规则
retNumber200@mock=200
dataObject
  info_listArray
    bk_node_nameString@pick(["kevin", "Jane", "Grey"])@mock=@pick(["kevin", "Jane", "Grey"]), 备机节点名
    wk_node_nameString@pick(["Smith", "Will", "Nary"])@mock=@pick(["Smith", "Will", "Nary"]), 工作机节点名
    task_nameStringtask_name@mock=task_name, 任务名
    wk_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机节点uuid
    usernameString@pick(["admin", "user"]), 所有者
    user_uuidString@pick(["1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC","1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC"]), 操作者用户名uuid
    task_uuidString7AD64D7A-7D1D-AC51-5DF1-29A58345A288@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 任务id,如果节点和规则id都不传,则全部
    bk_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机节点uuid
    can_delNumber1
    can_upNumber1
    can_opNumber1
    wk_data_typeNumber9
    group_uuidString
    is_groupNumber0
    childrenArray
  messageString[0] success@mock=[0] success
  codeNumber0@mock=0
  totalNumber100@mock=100, 规则总数
msgString@mock=

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

SDK方法名:listTimingRecoveryStatus

URL

/timing/recovery/status

Method

GET

Request

名称类型必选初始值简介Mock规则
task_uuidsArray["11111111-1111-1111-1111-111111111111"], 必传,uuid数组,页面加载第一次获取状态一个一个获取,之后是批量获取;

Response

名称类型必选初始值简介Mock规则
dataObject
  messageString[0] success@mock=[0] success
  codeNumber0@mock=0
  countNumber0@mock=0
  statusArray
    statusStringMIRROR@mock=STOP, 状态文字
    curNumber, 当前大小
    progressNumber0@mock=0, 进度
    f_totalNumber0@mock=0, 文件总数
    task_uuidString7AD64D7A-7D1D-AC51-5DF1-29A58345A288@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 任务id
    totalNumber100@mock=100, 总大小
    f_curNumber, 当前文件数
msgString@mock=
retNumber200@mock=200

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

SDK方法名:deleteTimingRecovery

URL

/timing/recovery

Method

DELETE

Request

名称类型必选初始值简介Mock规则
task_uuidsArray["11111111-1111-1111-1111-111111111111"], *规则数组
forceNumber1 - 强制删除 0 - 非强制删除
del_cloneNumber0快照备份,是否删除克隆卷:
0:不删除;
1:删除;
默认传0

Response

名称类型必选初始值简介Mock规则
msgString
dataObject
  codeNumber11110001
  messageString
  fail_listArray
    codeNumber11110001
    messageString[-1] 离线
    task_uuidString@guid
    task_nameStringtest1
  success_listArray
    codeNumber11110001
    messageString[0] success
    task_uuidString@guid
    task_nameStringtest2
retNumber200

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

SDK方法名:

启动:startTimingRecovery;

停止:stopTimingRecovery;

URL

/timing/recovery/operate

Method

POST

Request

名称类型必选初始值简介Mock规则
task_uuidsArray, start, stop 操作时必传,规则数组
operateStringstartstart:启动;
stop:停止;
unmount:快照备份,卸载;

Response

名称类型必选初始值简介Mock规则
msgString@mock=
dataObject
  codeNumber0@mock=0
  messageString[0] success@mock=[0] success
retNumber200@mock=200

2-4 恢复 mssql 获取单个组

SDK方法名:describeGroupTimingRecovery;

URL

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

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
msgString
retNumber200
dataObject
  timing_recoveryObject
    wk_data_typeNumber3
    task_nameStringtask
    backup_typeNumber0
    task_uuidString7AD64D7A-7D1D-AC51-5DF1-29A58345A288
    backup_task_uuidString
    wk_uuidString7AD64D7A-7D1D-AC51-5DF1-29A58345A288
    bk_data_typeNumber10
    rc_data_pathStringC:\back\
    mssql_settingsObject
      instance_nameString
      win_verifyNumber0
      user_idString
      pass_wordString
      time_outString
      data_sourceString
      portString
      protocolString
      db_infoArray
        src_db_nameString
        lgc_namesArray
          lgc_nameString
          lgc_pathString
        new_db_nameString
        db_file_save_pathString
        check_outString
        db_sizeString
        tab_numString
        tab_infoString
        ln_numString
    oracle_settingsObject
      ora_rc_point_threadNumber1
      ora_rst_limit_dateString2017-12-21 13:26:00
      ora_content_typeNumber0
      ora_do_recoveryNumber0
      ora_sid_nameString
      ora_rst_limit_threadNumber1
      ora_rst_limit_typeNumber0
      ora_rc_typeNumber1
      ora_rst_typeNumber0
      ora_rst_limit_log_seqString
      ora_home_pathString
      ora_do_restoreNumber0
      ora_rc_point_dateString2017-12-21 13:26:00
      ora_rc_point_typeNumber2
      ora_rc_point_scnNumber0
      ora_rst_limit_scnNumber0
      ora_passwdStringInfo1234
      ora_rc_point_log_seqString333
      ora_portNumber1
      snapshot_timeString2019-01-01 17:55:22
    rc_point_in_timeString2017-12-21_13-16-53
    rc_styleNumber1
    wk_pathArray
    random_strString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
    bk_pathArray
    bk_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
    db2_settingsObject
      new_db_nameStringdb2_test
    data_ip_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
    res_by_pathString''
    group_uuidString
  messageString[0] success
  codeNumber0

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

URL

/timing/recovery/db_info

Method

GET

Request

名称类型必选初始值简介Mock规则
bk_uuidString备份服务器uuid
rc_data_pathString恢复数据路径
wk_data_typeString4目标类型:
4:mssql;
6:db2;

不传默认为4

Response

名称类型必选初始值简介Mock规则
msgString
retNumber200
dataObject
  db_infosArray数据库信息列表
    db_nameStringaaa数据库名称
    db_pathString/afds数据库备份路径,用来作为获取备份时间点的参数
    rc_point_in_timeString2021-06-02_11-00-04最新备份时间点,格式:2021-06-02_11-00-04
    lgc_infosArray
      lgc_nameString源逻辑文件名
      lgc_pathString源物理文件路径
    bk_modeString
    db_sizeString数据库大小
    login_modeString登录模式,Windows NT或用户名密码登录
    inst_nameString实例名
  messageString[0] success
  codeNumber0

(废弃)策略 新建/编辑-1 策略 新建

URL

//policy

Method

POST

Request

名称类型必选初始值简介Mock规则
policyObject
  policy_typeNumber0策略类型: timing: 0
  policy_nameStringtest策略名
  bkup_policyNumber0备份策略,2 立即,0 定时,1 循环;
  bkup_windowObject运行时间范围
    sched_time_startString@time('HH:mm')运行时间范围 开始
    sched_time_endString@time('HH:mm')运行时间范围 结束
  bkup_one_timeNumber1515568566定时任务,执行时间(备份策略)
  policy_uuidString38FFA6E2-2A40-31D6-7A94-E8168EBA9FF1策略uuid
  bkup_scheduleArray周期任务(备份策略)
    limitNumber@integer(1, 64)数据保留期限(天)
    sched_dayArray"@integer(1, 31)"哪几天
    sched_everyNumber20:每天;1:每周:2:每月;3:每隔;
    sched_timeArray@time('HH:mm')哪几点
    sched_gap_minNumber@integer(1, 64)间隔分钟数

Response

名称类型必选初始值简介Mock规则
dataObject
  messageString[0] success@mock=[0] success
  codeNumber0@mock=0
retNumber200@mock=200
msgString@mock=

(废弃)策略 新建/编辑-2 策略 获取单个

URL

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

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
retNumber200@mock=200
msgString@mock=
dataObject
  codeNumber0@mock=0
  messageString[0] success@mock=[0] success
  policyObject
    create_timeNumber1515568566@mock=1515568566, 任务创建时间
    policy_uuidString38FFA6E2-2A40-31D6-7A94-E8168EBA9FF1@mock=38FFA6E2-2A40-31D6-7A94-E8168EBA9FF1, 策略uuid
    user_uuidString@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_typeNumber0@mock=0, 策略类型: timing: 0
    bkup_policyNumber0@mock=0, 备份策略,2 立即,0 定时,1 循环;
    bkup_scheduleArray, 周期任务(备份策略)
      sched_timeArray@time('HH:mm')@mock=@time('HH:mm'), 哪几点
      sched_dayArray"@integer(1, 31)"@mock="@integer(1, 31)", 哪几天
      sched_everyNumber2@mock=2, 0:每天;1:每周:2:每月;3:每隔;
      limitNumber@integer(1, 64)@mock=@integer(1, 64), 数据保留期限(天)
      sched_gap_minNumber@integer(1, 64)@mock=@integer(1, 64), 间隔分钟数
    bkup_windowObject, 运行时间范围
      sched_time_endString@time('HH:mm')@mock=@time('HH:mm'), 运行时间范围 结束
      sched_time_startString@time('HH:mm')@mock=@time('HH:mm'), 运行时间范围 开始
    bkup_one_timeNumber1515568566@mock=1515568566, 定时任务,执行时间(备份策略)
    policy_nameStringtest@mock=test, 策略名

(废弃)策略 新建/编辑-3 策略 修改

URL

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

Method

PUT

Request

名称类型必选初始值简介Mock规则
policyObject
  user_uuidString@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_policyNumber0@mock=0, 备份策略,2 立即,0 定时,1 循环;
  bkup_scheduleArray, 周期任务(备份策略)
    sched_timeArray@time('HH:mm')@mock=@time('HH:mm'), 哪几点
    limitNumber@integer(1, 64)@mock=@integer(1, 64), 数据保留期限(天)
    sched_dayArray"@integer(1, 31)"@mock="@integer(1, 31)", 哪几天
    sched_everyNumber2@mock=2, 0:每天;1:每周:2:每月;3:每隔;
    sched_gap_minNumber@integer(1, 64)@mock=@integer(1, 64), 间隔分钟数
  create_timeNumber1515568566@mock=1515568566, 任务创建时间
  policy_nameStringtest@mock=test, 策略名
  bkup_one_timeNumber1515568566@mock=1515568566, 定时任务,执行时间(备份策略)
  policy_typeNumber0@mock=0, 策略类型: timing: 0
  policy_uuidString38FFA6E2-2A40-31D6-7A94-E8168EBA9FF1@mock=38FFA6E2-2A40-31D6-7A94-E8168EBA9FF1, 策略uuid
  bkup_windowObject, 运行时间范围
    sched_time_endString@time('HH:mm')@mock=@time('HH:mm'), 运行时间范围 结束
    sched_time_startString@time('HH:mm')@mock=@time('HH:mm'), 运行时间范围 开始

Response

名称类型必选初始值简介Mock规则
dataObject
  codeNumber0@mock=0
  messageString[0] success@mock=[0] success
msgString@mock=
retNumber200@mock=200

(废弃)策略 列表-1 策略 获取列表

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

URL

//policy

Method

GET

Request

名称类型必选初始值简介Mock规则
limitNumber, 可选,不传就是全部
like_argsArray, 可选,多重搜索 , 字段 => 搜索值或值的数组
pageNumber, 可选,不传就是全部
where_argsArray, 可选,多重搜索 , 字段 => 搜索值或值的数组

Response

名称类型必选初始值简介Mock规则
retNumber200@mock=200
msgString@mock=
dataObject
  messageString[0] success@mock=[0] success
  totalNumber100@mock=100, 规则总数
  info_listArray10
    bkup_policyNumber0@mock=0, 备份策略,2 立即,0 定时,1 循环;
    user_uuidString@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_nameStringtest@mock=test, 策略名
    policy_uuidString38FFA6E2-2A40-31D6-7A94-E8168EBA9FF1@mock=38FFA6E2-2A40-31D6-7A94-E8168EBA9FF1, 策略uuid
    bkup_scheduleArray, 周期任务(备份策略)
      sched_everyNumber2@mock=2, 0:每天;1:每周:2:每月;3:每隔;
      sched_dayArray"@integer(1, 31)"@mock="@integer(1, 31)", 哪几天
      sched_timeArray@time('HH:mm')@mock=@time('HH:mm'), 哪几点
      sched_gap_minNumber@integer(1, 64)@mock=@integer(1, 64), 间隔分钟数
      limitNumber@integer(1, 64)@mock=@integer(1, 64), 数据保留期限(天)
    policy_typeNumber0@mock=0, 策略类型: timing: 0
    bind_numNumber3@mock=3, 绑定的任务数量
    create_timeNumber1515568566@mock=1515568566, 任务创建时间
    bkup_windowObject, 运行时间范围
      sched_time_endString@time('HH:mm')@mock=@time('HH:mm'), 运行时间范围 结束
      sched_time_startString@time('HH:mm')@mock=@time('HH:mm'), 运行时间范围 开始
    bkup_one_timeNumber1515568566@mock=1515568566, 定时任务,执行时间(备份策略)
  codeNumber0@mock=0

(废弃)策略 列表-3 策略 删除

URL

//policy

Method

DELETE

Request

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

Response

名称类型必选初始值简介Mock规则
msgString@mock=
retNumber200@mock=200
dataObject
  codeNumber0@mock=0
  messageString[0] success@mock=[0] success

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

SDK方法名:listTimingRecoveryDb2Time

URL

/timing/recovery/rc_db2_time

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
msgString
retNumber200
dataObject
  db2_time_listArray
  codeNumber0
  messageString[0] success

(废弃)策略 列表-4 策略 操作

URL

//policy/operate

Method

POST

Request

名称类型必选初始值简介Mock规则
policy_uuidsArray, *策略数组
operateStringbind@mock=bind, *bind

Response

名称类型必选初始值简介Mock规则
msgString@mock=
dataObject
  codeNumber0@mock=0
  messageString[0] success@mock=[0] success
retNumber200@mock=200

恢复 获取GAUSS还原时间点

SDK方法名:listTimingRecoveryGaussTime;

URL

/timing/recovery/gaussdb_rc_time

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
msgString
retNumber200
dataObject
  codeNumber0
  messageString[0] success
  timelistArray
    String
Last update: 11/23/2023, 10:43:57 AM
Contributors: ganl