全服务器保护

November 23, 2021About 61 min

全服务器保护

SDK类名:/fsp/FspBackup

------ 全服迁移 ------

URL

//dash/fsp_move

Method

GET

Request

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

Response

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

1 检测迁移条件-获取两节点网卡列表

SDK方法名:listFspMoveNic;

URL

//fsp/move/nic_list

Method

GET

Request

名称类型必选初始值简介Mock规则
bk_uuidStringF85DFEC0-149E-373D-0B9E-3DA9A5C43940@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机节点uuid
wk_uuidString42614852-BB62-1EF7-FED0-D2354BF3149D@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机节点uuid

Response

名称类型必选初始值简介Mock规则
dataObject
  bk_nic_listArray, 网卡列表3
    nameString@pick(["VMware Network Adapter VMnet8", "以太网", "VMware Network Adapter VMnet9"])@mock=@pick(["VMware Network Adapter VMnet8", "以太网", "VMware Network Adapter VMnet9"]), 网卡名
    ipString192.168.72.74/255.255.240.0@mock=192.168.72.74/255.255.240.0, 带子网掩码的ip
    typeString0@mock=0, 0: 静态; 1: dhcp;
  codeNumber0@mock=0
  messageString[0] success@mock=[0] success
  wk_nic_listArray, 网卡列表3
    nameString@pick(["Ethernet0", "Ethernet1", "Ethernet2"])@mock=@pick(["Ethernet0", "Ethernet1", "Ethernet2"]), 网卡名
    ipString192.168.72.73/255.255.240.0@mock=192.168.72.73/255.255.240.0, 带子网掩码的ip
    typeString0@mock=0, 0: 静态; 1: dhcp;
msgString@mock=
retNumber200@mock=200

1 检测迁移条件-获取源节点磁盘和文件列表

SDK方法名:listFspMoveDir;

URL

//fsp/move/dir_list

Method

GET

Request

名称类型必选初始值简介Mock规则
fsp_uuidString可选,编辑就传
wk_uuidString42614852-BB62-1EF7-FED0-D2354BF3149D工作机id

Response

名称类型必选初始值简介Mock规则
retNumber200@mock=200
dataObject
  codeNumber0@mock=0
  dir_listArray
    wk_pathStringC:\@mock=C:\, 源路径
    bk_pathStringC:\@mock=C:\, 目标路径,新建时没有这字段
    typeString@pick(["0", "1", "2"])@mock=@pick(["0", "1", "2"]), 0:路径磁盘后加FFO;1:不用加FFO;2:排除;
  messageString[0] success@mock=[0] success
  hd_listArray, 磁盘列表3
    is_systemNumber@pick(["0", "1"])@mock=@pick(["0", "1"]), 是系统盘1,不是0
    labelString@pick(["C:", "F:", "G:"])@mock=@pick(["C:", "F:", "G:"]), 卷标
  os_typeString@pick(["1", "2"])@mock=@pick(["1", "2"]), os类型 1linux 2win
msgString@mock=

1 检测迁移条件-检测迁移条件-磁盘

SDK方法名:verifyFspMoveVolumeSpace;

URL

//fsp/move/verify_volume_space

Method

POST

Request

名称类型必选初始值简介Mock规则
wk_uuidString42614852-BB62-1EF7-FED0-D2354BF3149D@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机节点uuid
bk_uuidStringF85DFEC0-149E-373D-0B9E-3DA9A5C43940@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机节点uuid
sync_itemString/@mock=C:\, 同步项目(磁盘),逗号分隔
wk_device_listArray
  nameString
bk_device_listArray
  nameString
is_block_moveNumber0是否块迁移,默认为0或者不传,是传1

Response

名称类型必选初始值简介Mock规则
retNumber200@mock=200
msgString@mock=
dataObject
  messageString[0] success@mock=[0] success
  bk_vol_listArray, 目标盘符列表
    sizeNumber4321@mock=4321, 总容量
    labelStringC:@mock=C:, 卷标
    freeNumber3234@mock=3234, 空闲容量
    is_systemNumber1@mock=1, 是系统盘1,不是0
  codeNumber0@mock=0
  wk_vol_listArray, 源盘符列表
    freeNumber1234@mock=1234, 空闲容量
    is_systemNumber1@mock=1, 是系统盘1,不是0
    labelStringC:@mock=C:, 卷标
    sizeNumber4321@mock=4321, 总容量

1 检测迁移条件-检测迁移条件-license

SDK方法名:verifyFspMoveLicense;

URL

//fsp/move/verify_license

Method

POST

Request

名称类型必选初始值简介Mock规则
wk_uuidString42614852-BB62-1EF7-FED0-D2354BF3149D@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机节点uuid
bk_uuidStringF85DFEC0-149E-373D-0B9E-3DA9A5C43940@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机节点uuid

Response

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

1 检测迁移条件-检测迁移条件-旧规则

SDK方法名:verifyFspMoveOldRule;

URL

//fsp/move/verify_old_rule

Method

POST

Request

名称类型必选初始值简介Mock规则
wk_uuidString42614852-BB62-1EF7-FED0-D2354BF3149D@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机节点uuid
bk_uuidStringF85DFEC0-149E-373D-0B9E-3DA9A5C43940@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机节点uuid

Response

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

1 检测迁移条件-检测迁移条件-系统版本

SDK方法名:verifyFspMoveOsVersion;

URL

//fsp/move/verify_os_version

Method

POST

Request

名称类型必选初始值简介Mock规则
bk_uuidStringF85DFEC0-149E-373D-0B9E-3DA9A5C43940@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机节点uuid
wk_uuidString42614852-BB62-1EF7-FED0-D2354BF3149D@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机节点uuid
modeNumber迁移场景:
0 - 物理机
1 - 虚拟机
2 - 自动
3 - 跨小版本

Response

名称类型必选初始值简介Mock规则
retNumber200@mock=200
dataObject
  wk_os_verStringMicrosoft Windows 10/x64 Edition@mock=Microsoft Windows 10/x64 Edition, 源机系统版本
  bk_os_verStringMicrosoft Windows 10/x64 Edition@mock=Microsoft Windows 10/x64 Edition, 目标系统版本
  messageString[0] success@mock=[0] success
  codeNumber0@mock=0
msgString@mock=

1 检测迁移条件 - 环境监测

SDK方法名:verifyFspMoveEnvironment;

URL

//fsp/move/verify_environment

Method

POST

Request

名称类型必选初始值简介Mock规则
wk_uuidString
bk_uuidString
wk_pathArray
  String
bk_pathArray
  String

Response

名称类型必选初始值简介Mock规则
msgString
dataObject
  messageString
  codeNumber0
retNumber200

新建 - 准备 - 获取源端驱动列表

SDK方法名:listFspMoveDriverInfo;

URL

//fsp/move/driver_info

Method

GET

Request

名称类型必选初始值简介Mock规则
wk_uuidString源机uuid

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString
  driver_listArray
    descString
    classString
    versionString
    dateString
    providerString
    infString

2 新建/编辑-新建规则

SDK方法名:createFspMove;

URL

//fsp/move

Method

POST

Request

名称类型必选初始值简介Mock规则
fsp_moveObject
  fsp_nameStringtestMove名字
  service_uuidString
  monitor_typeNumber0迁移设置:MSCS支持
  bk_pathArray["/I2FFO/bin/", "/I2FFO/boot/", "/I2FFO/etc/", "/I2FFO/lib/", "/I2FFO/lib64/", "/I2FFO/root/", "/I2FFO/sbin/", "/I2FFO/usr/bin/", "/I2FFO/usr/lib/", "/I2FFO/usr/lib64/", "/I2FFO/usr/libexec/", "/I2FFO/usr/local/", "/I2FFO/usr/sbin/", "/I2FFO/var/lib/nfs/"]备机(目标节点)路径,备份数据存放路径,云版可不填
  compressString0压缩:0不开启;1,低;2,中;3,高
  net_mappingArray网络设置:网卡映射
    bk_nicObject网卡列表
      nameStringEthernet0网卡名
      typeString0一般用获取网卡接口同样值即可; 0: 静态; 1: dhcp;
      ipString192.168.72.74/255.255.240.0带子网掩码的ip
    wk_nicObject网卡列表
      nameStringEthernet0网卡名
      typeString0一般用获取网卡接口同样值即可; 0: 静态; 1: dhcp;
      ipString192.168.72.73/255.255.240.0带子网掩码的ip
  bk_uuidStringF85DFEC0-149E-373D-0B9E-3DA9A5C43940备机(目标节点)的uuid ,云版可不填
  encrypt_switchString00不开启,1开启
  mirr_open_typeString0文件打开方式
  sync_itemString/同步项
  mirr_sync_flagString0错误处理方式
  net_mapping_typeString2网络设置:网络迁移配置,1:同步原机网络配置,2:不同步;
  mirr_sync_attrString1文件安全属性
  band_widthString带宽控制机,格式:303:00-14:002m,202:00-15:0080m
  excl_pathArray["/etc/X11/xorg.conf/", "/etc/init.d/i2node/", "/etc/rc.d/init.d/i2node/", "/etc/sdata/"]源机排除目录
  fsp_wk_shut_flagString2迁移设置:自动关工作机
  secret_keyString加密key
  wk_pathArray["/bin/", "/boot/", "/etc/", "/lib/", "/lib64/", "/root/", "/sbin/", "/usr/bin/", "/usr/lib/", "/usr/lib64/", "/usr/libexec/", "/usr/local/", "/usr/sbin/", "/var/lib/nfs/"]源路径
  mirr_file_checkString0校验方式
  wk_uuidString42614852-BB62-1EF7-FED0-D2354BF3149D工作机id
  failoverString0迁移设置,手工切换0,自动切换1(2019/1/15 向lianghr确认)
  random_strString11111111-1111-1111-1111-111111111111新建不用传
  excl_driverArray["inf1","inf2"]需要移除的驱动
  data_ip_uuidString42614852-BB62-1EF7-FED0-D2354BF3149D数据地址uuid
  wk_data_typeNumber1迁移类型:
0:块;
1:文件
  bk_file_cryptNumber0备端加密:0,1
  encryptNumber0加密类型:
0:不加密,
1:AES,
2:SM4,
  thread_numNumber1并行任务数

Response

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

2 新建/编辑-获取单个规则

SDK方法名:describeFspMove;

URL

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

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
msgString@mock=
dataObject
  fsp_moveObject
    mirr_sync_attrString1文件安全属性
    move_typeString0默认0
    fsp_typeString1迁移1 ,备份3,恢复5
    random_strString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3用于防止并发修改的随机串
    wk_portString26821控制机控制端口
    service_uuidString
    bk_ipString0.0.0.0备机控制地址
    encrypt_switchString00不开启,1开启
    fsp_wk_shut_flagString2迁移设置:自动关工作机
    wk_pathString["C:\","C:\Program Files (x86)\","C:\Program Files\","C:\ProgramData\","C:\Users\","C:\WINDOWS\","C:\Windows\","C:\program files (x86)\","C:\program files\","C:\programdata\","C:\users\","C:\windows\"]源路径
    net_mappingArray网络设置:网卡映射
    bk_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3备机(目标节点)的uuid ,云版可不填
    secret_keyString加密key
    bk_pathString["C:\","C:\I2FFO\Program Files (x86)\","C:\I2FFO\Program Files\","C:\I2FFO\ProgramData\","C:\I2FFO\Users\","C:\I2FFO\WINDOWS\","C:\I2FFO\Windows\","C:\I2FFO\program files (x86)\","C:\I2FFO\program files\","C:\I2FFO\programdata\","C:\I2FFO\users\","C:\I2FFO\windows\"]备机(目标节点)路径,备份数据存放路径,云版可不填
    compressString0压缩:0不开启;1,低;2,中;3,高
    mirr_open_typeString0文件打开方式
    failoverString0迁移设置,手工(0)/自动(1)切换
    mirr_file_checkString0校验方式
    bk_portString26831备机控制端口
    monitor_typeNumber0迁移设置:MSCS支持
    band_widthString303:00-14:002m带宽控制机,格式:303:00-14:002m,202:00-15:0080m
    fsp_nameStringrrrrr名字
    excl_pathString["C:\$Recycle.Bin\","C:\PerfLogs\","C:\Program Files (x86)\info2soft-i2node\","C:\ProgramData\Microsoft\Network\Downloader\","C:\ProgramData\Microsoft\Search\Data\Applications\Windows\","C:\ProgramData\Microsoft\Windows\WER\","C:\Recovery\","C:\System Volume Information\","C:\Users\Default\AppData\Local\Temp\","C:\Users\lianh\AppData\Local\Comms\UnistoreDB\","C:\Users\lianh\AppData\Local\Temp\","C:\Windows\CSC\","C:\Windows\Registration\","C:\Windows\SoftwareDistribution\","C:\Windows\System32\LogFiles\WMI\RtBackup\","C:\Windows\System32\MsDtc\MSDTC.LOG","C:\Windows\System32\MsDtc\Trace\dtctrace.log","C:\Windows\System32\catroot2\","C:\Windows\System32\config\systemprofile\","C:\Windows\System32\spp\tokens\","C:\Windows\Temp\","C:\Windows\assembly\NativeImages_v4.0.30319_32\Temp\","C:\Windows\bootstat.dat","C:\Windows\debug\","C:\bootmgr","C:\pagefile.sys","C:\swapfile.sys"]源机排除目录
    mirr_sync_flagString0错误处理方式
    wk_ipString0.0.0.0工作机控制地址
    sync_itemStringC:同步项
    net_mapping_typeString2网络设置:网络迁移配置
    wk_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3工作机id
    excl_driverArray["inf1","inf2"]
    data_ip_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3数据地址uuid
    thread_numNumber1并行任务数
  codeNumber0
  messageString
retNumber200

2 新建/编辑-修改规则

SDK方法名:modifyFspMove;

URL

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

Method

PUT

Request

名称类型必选初始值简介Mock规则
fsp_moveObject
  excl_pathArray["/cgroup/","/dev/","/etc/X11/xorg.conf/","/etc/init.d/i2node/","/etc/rc.d/init.d/i2node/","/etc/sdata/","/lost+found/","/media/","/mnt/","/proc/","/run/","/selinux/","/sys/","/tmp/","/usr/local/sdata/","/var/i2/","/var/i2data/","/var/lock/","/var/run/vmblock-fuse/"], 源机排除目录
  random_strString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 用于防止并发修改的随机串
  fsp_wk_shut_flagString2@mock=2, 迁移设置:自动关工作机
  monitor_typeNumber0@mock=0, 迁移设置:MSCS支持
  mirr_sync_attrString1@mock=1, 文件安全属性
  net_mapping_typeString2@mock=2, 网络设置:网络迁移配置
  mirr_sync_flagString0@mock=0, 错误处理方式
  mirr_file_checkString0@mock=0, 校验方式
  sync_itemString/@mock=C:, 同步项
  secret_keyString@mock=, 加密key
  failoverString0迁移设置,手工(0)/自动(1)切换
  fsp_nameStringchangeName@mock=rrrrr, 名字
  mirr_open_typeString0@mock=0, 文件打开方式
  bk_uuidStringC11FE572-5207-3359-DB85-001E95F5F185@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机(目标节点)的uuid ,云版可不填
  bk_pathArray["/","/I2FFO/bin/","/I2FFO/boot/","/I2FFO/etc/","/I2FFO/lib/","/I2FFO/lib64/","/I2FFO/root/","/I2FFO/sbin/","/I2FFO/usr/bin/","/I2FFO/usr/lib/","/I2FFO/usr/lib64/","/I2FFO/usr/libexec/","/I2FFO/usr/local/","/I2FFO/usr/sbin/","/I2FFO/var/lib/nfs/"], 备机(目标节点)路径,备份数据存放路径,云版可不填
  net_mappingArray, 网络设置:网卡映射
    wk_nicObject, 网卡列表
      ipString192.168.72.73/255.255.240.0@mock=192.168.72.73/255.255.240.0, 带子网掩码的ip
      typeString0@mock=0, 一般用获取网卡接口同样值即可; 0: 静态; 1: dhcp;
      nameStringEthernet0@mock=Ethernet0, 网卡名
    bk_nicObject, 网卡列表
      typeString0@mock=0, 一般用获取网卡接口同样值即可; 0: 静态; 1: dhcp;
      nameStringEthernet0@mock=Ethernet0, 网卡名
      ipString192.168.72.74/255.255.240.0@mock=192.168.72.74/255.255.240.0, 带子网掩码的ip
  service_uuidString@mock=, 空
  wk_uuidStringCE77F3D6-A6E3-A385-CE66-712313B7DDE8@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机id
  compressString0@mock=0, 压缩:0不开启;1,低;2,中;3,高
  encrypt_switchString0@mock=0, 0不开启,1开启
  move_typeString0@mock=0, 默认0
  wk_pathArray["/","/bin/","/boot/","/etc/","/lib/","/lib64/","/root/","/sbin/","/usr/bin/","/usr/lib/","/usr/lib64/","/usr/libexec/","/usr/local/","/usr/sbin/","/var/lib/nfs/"], 源路径
  band_widthString303:00-14:002m@mock=303:00-14:002m, 带宽控制机,格式:303:00-14:002m,202:00-15:0080m
  excl_driverArray["inf1","inf2"]需要移除的驱动
  data_ip_uuidStringCE77F3D6-A6E3-A385-CE66-712313B7DDE8数据地址
  thread_numNumber1并行任务数

Response

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

3 列表-删除规则

SDK方法名:deleteFspMove;

URL

//fsp/move

Method

DELETE

Request

名称类型必选初始值简介Mock规则
fsp_uuidsArray["11111111-1111-1111-1111-111111111111"]*规则数组
forceNumber1 - 强制删除 0 - 非强制删除

Response

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

3 列表-获取规则列表(基本信息)

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

URL

//fsp/move

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
dataObject
  info_listArray5
    fsp_uuidString@pick(["0DD4E727-70AB-62C6-BEB5-D012DFAE46E3", "0DD4E727-70AB-62C6-BEB5-D012DFAE46E4"])@mock=@pick(["0DD4E727-70AB-62C6-BEB5-D012DFAE46E3", "0DD4E727-70AB-62C6-BEB5-D012DFAE46E4"]), 规则UUID
    bk_pathStringC:\ascasldfjlksjf\@mock=C:\ascasldfjlksjf, 目标节点路径
    band_widthString@pick(["100", "150", "200"])@mock=@pick(["100", "150", "200"]), 带宽控制
    wk_node_nameString@pick(["Smith", "Will", "Nary"])@mock=@pick(["Smith", "Will", "Nary"]), 源节点名
    excl_pathString@mock=, 排除路径
    bk_uuidString7AD64D7A-7D1D-AC51-5DF1-29A58345A288@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 目标节点名
    wk_pathStringC:\123\@mock=C:\123, 源路径
    usernameString@pick(["admin", "user", "super"])@mock=@pick(["admin", "user", "super"]), 用户名
    bk_node_nameString@pick(["kevin", "Jane", "Grey"])@mock=@pick(["kevin", "Jane", "Grey"]), 目标节点名
    fsp_nameStringtestbak@mock=testbak, 规则名
    wk_uuidString7AD64D7A-7D1D-AC51-5DF1-29A58345A288@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 源节点名
    can_delNumber1
  totalNumber100@mock=100, 规则总数
  countNumber10@mock=10, 规则数量
  codeNumber0@mock=0
  messageString
retNumber200@mock=200
msgString@mock=

3 列表-规则操作

SDK方法名:startFspMove, stopFspMove, moveFspMove, rebootFspMove;

URL

//fsp/move/operate

Method

POST

Request

名称类型必选初始值简介Mock规则
operateStringstartstart, stop, move, reboot
fsp_uuidsArray["11111111-1111-1111-1111-111111111111"], *规则数组

Response

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

3 列表-规则状态

SDK方法名:listFspMoveStatus;

URL

//fsp/move/status

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
msgString@mock=
retNumber200@mock=200
dataObject
  codeNumber0@mock=0
  countNumber0@mock=0
  statusObject
    fsp_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 业务迁移uuid
    statusStringSTOP@mock=STOP, 状态文字:

块迁移:
UNKNOWN:未知:
FINISH:完成;
STOP:停止;
MIRROR:镜像;
PENDING:等待;
CALC:计算;
BLK_SAVE:数据保存中;
REPLICATION:复制;
FFO_IDLE, // 裸机迁移就绪

文件迁移:
UNKNOWN:未知;
FFO_IDLE:就绪;
FFO_MOVING:迁移中;
FFO_DONE:重启就绪;
FINISH:完成;
PREPARE:镜像;
FFO_ODD:异常;
FFO_BOOTING:正在重启...;
FFO_BOOTFAIL:备机重启失败 | 重启两个小时还获取不到状态,则算失败;
    timeString1629169301当前时间
    version_numberStringnull无效值
    validated_version_numberStringnull无效值
    latencyString0复制延迟ms
    wk_statusStringONLINE备机状态
    progressString0@mock=0, 进度
    blistNumber0遍历未完成:
0:否;
1:是;
    file_totalString0文件总数
    file_currentString0当前文件数
  messageString

业务迁移 - 批量创建

SDK方法名:batchCreateFspMove

URL

//fsp/move/batch

Method

POST

Request

名称类型必选初始值简介Mock规则
base_info_listObject
  band_widthString
  compressNumber0
  encrypt_switchNumber0
  mirr_open_typeString0
  mirr_sync_flagString0
  mirr_sync_attrString1
  fsp_wk_shut_flagNumber2
  mirr_file_checkString0
  failoverNumber0
  monitor_typeNumber0
  excl_driverArray["inf1","inf2"]
  net_mappingArray
    bk_nicObject
      nameStringEthernet0
      typeString0
      ipString192.168.72.74/255.255.240.0
    wk_nicObject
      nameStringEthernet0
      typeString0
      ipString192.168.72.73/255.255.240.0
  net_mapping_typeString2
  secret_keyString''
  service_uuidString''
node_listArray
  wk_uuidString
  bk_uuidString
  sync_itemString/同步项
  wk_pathArray
  bk_pathArray
  excl_pathArray
  proxy_uuidString代理节点uuid
  data_ip_uuidString数据地址uuid
common_paramsObject
  batch_nameString''
  rep_prefixString''
  rep_sufixString''
  variable_typeNumber0

Response

名称类型必选初始值简介Mock规则
msgString
retNumber200
dataObject
  messageString
  codeNumber0

------ 全服备份 ------

URL

//dash/fsp_backup

Method

GET

Request

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

Response

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

全服备份-0 获取两节点网卡列表

SDK方法名:listFspBackupNic

URL

//fsp/backup/nic_list

Method

GET

Request

名称类型必选初始值简介Mock规则
wk_uuidStringF85DFEC0-149E-373D-0B9E-3DA9A5C43940工作机id
bk_uuidString42614852-BB62-1EF7-FED0-D2354BF3149D备机(目标节点)的uuid

Response

名称类型必选初始值简介Mock规则
msgString@mock=
retNumber200@mock=200
dataObject
  bk_nic_listArray, 网卡列表3
    typeString0@mock=0
    ipString192.168.72.74/255.255.240.0@mock=192.168.72.74/255.255.240.0, 带子网掩码的ip
    nameString@pick(["VMware Network Adapter VMnet8", "以太网", "VMware Network Adapter VMnet9"])@mock=@pick(["VMware Network Adapter VMnet8", "以太网", "VMware Network Adapter VMnet9"]), 网卡名
  messageString[0] success@mock=[0] success
  codeNumber0@mock=0
  wk_nic_listArray, 网卡列表3
    ipString192.168.72.73/255.255.240.0@mock=192.168.72.73/255.255.240.0, 带子网掩码的ip
    typeString0@mock=0
    nameString@pick(["Ethernet0", "Ethernet1", "Ethernet2"])@mock=@pick(["Ethernet0", "Ethernet1", "Ethernet2"]), 网卡名

全服备份-0 获取源节点磁盘和文件列表

方法名:listFspBackupDir

URL

//fsp/backup/dir_list

Method

GET

Request

名称类型必选初始值简介Mock规则
wk_uuidStringF85DFEC0-149E-373D-0B9E-3DA9A5C43940@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机id
fsp_uuidString, 可选,编辑就传

Response

名称类型必选初始值简介Mock规则
retNumber200@mock=200
dataObject
  hd_listArray, 磁盘列表3
    is_systemNumber@pick(["0", "1"])@mock=@pick(["0", "1"]), 是系统盘1,不是0
    labelString@pick(["C:", "F:", "G:"])@mock=@pick(["C:", "F:", "G:"]), 卷标
  os_typeString@pick([0, 1])@mock=@pick([0, 1]), 系统: 0: linux, 1: windows
  codeNumber0@mock=0
  messageString[0] success@mock=[0] success
  dir_listArray5
    typeString@pick(["0", "1", "2"])@mock=@pick(["0", "1", "2"]), 0:路径磁盘后加FFO;1:不用加FFO;2:排除;
    wk_pathStringC:\@mock=C:\, 源路径
    bk_pathStringC:\@mock=C:\, 目标路径,新建时没有这字段
msgString@mock=

全服备份-1 检测条件-备份空间

方法名:verifyFspBackupCoopySpace

URL

//fsp/backup/verify_coopy_space

Method

POST

Request

名称类型必选初始值简介Mock规则
bk_pathArray["fsp_bk"]@mock=C:\ascasldfjlksjf, 目标节点路径,6.2 wk_path
bk_uuidStringF85DFEC0-149E-373D-0B9E-3DA9A5C43940@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机(目标节点)uuid
wk_uuidString42614852-BB62-1EF7-FED0-D2354BF3149D@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机id
excl_pathArray["/cgroup/","/dev/","/etc/X11/xorg.conf/","/etc/init.d/i2node/","/etc/rc.d/init.d/i2node/","/etc/sdata/","/lost+found/","/media/","/mnt/","/proc/","/run/","/selinux/","/sys/","/tmp/","/usr/local/sdata/","/var/i2/","/var/i2data/","/var/lock/","/var/run/vmblock-fuse/"]@mock=, 源机排除目录
wk_pathArray["/"]@mock=, 源路径
storage_left_sizeStringcdm时传:存储剩余大小;
非cdm时,不用传或传''

Response

名称类型必选初始值简介Mock规则
msgString@mock=
dataObject
  bk_disk_needNumber123456@mock=123456, 目标磁盘需要空间 (Linux 没这个)
  messageString[0] success@mock=[0] success
  codeNumber0@mock=0
  bk_disk_freeNumber654321@mock=654321, 目标磁盘空闲空间 (Linux 没这个)
retNumber200@mock=200

全服备份-1 检测条件-license

方法名:verifyFspBackupLicense

URL

//fsp/backup/verify_license

Method

POST

Request

名称类型必选初始值简介Mock规则
wk_uuidString42614852-BB62-1EF7-FED0-D2354BF3149D工作机id

Response

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

全服备份-1 检测条件-旧规则

方法名:verifyFspBackupOldRule

URL

//fsp/backup/verify_old_rule

Method

POST

Request

名称类型必选初始值简介Mock规则
bk_uuidStringF85DFEC0-149E-373D-0B9E-3DA9A5C43940@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机(目标节点)uuid
bk_pathArray["/fsp_bk/"]@mock=C:\ascasldfjlksjf, 目标节点路径,6.2 wk_path
wk_uuidString42614852-BB62-1EF7-FED0-D2354BF3149D@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机id

Response

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

全服备份-1 检测条件-系统版本

方法名:verifyFspBackupOsVersion

URL

//fsp/backup/verify_os_version

Method

POST

Request

名称类型必选初始值简介Mock规则
bk_uuidStringF85DFEC0-149E-373D-0B9E-3DA9A5C43940@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机(目标节点)uuid
wk_uuidString42614852-BB62-1EF7-FED0-D2354BF3149D@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机id

Response

名称类型必选初始值简介Mock规则
dataObject
  messageString[0] success@mock=[0] success
  codeNumber0@mock=0
  wk_os_verStringMicrosoft Windows 10/x64 Edition@mock=Microsoft Windows 10/x64 Edition, 目标系统版本
  bk_os_verStringMicrosoft Windows 10/x64 Edition@mock=Microsoft Windows 10/x64 Edition, 目标系统版本
msgString@mock=
retNumber200@mock=200

全服务器备份 - 获取节点设备列表

SDK方法名:listFspBackupDriverInfo;

URL

//fsp/backup/device_info

Method

GET

Request

名称类型必选初始值简介Mock规则
node_uuidString工作机uuid

Response

名称类型必选初始值简介Mock规则
dataObject
  messageString
  codeNumber0
  dev_listArray
    nameStringfnrlu
    sizeNumber7997189767647315
    attrString1
    leafNumber0
    is_dirNumber1
    has_policyNumber
    childrenArray
      nameStringlvm1
      sizeNumber2059209815596581
  node_uuidString
retNumber200
msgString

全服备份-2 新建规则

方法名:createFspBackup

URL

//fsp/backup

Method

POST

Request

名称类型必选初始值简介Mock规则
fsp_backupObject
  fsp_typeNumber3任务类型:
3:备份
5:还原;
8:CDM整机复制
10:备份模板;
11:还原模板;
13:CDM整机复制模板
  secret_keyString加密key
  band_widthString带宽控制机,格式:303:00-14:002m,202:00-15:0080m
  mirr_open_typeString0文件打开方式
  service_uuidString
  mirr_sync_flagString0错误处理方式
  excl_pathArray["/cgroup/","/dev/","/etc/X11/xorg.conf/","/etc/init.d/i2node/","/etc/rc.d/init.d/i2node/","/etc/sdata/","/lost+found/","/media/","/mnt/","/proc/","/run/","/selinux/","/sys/","/tmp/","/usr/local/sdata/","/var/i2/","/var/i2data/","/var/lock/","/var/run/vmblock-fuse/"]源机排除目录
  bkup_one_timeNumber0定时任务,执行时间(备份策略)
  encrypt_switchString00不开启,1开启
  mirr_sync_attrString1文件安全属性
  bk_uuidStringF85DFEC0-149E-373D-0B9E-3DA9A5C43940备机(目标节点)的uuid ,云版可不填
  wk_data_typeNumber1源类型,0:块设备;1:文件;
  bk_pathArray["/fsp_bk/"]备机(目标节点)路径,备份数据存放路径,
!!!CDM:传空!!!
云版可不填
  sync_itemString/同步项
  bkup_policyNumber2备份策略:
0:一次性;
1:周期;
  start_typeNumber0启动方式:
0:立即启动;
1:手动启动;
2:预约启动;
  mirr_file_checkString0校验方式
  compressString0压缩:0不开启;1,低;2,中;3,高
  monitor_typeNumber0迁移设置:MSCS支持
  failoverNumber0是否支持备端拉起,1是0否;默认1;这个开关只有 文件到vmdk才需要显示(2019/1/15 向lianghr确认)
  wk_pathArray["/"]源路径
  fsp_nameStringtest名字
  wk_uuidString42614852-BB62-1EF7-FED0-D2354BF3149D工作机id
  fsp_wk_shut_flagString2迁移设置:自动关工作机
  bk_data_typeNumber1目标类型,
1:文件;
2:raw;
3:vmdk;
4:qcow;
5 华为云;
7:容灾平台;
8: vmware;
  bkup_scheduleArray周期任务(备份策略)
    sched_dayArray"@integer(1, 31)"哪几天
    sched_timeArray@time('HH:mm')哪几点
    sched_everyNumber20:每天;1:每周:2:每月;3:每隔;
    limitNumber@integer(1, 64)数据保留期限(天)
    backup_typeNumber00 全备,1 差异,2增量
    policysString"每天22:00自动执行"
    backup_type_showString"全备"
    running_timeString"22:00"
  random_strString11111111-1111-1111-1111-111111111111修改传这个,新建不传
  del_policyNumber删除策略,0:不开启;1:开启;
  timeoutNumber超时时间,超过这个时间还没备完则产生告警, 默认0, 大小0 - 168之间
  cbt_switchNumberCBT开关,勾选为1,不勾选为0。表示是否支持磁盘变化块跟踪
  threshold_vaild_byteString有效增量数据大小,单位MB,下拉菜单展示:1、2、4、8、16、32、64、128、256、512
  advanced_policyObject高级策略
    bk_cdpNumber细粒度备份开关,勾选为1,不勾选为0
    execute_intervalNumber执行时间间隔
    cdp_detailNumber保留个数
    cdp_dailyNumber保留天数
    cdp_switchNumber全备策略开关,勾选为1,不勾选为0
    cdp_paramString全备策略,是几个参数的合并,可参考复制规则的cdp_bl_sched
    cdp_snapshot_daysNumber快照保留天数
    cdp_snapshot_execute_intervalNumber快照执行时间间隔,单位为小时
  vp_uuidString容灾平台uuid,只有cdm才传
  storage_uuidString存储uuid,只有cdm才传
  verify_settingsObject整机备份-验证相关设置
    add_drillString是否开启验证: 0-否、1-是
    autoString开启验证时必传: 自动验证: 自动:1,手动:0;
    drill_plat_uuidString演练平台的vp_uuid
    vm_listArray虚机列表
      vm_nameString新建虚拟机1虚机名称
      orch_vm_nameString新建虚拟机1_20200612100700演练新建虚拟机的名称
      scripts_typeString开启验证时: (*必填)脚本验证的方式,0表示验证ping方法验证,1表示tcp端口验证测试,2表示脚本验证方式。2表示脚本验证方式目前暂存以后实现。默认值为0
      scriptsString开启验证时: 验证内容
  resource_settingsObject整机备份-资源配置相关设置
    vm_listArray工作机列表
      vm_nameString工作机
      new_vm_nameString目标机名称
      custom_configString自定义设置-1:打勾,0:不打勾
      cpuString自定义设置-处理器数量
      core_per_sockString自定义设置-处理器核心
      mem_mbString自定义设置-内存
      dynamic_memString自定义设置-默认传0即可
      networksArray自定义设置-网卡信息
        source_network_nameString网卡信息-源端网卡
        mac_addressString网卡信息-源端MAC地址
        keep_macString网卡信息-保留MAC
        network_idString网卡信息-目标平台网卡
没有勾选“自定义磁盘”时,将全局设置的网卡信息填进来
        network_nameString网卡信息-目标平台网卡名称
没有勾选“自定义磁盘”时,将全局设置的网卡信息填进来
      disk_listArray自定义设置-磁盘信息
        is_ignoredString磁盘信息-是否忽略: 选中为0,不选为1
        disk_nameString磁盘信息-名称
从RPC接口返回的虚机磁盘名称,下发RPC仅需要最后磁盘名称
        disk_pathString磁盘信息-路径
Vmware暂时传 空串,Hyper-V传用户选的磁盘路径(结尾带)
        new_dsString磁盘信息-存储
        idStringhyper-v有,磁盘uuid
    tgt_uuidString目标平台uuid
    new_dcString数据中心
    new_hostString主机名称
    new_dsString数据存储
    new_dc_morString数据中心标识
    network_nameString目标平台网卡
    network_idString目标平台网卡ID
    bk_uuidString整机备份模板必传: 灾备机
    bk_pathArray整机备份模板必传: 临时目录-灾备机路径
  data_ip_uuidString数据地址uuid
  bk_file_cryptNumber0备端数据加密,1是,0否;默认为0
  bk_crypt_typeNumber1备端数据加密类型:
1:aes,
2:sm4
  bk_crypt_keyString''备端数据加密,密钥
  encryptNumber0加密类型:
0:不加密,
1:AES,
2:SM4,
  thread_numNumber1并行任务数
  src_dedupe_switchNumber【演示使用】是否开启源端重删:
1-开启
0-不开启

Response

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

全服备份-2 修改规则

方法名:modifyFspBackup

URL

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

Method

PUT

Request

名称类型必选初始值简介Mock规则
fsp_backupObject
  secret_keyString
  band_widthString303:00-14:002m
  mirr_open_typeString0
  service_uuidString
  mirr_sync_flagString0
  excl_pathArray["/cgroup/","/dev/","/etc/X11/xorg.conf/","/etc/init.d/i2node/","/etc/rc.d/init.d/i2node/","/etc/sdata/","/lost+found/","/media/","/mnt/","/proc/","/run/","/selinux/","/sys/","/tmp/","/usr/local/sdata/","/var/i2/","/var/i2data/","/var/lock/","/var/run/vmblock-fuse/"],
  bkup_one_timeNumber1515568566
  encrypt_switchString0
  bk_typeNumber0
  mirr_sync_attrString1
  bk_uuidStringC11FE572-5207-3359-DB85-001E95F5F185
  wk_data_typeNumber1
  bk_pathArray["/FSPback0107/"],
  sync_itemString/
  bkup_policyNumber0
  net_mapping_typeString2
  snapshot_policyString0
  mirr_file_checkString0
  snapshot_intervalString0
  compressString0
  monitor_typeNumber0
  failoverString0
  wk_pathArray["/","/boot/"],
  snapshot_limitString24
  snapshot_switchNumber0
  fsp_nameStringrrrrr
  wk_uuidStringCE77F3D6-A6E3-A385-CE66-712313B7DDE8
  fsp_wk_shut_flagString2
  bk_data_typeNumber0
  bkup_scheduleArray
    sched_dayNumber22
    sched_timeString01:06
    sched_everyNumber2
    limitNumber29
    backup_typeNumber1
    backup_type_showString"全备"
    running_timeString"22:00"
    policysString"每天22:00自动执行"
  fsp_typeNumber1
  random_strString11111111-1111-1111-1111-111111111111新建不用传,修改用到这个;
  timeoutNumber超时时间,超过这个时间还没备完则产生告警, 默认0, 大小0 - 168之间
  cbt_switchNumberCBT开关,勾选为1,不勾选为0。表示是否支持磁盘变化块跟踪
  threshold_vaild_byteNumber有效增量数据大小,单位MB,下拉菜单展示:1、2、4、8、16、32、64、128、256、512
  advanced_policyObject高级策略
    bk_cdpNumber细粒度备份开关,勾选为1,不勾选为0
    execute_intervalNumber执行时间间隔
    cdp_detailNumber保留个数
    cdp_dailyNumber保留天数
    cdp_switchNumber全备策略开关,勾选为1,不勾选为0
    cdp_paramString全备策略,是几个参数的合并,可参考复制规则的cdp_param
  data_ip_uuidStringCE77F3D6-A6E3-A385-CE66-712313B7DDE8数据地址uuid
  thread_numNumber1并行任务数

Response

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

全服备份-2 获取单个规则

方法名:describeFspBackup

URL

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

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
dataObject
  messageString
  fsp_backupObject
    bk_ipString0.0.0.0备机控制地址
    bkup_one_timeNumber1515568566定时任务,执行时间(备份策略)
    wk_portString26821控制机控制端口
    mirr_open_typeString0文件打开方式
    wk_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3工作机id
    secret_keyString加密key
    bk_data_typeNumber0目标类型,1:文件;2:raw;3:vmdk;4:qcow;
    bkup_policyNumber0@mock=0, 备份策略,0立刻,1定时,2周期
    wk_pathString源路径
    bk_pathString备机(目标节点)路径,备份数据存放路径,云版可不填
    fsp_nameStringrrrrr名字
    mirror_methodString0首次镜像方式
    bk_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3备机(目标节点)的uuid ,云版可不填
    wk_data_typeNumber1源类型,0:块设备;1:文件;
    mirr_file_checkString0校验方式
    excl_pathString源机排除目录
    monitor_typeNumber0@mock=0, 迁移设置:MSCS支持
    band_widthString303:00-14:002m@mock=303:00-14:002m, 带宽控制机,格式:303:00-14:002m,202:00-15:0080m
    service_uuidString@mock=, 空
    backup_typeNumber@pick([0, 1, 2])@mock=@pick([0, 1, 2]), 0 全备,1 差异,2增量
    bkup_scheduleArray, 周期任务(备份策略)
      sched_dayArray"@integer(1, 31)"@mock="@integer(1, 31)", 哪几天
      sched_time_endString@time('HH:mm')@mock=@time('HH:mm'), 运行时间范围 结束
      limitNumber@integer(1, 64)@mock=@integer(1, 64), 数据保留期限(天)
      sched_gap_minNumber@integer(1, 64)@mock=@integer(1, 64), 间隔分钟数
      sched_timeArray@time('HH:mm')@mock=@time('HH:mm'), 哪几点
      sched_everyNumber2@mock=2, 0:每天;1:每周:2:每月;3:每隔;
      sched_time_startString@time('HH:mm')@mock=@time('HH:mm'), 运行时间范围 开始
    compressString0@mock=0, 压缩:0不开启;1,低;2,中;3,高
    move_typeString0@mock=0, 默认0
    wk_ipString0.0.0.0@mock=0.0.0.0, 工作机控制地址
    mirr_sync_attrString1@mock=1, 文件安全属性
    bk_portString26831@mock=26831, 备机控制端口
    fsp_wk_shut_flagString2@mock=2, 迁移设置:自动关工作机
    failoverNumber1迁移设置,手工(2)/自动(1)切换
    mirr_sync_flagString0@mock=0, 错误处理方式
    random_strString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 用于防止并发修改的随机串
    sync_itemStringC:@mock=C:, 同步项
    net_mappingArray@mock=, 网络设置:网卡映射
    net_mapping_typeString2@mock=2, 网络设置:网络迁移配置
    encrypt_switchString0@mock=0, 0不开启,1开启
    fsp_typeString任务类型:3:备份;5:还原;10:备份模板;11:还原模板;
    cbt_switchNumberCBT开关,勾选为1,不勾选为0。表示是否支持磁盘变化块跟踪
    threshold_vaild_byteNumber有效增量数据大小,单位MB,下拉菜单展示:1、2、4、8、16、32、64、128、256、512
    advanced_policyObject高级策略
      bk_cdpNumber细粒度备份开关,勾选为1,不勾选为0
      execute_intervalNumber执行时间间隔
      cdp_detailNumber保留个数
      cdp_dailyNumber保留天数
      cdp_switchNumber全备策略开关,勾选为1,不勾选为0
      cdp_paramString全备策略,是几个参数的合并,可参考复制规则的cdp_param
    vp_uuidString容灾平台uuid
    storage_uuidString存储uuid
    storageObject存储的具体信息
      typeStringlocalfs, nfs,glusterfs
      pathString
    data_ip_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3数据地址
    thread_numNumber并行任务数
  codeNumber0@mock=0
retNumber200@mock=200
msgString@mock=

全服备份-3 删除规则

方法名:deleteFspBackup

URL

//fsp/backup

Method

DELETE

Request

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

Response

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

全服备份-3 获取规则列表(基本信息)

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

URL

//fsp/backup

Method

GET

Request

名称类型必选初始值简介Mock规则
typeNumber3任务类型:3:备份;5:还原;7:整机备份;10:备份模板;11:还原模板;12:整机备份模板
limitNumber10分页条数
pageNumber1页数

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] success
  info_listArray
    band_widthString2400:00-22:594m带宽配置
    bkup_scheduleArray备份计划
      backup_type_showString全备
      policysString每天22:00自动执行备份策略
      backup_typeString0备份类型
      sched_everyString0每隔多久
      running_timeString22:00运行时间
      sched_timeArray[ "22:00" ]计划:时间
      sched_dayArray[]计划:天
      limitString1保留数量
    random_strString0E807AD3-DD1E-9224-2B9B-E713CF258467随机字符串
    wk_node_nameStringname工作机名称
    bk_node_nameStringname灾备机名称
    usernameStringadmin用户名
    bk_path_policyString0一对一;多对一
    fsp_nameStringasdasddsasdasd规则名称
    fsp_typeString3规则类型
    fsp_uuidStringE28184D8-869B-BF56-A77C-3CC835FAAC34规则uuid
    wk_uuidString0E807AD3-DD1E-9224-2B9B-E713CF258467工作机uuid
    bk_uuidStringF28184D8-869B-BF56-A77C-3CC835FAAC35灾备机uuid
    can_opNumber1允许操作
    can_delNumber1允许删除
    can_upNumber1允许更新
    verify_settingsObject验证配置
      add_drillString0是否开启验证
      autoString0是否自动验证
      drill_plat_uuidString0E807AD3-DD1E-9224-2B9B-E713CF258467演练平台uuid
      vm_listArray虚机列表
        vm_nameStringvm_name虚机名称
        orch_vm_nameStringorch_vm_name新虚机名称
        scripts_typeString0验证方式
        scriptsString''验证内容
    resource_settingsObject整机备份-资源配置相关设置
      vm_listArray
        vm_nameStringvm_name工作机名称
        new_vm_nameStringnew_vm_name目标机名称
        custom_configString0自定义设置-1:打勾,0:不打勾
        cpuString2cpu数量
        core_per_sockString2核心数
        mem_mbString1024内存
        dynamic_memString0是否开启动态内存
        networksArray网卡信息
          source_network_nameStringsource_network_name源机网卡名称
          mac_addressString08:00:20:0A:8C:6Dmac地址
          keep_macString0保留mac地址
          network_idStringnetwork_id网卡id
          network_nameStringnetwork_name网卡名称
        disk_listArray磁盘列表
          is_ignoredString0是否忽略磁盘
          disk_nameStringVMware Virtual disk 1.0磁盘名称
          disk_pathString/磁盘路径
          new_dsStringNFS-172.20.67.90--250496693存储
          idString
      tgt_uuidString0E807AD3-DD1E-9224-2B9B-E713CF258467目标平台uuid
      new_dcStringha-datacenter数据中心
      new_dc_morStringha-datacenter
      new_hostStringlocalhost.localdomain"主机
      new_dsStringdisk (1)存储
      network_nameStringvm4网卡名称
      network_idString''网卡id
      bk_uuidString0E807AD3-DD1E-9224-2B9B-E713CF258467灾备机uuid
      bk_pathString/disk备份路径
    wk_data_typeString1源类型
    bk_data_typeString1目标端类型, 8:vmware
    bkup_policyString1
  totalNumber1

全服备份-3 规则操作

SDK方法名:

启动:startFspBackup;

停止:stopFspBackup;

完成:finishFspBackup;

切换:failoverFspBackup;

切回:failbackFspBackup;

URL

//fsp/backup/operate

Method

POST

Request

名称类型必选初始值简介Mock规则
operateStringstartstart, stop, finish(f..仅用于结束整机手工备份);
failover,failback(整机备份:切换和回切)
fsp_uuidsArray["11111111-1111-1111-1111-111111111111"], *规则数组
bk_typeString立即执行操作(start_immediately)必传,取值为,备份策略 - 周期任务 - 备份方式;0:全备,1:增量,2:差异
continue_last_backupNumber0一次性备份任务结束后,是否继续备份到上一次目录。1,是;0,否。默认为0
stop_laterString块备份开启cbt必传:0-立即停止, 1-稍后停止
op_codeString整机备份:切换,固定传0
snap_pointString整机备份:切换,选择需要切换到的时间点
power_onNumber整机备份:切换,1为自动开机。默认不传为0

Response

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

全服备份-3 规则状态

方法名:listFspBackupStatus

URL

//fsp/backup/status

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
msgString@mock=
retNumber200@mock=200
dataObject
  messageString
  statusObject
    fsp_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, uuid
    f_totalString0@mock=0, ? 默认0
文件总数
    f_currentString0当前遍历数
    blistString遍历未完成:
0:否;
1:是;
    progressString0@mock=0, 进度
    statusStringSTOP@mock=STOP, 状态文字
    db_statusString@mock=, ?默认空
    latencyNumber10复制延迟,ms单位
    wk_statusStringONLINE工作机状态,ONLINE,OFFLINE
    version_numberNumber10备份数
    validated_version_numberNumber10有效备份数
  codeNumber0@mock=0
  countNumber0@mock=0

整机备份 - 批量创建

SDK方法名:batchCreateFspBackup

URL

//fsp/backup/batch

Method

POST

Request

名称类型必选初始值简介Mock规则
base_info_listObject
  fsp_typeNumber3
  secret_keyString加密key
  band_widthString带宽控制机,格式:303:00-14:002m,202:00-15:0080m
  mirr_open_typeString0文件打开方式
  service_uuidString
  mirr_sync_flagString0错误处理方式
  bkup_one_timeNumber0定时任务,执行时间(备份策略)
  encrypt_switchString00不开启,1开启
  mirr_sync_attrString1文件安全属性
  wk_data_typeNumber1源类型,0:块设备;1:文件;
  sync_itemString/同步项
  bkup_policyNumber2备份策略,2立刻,0定时,1周期
  mirr_file_checkString0校验方式
  compressString0压缩:0不开启;1,低;2,中;3,高
  monitor_typeNumber0迁移设置:MSCS支持
  failoverString0是否支持备端拉起,1是0否;默认1;这个开关只有 文件到vmdk才需要显示(2019/1/15 向lianghr确认)
  fsp_wk_shut_flagString2迁移设置:自动关工作机
  bk_data_typeNumber1目标类型,1:文件;2:raw;3:vmdk;4:qcow;5 华为云;6:vmware; 7:容灾平台;
  bkup_scheduleArray
    sched_dayString@integer(1, 31)
    sched_timeString@time('HH:mm')
    sched_everyNumber2
    limitString@integer(1, 64)
    backup_typeNumber0
    policysString"每天22:00自动执行"
    backup_type_showString"全备"
    running_timeString"22:00"
  del_policyNumber1删除策略,0:不开启;1:开启;
  timeoutNumber1超时时间,超过这个时间还没备完则产生告警, 默认0, 大小0 - 168之间
  cbt_switchNumber1CBT开关,勾选为1,不勾选为0。表示是否支持磁盘变化块跟踪
  threshold_vaild_byteString有效增量数据大小,单位MB,下拉菜单展示:1、2、4、8、16、32、64、128、256、512
  advanced_policyObject高级策略
    bk_cdpNumber1细粒度备份开关,勾选为1,不勾选为0
    execute_intervalNumber1执行时间间隔
    cdp_detailNumber1保留个数
    cdp_dailyNumber1保留天数
    cdp_paramString全备策略,是几个参数的合并,可参考复制规则的cdp_param
    cdp_switchNumber1全备策略开关,勾选为1,不勾选为0
  tgt_uuidString目标平台uuid (资源配置 - 全局)
如果开启了验证,那么演练平台共用这个字段(后端自己处理)
  new_dcString数据中心 (资源配置 - 全局)
  new_dc_morString数据中心标识 (资源配置 - 全局)
  new_hostString主机名称 (资源配置 - 全局)
  new_dsString数据存储 (资源配置 - 全局)
  network_nameString目标平台网卡name (资源配置 - 全局)
  network_idString目标平台网卡id (资源配置 - 全局)
node_listArray
  wk_uuidString
  bk_uuidString
  wk_pathArray
  bk_pathArray
  excl_pathArray
  vm_nameString源机名称 (资源配置 - 单独)
  new_vm_nameString目标机名称 (资源配置 - 单独)
  custom_configNumber自定义设置-1:打勾,0:不打勾 (资源配置 - 单独)
  cpuString自定义设置-处理器数量 (资源配置 - 单独)
  core_per_sockString自定义设置-处理器核心 (资源配置 - 单独)
  mem_mbString自定义设置-内存 (资源配置 - 单独)
  dynamic_memString自定义设置-默认传0即可 (资源配置 - 单独)
  add_drillNumber是否开启验证: 0-否、1-是 (演练配置)
  autoNumber开启验证时必传: 自动验证: 自动:1,手动:0 (演练配置)
  orch_vm_nameString演练新建虚拟机的名称 (演练配置)
  scripts_typeString开启验证时: (*必填)脚本验证的方式,0表示验证ping方法验证,1表示tcp端口验证测试,2表示脚本验证方式。2表示脚本验证方式目前暂存以后实现。默认值为0 (演练配置)
  scriptsString开启验证时: 验证内容 (演练配置)
  os_typeNumber开启验证时: 操作系统: 0:linux; 1:windows (演练配置)
common_paramsObject
  batch_nameString批量新建任务名称
  rep_prefixString名称前缀
  rep_sufixString名称后缀
  variable_typeNumber批量任务: 变量名,0,节点名称;1,节点ip,虚机复制固定传2,表示虚机名称

Response

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

------ 全服恢复 ------

URL

//dash/fsp_recovery

Method

GET

Request

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

Response

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

全服恢复-0 获取两节点网卡列表

方法名:listFspRecoveryNic

URL

//fsp/recovery/nic_list

Method

GET

Request

名称类型必选初始值简介Mock规则
bk_uuidStringF85DFEC0-149E-373D-0B9E-3DA9A5C43940@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机(目标节点)的uuid
dst_pathString/fsp_bk/192.168.71.77_26821/20190111113656/@mock=???, ??
wk_uuidString42614852-BB62-1EF7-FED0-D2354BF3149D@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机id

Response

名称类型必选初始值简介Mock规则
dataObject
  messageString[0] success@mock=[0] success
  codeNumber0@mock=0
  wk_nic_listArray, 网卡列表3
    nameString@pick(["Ethernet0", "Ethernet1", "Ethernet2"])@mock=@pick(["Ethernet0", "Ethernet1", "Ethernet2"]), 网卡名
    ipString192.168.72.73/255.255.240.0@mock=192.168.72.73/255.255.240.0, 带子网掩码的ip
    typeString0@mock=0, 0: 静态; 1: dhcp;
  bk_nic_listArray, 网卡列表3
    ipString192.168.72.74/255.255.240.0@mock=192.168.72.74/255.255.240.0, 带子网掩码的ip
    typeString0@mock=0, 0: 静态; 1: dhcp;
    nameString@pick(["VMware Network Adapter VMnet8", "以太网", "VMware Network Adapter VMnet9"])@mock=@pick(["VMware Network Adapter VMnet8", "以太网", "VMware Network Adapter VMnet9"]), 网卡名
msgString@mock=
retNumber200@mock=200

全服恢复-0 获取源节点磁盘和文件列表

SDK类名:/fsp/FspRecovery

SDK方法名:listFspRecoveryDir

URL

//fsp/recovery/dir_list

Method

GET

Request

名称类型必选初始值简介Mock规则
bk_uuidStringF85DFEC0-149E-373D-0B9E-3DA9A5C43940@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机id
dst_pathString/fsp_bk/192.168.71.77_26821/20190111113656/@mock=C:\fspbk\20171117132436\, 目标路径
fsp_uuidString, 可选,编辑就传

Response

名称类型必选初始值简介Mock规则
msgString@mock=
retNumber200@mock=200
dataObject
  messageString[0] success@mock=[0] success
  hd_listArray, 磁盘列表3
    labelString@pick(["C:", "F:", "G:"])@mock=@pick(["C:", "F:", "G:"]), 卷标
    is_systemNumber@pick(["0", "1"])@mock=@pick(["0", "1"]), 是系统盘1,不是0
  os_typeString@pick(["1", "2"])@mock=@pick(["1", "2"]), os类型 1linux 2win
  codeNumber0@mock=0
  dir_listArray
    wk_pathStringC:\@mock=C:\, 工作路径,新建时没有这字段
    typeString@pick(["0", "1", "2"])@mock=@pick(["0", "1", "2"]), 0:路径磁盘后加FFO;1:不用加FFO;2:排除;
    bk_pathStringC:\@mock=C:\, 备份数据目录
    is_bootNumber是否系统盘
    sizeString大小

全服恢复-0 获取还原点

方法名:listFspRecoveryPoint

URL

//fsp/recovery/point_list

Method

GET

Request

名称类型必选初始值简介Mock规则
bk_uuidStringF85DFEC0-149E-373D-0B9E-3DA9A5C43940, 节点uuid
rc_data_pathString/fsp_bk/192.168.71.77_26821/@mock=C:\back\, [RC] 备份数据路径

Response

名称类型必选初始值简介Mock规则
retNumber200@mock=200
dataObject
  messageString[0] success@mock=[0] success
  codeNumber0@mock=0
  point_listArray20171117132436@mock=20171117132436, 时间点
    time_pointString20171117132436
    typeString0 全备,1 差异,2增量
    file_typeNumber0:普通文件;
1:表示硬盘文件
msgString@mock=

全服恢复-1 检测条件-磁盘空间

方法名:verifyFspRecoveryVolumeSpace

URL

//fsp/recovery/verify_volume_space

Method

POST

Request

名称类型必选初始值简介Mock规则
wk_uuidString42614852-BB62-1EF7-FED0-D2354BF3149D@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机id
bk_uuidStringF85DFEC0-149E-373D-0B9E-3DA9A5C43940@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机(目标节点)uuid
dst_pathString/fsp_bk/192.168.71.77_26821/20190111113656/@mock=???, 备份数据路径
sync_itemString/@mock=C:\, 同步项目(磁盘),逗号分隔
fsp_typeString规则类型
vmdk_listArray块还原、整机恢复。源磁盘列表
  nameString
device_listArray块还原、整机恢复。目标块设备列表
  nameString
by_typeNumber0整机恢复方式,0:按工作机;1:按存储;2:按虚拟机; 默认传0或不传
pathString''storage的path(整机恢复,按工作机、按存储)
typeString''storage的type(整机恢复,按工作机、按存储)
suffixString''工作机ip_工作机port(整机恢复,按工作机、按存储)
restore_pointString''备份点(整机恢复,按工作机、按存储)
vp_uuidString容灾平台uuid(整机恢复,按虚拟机)
vm_refString虚拟机id(整机恢复,按虚拟机)

Response

名称类型必选初始值简介Mock规则
msgString@mock=
dataObject
  codeNumber0@mock=0
  messageString[0] success@mock=[0] success
  wk_vol_listArray, 源盘符列表(块还原:目标端设备列表)
    sizeString1234@mock=1234, 总容量
    labelStringC:@mock=C:, 磁盘名
    usedString1234@mock=1234, 已用(块还原没有)
  bk_vol_listArray, 目标盘符列表(块还原:源端vmdk文件列表)
    sizeNumber1234@mock=1234, 总容量
    labelStringC:@mock=C:, 磁盘名
    freeString1234@mock=1234, 空闲(块还原没有)
  lost_volumeArray缺少的磁盘
    String
  insufficient_volumeArray空间不足的磁盘
    String
retNumber200@mock=200

(废除)全服恢复-1 检测条件-license

方法名:verifyFspRecoveryLicense

URL

//fsp/recovery/verify_license

Method

POST

Request

名称类型必选初始值简介Mock规则
wk_uuidString42614852-BB62-1EF7-FED0-D2354BF3149D工作机id

Response

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

全服恢复-1 检测条件-旧规则

方法名:verifyFspRecoveryOldRule

URL

//fsp/recovery/verify_old_rule

Method

POST

Request

名称类型必选初始值简介Mock规则
bk_uuidStringF85DFEC0-149E-373D-0B9E-3DA9A5C43940@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机(目标节点)uuid
wk_uuidString42614852-BB62-1EF7-FED0-D2354BF3149D@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机id

Response

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

全服恢复-1 检测条件-系统版本

方法名:verifyFspRecoveryOsVersion

URL

//fsp/recovery/verify_os_version

Method

POST

Request

名称类型必选初始值简介Mock规则
dst_pathString/fsp_bk/192.168.71.77_26821/20190111113656/@mock=???, ??
wk_uuidStringF85DFEC0-149E-373D-0B9E-3DA9A5C43940@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机id
bk_uuidString42614852-BB62-1EF7-FED0-D2354BF3149D@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机(目标节点)uuid

Response

名称类型必选初始值简介Mock规则
dataObject
  messageString[0] success@mock=[0] success
  codeNumber0@mock=0
  wk_os_verStringMicrosoft Windows 10/x64 Edition@mock=Microsoft Windows 10/x64 Edition, 目标系统版本
  bk_os_verStringMicrosoft Windows 10/x64 Edition@mock=Microsoft Windows 10/x64 Edition, 目标系统版本
msgString@mock=
retNumber200@mock=200

全服恢复-2 新建规则

方法名:createFspRecovery

URL

//fsp/recovery

Method

POST

Request

名称类型必选初始值简介Mock规则
fsp_recoveryObject
  dst_pathString/fsp_bk/192.168.71.77_26821/20190111113656/目标路径
  monitor_typeNumber0迁移设置:MSCS支持
  encrypt_switchString00不开启,1开启
  net_mappingArray网络设置:网卡映射
    bk_nicObject网卡列表
      typeString0一般用获取网卡接口同样值即可; 0: 静态; 1: dhcp;
      nameStringEthernet0网卡名
      ipString192.168.72.74/255.255.240.0带子网掩码的ip
    wk_nicObject网卡列表
      nameStringEthernet0网卡名
      typeString0一般用获取网卡接口同样值即可; 0: 静态; 1: dhcp;
      ipString192.168.72.73/255.255.240.0带子网掩码的ip
  wk_uuidString42614852-BB62-1EF7-FED0-D2354BF3149D工作机id
  mirr_sync_attrString1文件安全属性
  secret_keyString加密key
  bk_pathArray["/fsp_bk/192.168.71.77_26821/20190111113656/", "/fsp_bk/192.168.71.77_26821/20190111113656/bin/", "/fsp_bk/192.168.71.77_26821/20190111113656/boot/", "/fsp_bk/192.168.71.77_26821/20190111113656/etc/", "/fsp_bk/192.168.71.77_26821/20190111113656/lib/", "/fsp_bk/192.168.71.77_26821/20190111113656/lib64/", "/fsp_bk/192.168.71.77_26821/20190111113656/root/", "/fsp_bk/192.168.71.77_26821/20190111113656/sbin/", "/fsp_bk/192.168.71.77_26821/20190111113656/usr/bin/", "/fsp_bk/192.168.71.77_26821/20190111113656/usr/lib/", "/fsp_bk/192.168.71.77_26821/20190111113656/usr/lib64/", "/fsp_bk/192.168.71.77_26821/20190111113656/usr/libexec/", "/fsp_bk/192.168.71.77_26821/20190111113656/usr/local/", "/fsp_bk/192.168.71.77_26821/20190111113656/usr/sbin/", "/fsp_bk/192.168.71.77_26821/20190111113656/var/lib/nfs/"]备机(目标节点)路径,备份数据存放路径,云版可不填
  band_widthString带宽控制机,格式:303:00-14:002m,202:00-15:0080m
  fsp_nameStringtestRC名字
  bk_uuidStringF85DFEC0-149E-373D-0B9E-3DA9A5C43940备机(目标节点)的uuid ,云版可不填
  net_mapping_typeString2网络设置:网络迁移配置,1:同步原机网络配置,2:不同步;
  mirr_open_typeString0文件打开方式
  restore_pointString20190111113656还原时间点
  mirr_file_checkString0校验方式
  compressString0压缩:0不开启;1,低;2,中;
  service_uuidString
  excl_pathArray源机排除目录
  wk_pathArray["/", "/I2FFO/bin/", "/I2FFO/boot/", "/I2FFO/etc/", "/I2FFO/lib/", "/I2FFO/lib64/", "/I2FFO/root/", "/I2FFO/sbin/", "/I2FFO/usr/bin/", "/I2FFO/usr/lib/", "/I2FFO/usr/lib64/", "/I2FFO/usr/libexec/", "/I2FFO/usr/local/", "/I2FFO/usr/sbin/", "/I2FFO/var/lib/nfs/"]源路径
  mirr_sync_flagString0错误处理方式
  fsp_wk_shut_flagString2迁移设置:自动关工作机
  sync_itemString/同步项
  failoverString0迁移设置,手工切换0,自动切换1(2019/1/15 向lianghr确认)
  fsp_typeString5任务类型:
3:备份;
5:还原;
7:块还原;
10:备份模板;
11:还原模板;
  random_strString11111111-1111-1111-1111-111111111111新建不用传
  data_ip_uuidStringF85DFEC0-149E-373D-0B9E-3DA9A5C43940数据地址uuid
  by_typeString整机恢复:
0:按工作机;1:按存储
  bk_file_cryptNumber备端加密:0,1
  encryptNumber加密类型:
0:不加密,
1:AES,
2:SM4,
  thread_numNumber1并行任务数

Response

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

全服恢复-2 修改规则

方法名:modifyFspRecovery

URL

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

Method

PUT

Request

名称类型必选初始值简介Mock规则
fsp_recoveryObject
  restore_pointString20180724164452@mock=20180724164452, 还原时间点
  fsp_wk_shut_flagString2@mock=2, 迁移设置:自动关工作机
  excl_pathArray, 源机排除目录
  secret_keyString@mock=, 加密key
  band_widthString303:00-14:002m@mock=303:00-14:002m, 带宽控制机,格式:303:00-14:002m,202:00-15:0080m
  compressString0@mock=0, 压缩:0不开启;1,低;2,中;
  wk_pathArray, 源路径
  net_mappingArray, 网络设置:网卡映射
    wk_nicObject, 网卡列表
      ipString192.168.72.73/255.255.240.0@mock=192.168.72.73/255.255.240.0, 带子网掩码的ip
      typeString0@mock=0, 一般用获取网卡接口同样值即可; 0: 静态; 1: dhcp;
      nameStringEthernet0@mock=Ethernet0, 网卡名
    bk_nicObject, 网卡列表
      typeString0@mock=0, 一般用获取网卡接口同样值即可; 0: 静态; 1: dhcp;
      ipString192.168.72.74/255.255.240.0@mock=192.168.72.74/255.255.240.0, 带子网掩码的ip
      nameStringEthernet0@mock=Ethernet0, 网卡名
  service_uuidString@mock=, 空
  wk_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机id
  net_mapping_typeString2@mock=2, 网络设置:网络迁移配置
  bk_pathArray, 备机(目标节点)路径,备份数据存放路径,云版可不填
  fsp_nameStringrrrrr@mock=rrrrr, 名字
  mirr_sync_flagString0@mock=0, 错误处理方式
  mirr_file_checkString0@mock=0, 校验方式
  monitor_typeNumber0@mock=0, 迁移设置:MSCS支持
  sync_itemStringC:@mock=C:, 同步项
  mirr_sync_attrString1@mock=1, 文件安全属性
  random_strString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 用于防止并发修改的随机串
  dst_pathString???@mock=???, 目标路径
  encrypt_switchString0@mock=0, 0不开启,1开启
  bk_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机(目标节点)的uuid ,云版可不填
  mirr_open_typeString0@mock=0, 文件打开方式
  failoverString0迁移设置,手工(0)/自动(1)切换
  fsp_typeString任务类型:3:备份;5:还原;10:备份模板;11:还原模板;
  data_ip_uuidString数据地址uuid
  thread_numNumber1并行任务数

Response

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

全服恢复-2 获取单个规则

方法名:desribeFspRecovery

URL

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

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
dataObject
  codeNumber0@mock=0
  fsp_recoveryObject
    wk_portString26821@mock=26821, 控制机控制端口
    fsp_wk_shut_flagString2@mock=2, 迁移设置:自动关工作机
    compressString0@mock=0, 压缩:0不开启;1,低;2,中;
    encrypt_switchString0@mock=0, 0不开启,1开启
    mirr_sync_attrString1@mock=1, 文件安全属性
    move_typeString0@mock=0, 默认0
    excl_pathString源机排除目录
    wk_ipString0.0.0.0@mock=0.0.0.0, 工作机控制地址
    band_widthString303:00-14:002m@mock=303:00-14:002m, 带宽控制机,格式:303:00-14:002m,202:00-15:0080m
    mirr_open_typeString0@mock=0, 文件打开方式
    wk_pathString
    wk_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机id
    restore_pointString20180724164452@mock=20180724164452, 还原时间点
    fsp_nameStringrrrrr@mock=rrrrr, 名字
    secret_keyString@mock=, 加密key
    failoverString0迁移设置,手工(0)/自动(1)切换
    service_uuidString@mock=, 空
    monitor_typeNumber0@mock=0, 迁移设置:MSCS支持
    sync_itemStringC:@mock=C:, 同步项
    bk_pathString
    bk_portString26831@mock=26831, 备机控制端口
    mirr_file_checkString0@mock=0, 校验方式
    mirr_sync_flagString0@mock=0, 错误处理方式
    mirror_methodString0@mock=0, 首次镜像方式
    bk_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机(目标节点)的uuid ,云版可不填
    net_mappingArray@mock=, 网络设置:网卡映射
    net_mapping_typeString2@mock=2, 网络设置:网络迁移配置
    bk_ipString0.0.0.0@mock=0.0.0.0, 备机控制地址
    random_strString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 用于防止并发修改的随机串
    fsp_typeString任务类型:3:备份;5:还原;10:备份模板;11:还原模板;
    data_ip_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3数据地址uuid
    thread_numNumber1并行任务数
  messageString
msgString@mock=
retNumber200@mock=200

全服恢复-3 删除规则

SDK方法名:deleteFspRecovery

URL

//fsp/recovery

Method

DELETE

Request

名称类型必选初始值简介Mock规则
fsp_uuidsArray["11111111-1111-1111-1111-111111111111"], *规则数组
forceNumber1 - 强制删除 0 - 非强制删除

Response

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

全服恢复-3 获取规则列表(基本信息)

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

URL

//fsp/recovery

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
retNumber200@mock=200
dataObject
  codeNumber0@mock=0
  countNumber10@mock=10, 规则数量
  totalNumber100@mock=100, 规则总数
  messageString
  info_listArray5
    wk_node_nameString@pick(["Smith", "Will", "Nary"])@mock=@pick(["Smith", "Will", "Nary"]), 源节点名
    wk_pathStringC:\123\@mock=C:\123, 源路径
    fsp_uuidString@pick(["0DD4E727-70AB-62C6-BEB5-D012DFAE46E3", "0DD4E727-70AB-62C6-BEB5-D012DFAE46E4"])@mock=@pick(["0DD4E727-70AB-62C6-BEB5-D012DFAE46E3", "0DD4E727-70AB-62C6-BEB5-D012DFAE46E4"]), 规则UUID
    usernameString@pick(["admin", "user", "super"])@mock=@pick(["admin", "user", "super"]), 用户名
    excl_pathString@mock=, 排除路径
    bk_uuidString7AD64D7A-7D1D-AC51-5DF1-29A58345A288@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 目标节点名
    bk_pathStringC:\ascasldfjlksjf\@mock=C:\ascasldfjlksjf, 目标节点路径
    fsp_nameStringtestbak@mock=testbak, 规则名
    wk_uuidString7AD64D7A-7D1D-AC51-5DF1-29A58345A288@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 源节点名
    band_widthString@pick(["100", "150", "200"])@mock=@pick(["100", "150", "200"]), 带宽控制
    bk_node_nameString@pick(["kevin", "Jane", "Grey"])@mock=@pick(["kevin", "Jane", "Grey"]), 目标节点名
    fsp_typeString0任务类型:3:备份;5:还原;10:备份模板;11:还原模板;
    can_upNumber1
    can_opNumber1
    can_delNumber1
msgString@mock=

全服恢复-3 规则操作

方法名:[action] + 'FspRecovery'

SDK方法名:

启动:startFspRecovery;

停止:stopFspRecovery;

迁移:moveFspRecovery;

重启:rebootFspRecovery;

URL

//fsp/recovery/operate

Method

POST

Request

名称类型必选初始值简介Mock规则
fsp_uuidsArray["11111111-1111-1111-1111-111111111111"]规则数组
operateStringstartstart, stop, move, reboot

Response

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

全服恢复-3 规则状态

方法名: listFspRecoveryStatus

URL

//fsp/recovery/status

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
msgString@mock=
dataObject
  statusObject
    statusStringSTOP@mock=STOP, 状态文字
    db_statusString@mock=, ?默认空
    fsp_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, uuid
    f_totalString0@mock=0, ? 默认0
    progressString0@mock=0, 进度
  countNumber0@mock=0
  messageString
  codeNumber0@mock=0
retNumber200@mock=200

环境检查

SDK方法名: verifyEnvironment;

URL

//fsp/backup/verify_environment

Method

POST

Request

名称类型必选初始值简介Mock规则
wk_uuidString
bk_uuidString
wk_pathString
cbt_switchNumber0是否开启cbt
task_typeNumber规则类型:
云备份:6;
块还原:7;
整机复制:8;
整机恢复:9;

Response

名称类型必选初始值简介Mock规则
msgString
dataObject
  messageString
  codeNumber0
retNumber200
Last update: 6/25/2022, 9:23:18 PM
Contributors: ganl