i2UP接口文档

# 全服务器保护

SDK类名：/fsp/FspBackup

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

SDK方法名：listFspBackupNic

# URL

//fsp/backup/nic_list

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
wk_uuid String 否 F85DFEC0-149E-373D-0B9E-3DA9A5C43940 工作机id
bk_uuid String 否 42614852-BB62-1EF7-FED0-D2354BF3149D 备机（目标节点）的uuid

# Response

名称 类型 必选 初始值 简介 Mock规则
msg String 否 @mock=
ret Number 否 200 @mock=200
data Object 否
  bk_nic_list Array 否 , 网卡列表 3
    type String 否 0 @mock=0
    ip String 否 192.168.72.74/255.255.240.0 @mock=192.168.72.74/255.255.240.0, 带子网掩码的ip
    name String 否 @pick(["VMware Network Adapter VMnet8", "以太网", "VMware Network Adapter VMnet9"]) @mock=@pick(["VMware Network Adapter VMnet8", "以太网", "VMware Network Adapter VMnet9"]), 网卡名
  message String 否 [0] success @mock=[0] success
  code Number 否 0 @mock=0
  wk_nic_list Array 否 , 网卡列表 3
    ip String 否 192.168.72.73/255.255.240.0 @mock=192.168.72.73/255.255.240.0, 带子网掩码的ip
    type String 否 0 @mock=0
    name String 否 @pick(["Ethernet0", "Ethernet1", "Ethernet2"]) @mock=@pick(["Ethernet0", "Ethernet1", "Ethernet2"]), 网卡名

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

方法名：listFspBackupDir

# URL

//fsp/backup/dir_list

# Method

GET

# Request

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

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200 @mock=200
data Object 否
  hd_list Array 否 , 磁盘列表 3
    is_system Number 否 @pick(["0", "1"]) @mock=@pick(["0", "1"]), 是系统盘1，不是0
    label String 否 @pick(["C:", "F:", "G:"]) @mock=@pick(["C:", "F:", "G:"]), 卷标
  os_type String 否 @pick([0, 1]) @mock=@pick([0, 1]), 系统: 0: linux, 1: windows
  code Number 否 0 @mock=0
  message String 否 [0] success @mock=[0] success
  dir_list Array 否 5
    type String 否 @pick(["0", "1", "2"]) @mock=@pick(["0", "1", "2"]), 0：路径磁盘后加FFO；1：不用加FFO；2：排除；
    wk_path String 否 C:\ @mock=C:\, 源路径
    bk_path String 否 C:\ @mock=C:\, 目标路径，新建时没有这字段
msg String 否 @mock=

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

方法名：verifyFspBackupCoopySpace

# URL

//fsp/backup/verify_coopy_space

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
bk_path Array 否 ["fsp_bk"] @mock=C:\ascasldfjlksjf, 目标节点路径，6.2 wk_path
bk_uuid String 否 F85DFEC0-149E-373D-0B9E-3DA9A5C43940 @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机（目标节点）uuid
wk_uuid String 否 42614852-BB62-1EF7-FED0-D2354BF3149D @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机id
excl_path Array 否 ["/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_path Array 否 ["/"] @mock=, 源路径

# Response

名称 类型 必选 初始值 简介 Mock规则
msg String 否 @mock=
data Object 否
  bk_disk_need Number 否 123456 @mock=123456, 目标磁盘需要空间 (Linux 没这个)
  message String 否 [0] success @mock=[0] success
  code Number 否 0 @mock=0
  bk_disk_free Number 否 654321 @mock=654321, 目标磁盘空闲空间 (Linux 没这个)
ret Number 否 200 @mock=200

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

方法名：verifyFspBackupLicense

# URL

//fsp/backup/verify_license

# Method

POST

# Request

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

# Response

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

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

方法名：verifyFspBackupOldRule

# URL

//fsp/backup/verify_old_rule

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
bk_uuid String 否 F85DFEC0-149E-373D-0B9E-3DA9A5C43940 @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机（目标节点）uuid
bk_path Array 否 ["/fsp_bk/"] @mock=C:\ascasldfjlksjf, 目标节点路径，6.2 wk_path
wk_uuid String 否 42614852-BB62-1EF7-FED0-D2354BF3149D @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机id

# Response

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

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

方法名：verifyFspBackupOsVersion

# URL

//fsp/backup/verify_os_version

# Method

POST

# Request

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

# Response

名称 类型 必选 初始值 简介 Mock规则
data Object 否
  message String 否 [0] success @mock=[0] success
  code Number 否 0 @mock=0
  wk_os_ver String 否 Microsoft Windows 10/x64 Edition @mock=Microsoft Windows 10/x64 Edition, 目标系统版本
  bk_os_ver String 否 Microsoft Windows 10/x64 Edition @mock=Microsoft Windows 10/x64 Edition, 目标系统版本
msg String 否 @mock=
ret Number 否 200 @mock=200

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

# URL

//fsp/backup/device_info

# Method

GET

# Request

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

# Response

名称 类型 必选 初始值 简介 Mock规则
data Object 否
  message String 否
  code Number 否 0
  dev_list Array 否
    name String 否 fnrlu
    size Number 否 7997189767647315
    attr String 否 1
    leaf Number 否 0
    is_dir Number 否 1
    has_policy Number 否
    children Array 否
      name String 否 lvm1
      size Number 否 2059209815596581
  node_uuid String 否
ret Number 否 200
msg String 否

# 全服备份-2 新建规则

方法名：createFspBackup

# URL

//fsp/backup

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
fsp_backup Object 否
  secret_key String 否 加密key
  band_width String 否 带宽控制机，格式：303:00-14:002m,202:00-15:0080m
  mirr_open_type String 否 0 文件打开方式
  service_uuid String 否 空
  mirr_sync_flag String 否 0 错误处理方式
  excl_path Array 否 ["/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_time Number 否 0 定时任务，执行时间（备份策略）
  encrypt_switch String 否 0 0不开启，1开启
  mirr_sync_attr String 否 1 文件安全属性
  bk_uuid String 否 F85DFEC0-149E-373D-0B9E-3DA9A5C43940 备机（目标节点）的uuid ，云版可不填
  wk_data_type Number 否 1 源类型，0：块设备；1：文件；
  bk_path Array 否 ["/fsp_bk/"] 备机（目标节点）路径，备份数据存放路径，

！！！CDM：传空！！！ 云版可不填 |   sync_item | String | 否 | / | 同步项 |   bkup_policy | Number | 否 | 2 | 备份策略，2立刻，0定时，1周期 |   mirr_file_check | String | 否 | 0 | 校验方式 |   compress | String | 否 | 0 | 压缩：0不开启；1，低；2，中；3，高 |   monitor_type | Number | 否 | 0 | 迁移设置：MSCS支持 |   failover | String | 否 | 0 | 是否支持备端拉起，1是0否；默认1；这个开关只有 文件到vmdk才需要显示（2019/1/15 向lianghr确认） |   wk_path | Array | 否 | ["/"] | 源路径 |   fsp_name | String | 否 | test | 名字 |   wk_uuid | String | 否 | 42614852-BB62-1EF7-FED0-D2354BF3149D | 工作机id |   fsp_wk_shut_flag | String | 否 | 2 | 迁移设置：自动关工作机 |   bk_data_type | Number | 否 | 1 | 目标类型，1：文件；2：raw；3：vmdk；4：qcow；5 华为云；7：容灾平台 |   bkup_schedule | Array | 否 | | 周期任务（备份策略） |     sched_day | Array | 否 | "@integer(1, 31)" | 哪几天 |     sched_time | Array | 否 | @time('HH:mm') | 哪几点 |     sched_every | Number | 否 | 2 | 0：每天；1：每周：2：每月；3：每隔； |     limit | Number | 否 | @integer(1, 64) | 数据保留期限（天） |     backup_type | Number | 否 | 0 | 0 全备，1 差异，2增量 |     policys | String | 否 | "每天22:00自动执行" | |     backup_type_show | String | 否 | "全备" | |     running_time | String | 否 | "22:00" | |   fsp_type | Number | 否 | 3 | 任务类型：3：备份；5：还原；10：备份模板；11：还原模板； |   random_str | String | 否 | 11111111-1111-1111-1111-111111111111 | 修改传这个，新建不传 |   del_policy | Number | 否 | | 删除策略，0：不开启；1：开启； |   timeout | Number | 否 | | 超时时间，超过这个时间还没备完则产生告警， 默认0， 大小0 - 168之间 |   cbt_switch | Number | 否 | | CBT开关，勾选为1，不勾选为0。表示是否支持磁盘变化块跟踪 |   threshold_vaild_byte | String | 否 | | 有效增量数据大小，单位MB，下拉菜单展示：1、2、4、8、16、32、64、128、256、512 |   advanced_policy | Object | 否 | | 高级策略 |     bk_cdp | Number | 否 | | 细粒度备份开关，勾选为1，不勾选为0 |     execute_interval | Number | 否 | | 执行时间间隔 |     cdp_detail | Number | 否 | | 保留个数 |     cdp_daily | Number | 否 | | 保留天数 |     cdp_switch | Number | 否 | | 全备策略开关，勾选为1，不勾选为0 |     cdp_param | String | 否 | | 全备策略，是几个参数的合并，可参考复制规则的cdp_param |   vp_uuid | String | 否 | | 容灾平台uuid，只有cdm才传 |   storage_uuid | String | 否 | | 存储uuid，只有cdm才传 |

# Response

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

# 全服备份-2 修改规则

方法名：modifyFspBackup

# URL

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

# Method

PUT

# Request

名称 类型 必选 初始值 简介 Mock规则
fsp_backup Object 否
  secret_key String 否
  band_width String 否 303:00-14:002m
  mirr_open_type String 否 0
  service_uuid String 否
  mirr_sync_flag String 否 0
  excl_path Array 否 ["/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_time Number 否 1515568566
  encrypt_switch String 否 0
  bk_type Number 否 0
  mirr_sync_attr String 否 1
  bk_uuid String 否 C11FE572-5207-3359-DB85-001E95F5F185
  wk_data_type Number 否 1
  bk_path Array 否 ["/FSPback0107/"],
  sync_item String 否 /
  bkup_policy Number 否 0
  net_mapping_type String 否 2
  snapshot_policy String 否 0
  mirr_file_check String 否 0
  snapshot_interval String 否 0
  compress String 否 0
  monitor_type Number 否 0
  failover String 否 0
  wk_path Array 否 ["/","/boot/"],
  snapshot_limit String 否 24
  snapshot_switch Number 否 0
  fsp_name String 否 rrrrr
  wk_uuid String 否 CE77F3D6-A6E3-A385-CE66-712313B7DDE8
  fsp_wk_shut_flag String 否 2
  bk_data_type Number 否 0
  bkup_schedule Array 否
    sched_day Number 否 22
    sched_time String 否 01:06
    sched_every Number 否 2
    limit Number 否 29
    backup_type Number 否 1
    backup_type_show String 否 "全备"
    running_time String 否 "22:00"
    policys String 否 "每天22:00自动执行"
  fsp_type Number 否 1
  random_str String 否 11111111-1111-1111-1111-111111111111 新建不用传，修改用到这个；
  timeout Number 否 超时时间，超过这个时间还没备完则产生告警， 默认0， 大小0 - 168之间
  cbt_switch Number 否 CBT开关，勾选为1，不勾选为0。表示是否支持磁盘变化块跟踪
  threshold_vaild_byte Number 否 有效增量数据大小，单位MB，下拉菜单展示：1、2、4、8、16、32、64、128、256、512
  advanced_policy Object 否 高级策略
    bk_cdp Number 否 细粒度备份开关，勾选为1，不勾选为0
    execute_interval Number 否 执行时间间隔
    cdp_detail Number 否 保留个数
    cdp_daily Number 否 保留天数
    cdp_switch Number 否 全备策略开关，勾选为1，不勾选为0
    cdp_param String 否 全备策略，是几个参数的合并，可参考复制规则的cdp_param

# Response

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

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

方法名：describeFspBackup

# URL

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

# Method

GET

# Request

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

# Response

名称 类型 必选 初始值 简介 Mock规则
data Object 否
  message String 否
  fsp_backup Object 否
    bk_ip String 否 0.0.0.0 备机控制地址
    bkup_one_time Number 否 1515568566 定时任务，执行时间（备份策略）
    wk_port String 否 26821 控制机控制端口
    mirr_open_type String 否 0 文件打开方式
    wk_uuid String 否 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 工作机id
    secret_key String 否 加密key
    bk_data_type Number 否 0 目标类型，1：文件；2：raw；3：vmdk；4：qcow；
    bkup_policy Number 否 0 @mock=0, 备份策略，0立刻，1定时，2周期
    wk_path String 否 源路径
    bk_path String 否 备机（目标节点）路径，备份数据存放路径，云版可不填
    fsp_name String 否 rrrrr 名字
    mirror_method String 否 0 首次镜像方式
    bk_uuid String 否 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 备机（目标节点）的uuid ，云版可不填
    wk_data_type Number 否 1 源类型，0：块设备；1：文件；
    mirr_file_check String 否 0 校验方式
    excl_path String 否 源机排除目录
    monitor_type Number 否 0 @mock=0, 迁移设置：MSCS支持
    band_width String 否 303:00-14:002m @mock=303:00-14:002m, 带宽控制机，格式：303:00-14:002m,202:00-15:0080m
    service_uuid String 否 @mock=, 空
    backup_type Number 否 @pick([0, 1, 2]) @mock=@pick([0, 1, 2]), 0 全备，1 差异，2增量
    bkup_schedule Array 否 , 周期任务（备份策略）
      sched_day Array 否 "@integer(1, 31)" @mock="@integer(1, 31)", 哪几天
      sched_time_end String 否 @time('HH:mm') @mock=@time('HH:mm'), 运行时间范围 结束
      limit Number 否 @integer(1, 64) @mock=@integer(1, 64), 数据保留期限（天）
      sched_gap_min Number 否 @integer(1, 64) @mock=@integer(1, 64), 间隔分钟数
      sched_time Array 否 @time('HH:mm') @mock=@time('HH:mm'), 哪几点
      sched_every Number 否 2 @mock=2, 0：每天；1：每周：2：每月；3：每隔；
      sched_time_start String 否 @time('HH:mm') @mock=@time('HH:mm'), 运行时间范围 开始
    compress String 否 0 @mock=0, 压缩：0不开启；1，低；2，中；3，高
    move_type String 否 0 @mock=0, 默认0
    wk_ip String 否 0.0.0.0 @mock=0.0.0.0, 工作机控制地址
    mirr_sync_attr String 否 1 @mock=1, 文件安全属性
    bk_port String 否 26831 @mock=26831, 备机控制端口
    fsp_type String 否 1 @mock=1, 默认1
    fsp_wk_shut_flag String 否 2 @mock=2, 迁移设置：自动关工作机
    failover String 否 0 迁移设置，手工（2）/自动（1）切换
    mirr_sync_flag String 否 0 @mock=0, 错误处理方式
    random_str String 否 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 用于防止并发修改的随机串
    sync_item String 否 C: @mock=C:, 同步项
    net_mapping Array 否 @mock=, 网络设置：网卡映射
    net_mapping_type String 否 2 @mock=2, 网络设置：网络迁移配置
    encrypt_switch String 否 0 @mock=0, 0不开启，1开启
    fsp_type String 否 任务类型：3：备份；5：还原；10：备份模板；11：还原模板；
    cbt_switch Number 否 CBT开关，勾选为1，不勾选为0。表示是否支持磁盘变化块跟踪
    threshold_vaild_byte Number 否 有效增量数据大小，单位MB，下拉菜单展示：1、2、4、8、16、32、64、128、256、512
    advanced_policy Object 否 高级策略
      bk_cdp Number 否 细粒度备份开关，勾选为1，不勾选为0
      execute_interval Number 否 执行时间间隔
      cdp_detail Number 否 保留个数
      cdp_daily Number 否 保留天数
      cdp_switch Number 否 全备策略开关，勾选为1，不勾选为0
      cdp_param String 否 全备策略，是几个参数的合并，可参考复制规则的cdp_param
    vp_uuid String 否 容灾平台uuid
    storage_uuid String 否 存储uuid
    storage Object 否 存储的具体信息
      type String 否 localfs, nfs,glusterfs
      path String 否
  code Number 否 0 @mock=0
ret Number 否 200 @mock=200
msg String 否 @mock=

# 全服备份-3 删除规则

方法名：deleteFspBackup

# URL

//fsp/backup

# Method

DELETE

# Request

名称 类型 必选 初始值 简介 Mock规则
fsp_uuids Array 否 ["11111111-1111-1111-1111-111111111111"] *规则数组
del_policy Number 否 1 *删除策略，0：不开启；1：开启；

# Response

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

# 全服备份-3 获取规则列表（基本信息）

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

# URL

//fsp/backup

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
type Number 否 3 任务类型：3：备份；5：还原；10：备份模板；11：还原模板；
limit Number 否 10
page Number 否 1

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] success
  info_list Array 否
    band_width String 否 2400:00-22:594m
    bkup_schedule Array 否
      backup_type_show String 否 全备
      policys String 否 每天22:00自动执行
      backup_type String 否 0
      sched_every String 否 0
      running_time String 否 22:00
      sched_time Array 否 [ "22:00" ]
      sched_day Array 否 []
      limit String 否 1
    random_str String 否 0E807AD3-DD1E-9224-2B9B-E713CF258467
    wk_node_name String 否 name
    bk_node_name String 否 name
    username String 否 admin
    bk_path_policy String 否 0
    fsp_name String 否 asdasddsasdasd
    fsp_type String 否 3
    fsp_uuid String 否 E28184D8-869B-BF56-A77C-3CC835FAAC34
    wk_uuid String 否 0E807AD3-DD1E-9224-2B9B-E713CF258467
    bk_uuid String 否 F28184D8-869B-BF56-A77C-3CC835FAAC35
    can_op Number 否 1
    can_del Number 否 1
    can_up Number 否 1
  total Number 否 1

# 全服备份-3 规则操作

方法名：[action] + 'FspBackup'

# URL

//fsp/backup/operate

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
operate String 否 start start, stop, finish(f..仅用于结束整机手工备份)
fsp_uuids Array 否 ["11111111-1111-1111-1111-111111111111"] , *规则数组
bk_type String 否 立即执行操作（start_immediately）必传，取值为，备份策略 - 周期任务 - 备份方式；0：全备，1：增量，2：差异
continue_last_backup Number 否 0 一次性备份任务结束后，是否继续备份到上一次目录。1，是；0，否。默认为0

# Response

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

# 全服备份-3 规则状态

方法名：listFspBackupStatus

# URL

//fsp/backup/status

# Method

GET

# Request

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

# Response

名称 类型 必选 初始值 简介 Mock规则
msg String 否 @mock=
ret Number 否 200 @mock=200
data Object 否
  message String 否
  status Object 否
    fsp_uuid String 否 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, uuid
    f_total String 否 0 @mock=0, ? 默认0
    progress String 否 0 @mock=0, 进度
    status String 否 STOP @mock=STOP, 状态文字
    db_status String 否 @mock=, ？默认空
    latency Number 否 复制延迟，ms单位
    wk_status String 否 工作机状态，ONLINE,OFFLINE
  code Number 否 0 @mock=0
  count Number 否 0 @mock=0

# -------------------------- 分隔线 --------------------------

# URL

//dash_fsp_1

# Method

GET

# Request

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

# Response

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

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

方法名：listFspRecoveryNic

# URL

//fsp/recovery/nic_list

# Method

GET

# Request

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

# Response

名称 类型 必选 初始值 简介 Mock规则
data Object 否
  message String 否 [0] success @mock=[0] success
  code Number 否 0 @mock=0
  wk_nic_list Array 否 , 网卡列表 3
    name String 否 @pick(["Ethernet0", "Ethernet1", "Ethernet2"]) @mock=@pick(["Ethernet0", "Ethernet1", "Ethernet2"]), 网卡名
    ip String 否 192.168.72.73/255.255.240.0 @mock=192.168.72.73/255.255.240.0, 带子网掩码的ip
    type String 否 0 @mock=0, 0: 静态; 1: dhcp;
  bk_nic_list Array 否 , 网卡列表 3
    ip String 否 192.168.72.74/255.255.240.0 @mock=192.168.72.74/255.255.240.0, 带子网掩码的ip
    type String 否 0 @mock=0, 0: 静态; 1: dhcp;
    name String 否 @pick(["VMware Network Adapter VMnet8", "以太网", "VMware Network Adapter VMnet9"]) @mock=@pick(["VMware Network Adapter VMnet8", "以太网", "VMware Network Adapter VMnet9"]), 网卡名
msg String 否 @mock=
ret Number 否 200 @mock=200

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

SDK类名：/fsp/FspRecovery

SDK方法名：listFspRecoveryDir

# URL

//fsp/recovery/dir_list

# Method

GET

# Request

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

# Response

名称 类型 必选 初始值 简介 Mock规则
msg String 否 @mock=
ret Number 否 200 @mock=200
data Object 否
  message String 否 [0] success @mock=[0] success
  hd_list Array 否 , 磁盘列表 3
    label String 否 @pick(["C:", "F:", "G:"]) @mock=@pick(["C:", "F:", "G:"]), 卷标
    is_system Number 否 @pick(["0", "1"]) @mock=@pick(["0", "1"]), 是系统盘1，不是0
  os_type String 否 @pick(["1", "2"]) @mock=@pick(["1", "2"]), os类型 1linux 2win
  code Number 否 0 @mock=0
  dir_list Array 否
    wk_path String 否 C:\ @mock=C:\, 工作路径，新建时没有这字段
    type String 否 @pick(["0", "1", "2"]) @mock=@pick(["0", "1", "2"]), 0：路径磁盘后加FFO；1：不用加FFO；2：排除；
    bk_path String 否 C:\ @mock=C:\, 备份数据目录

# 全服恢复-0 获取还原点

方法名：listFspRecoveryPoint

# URL

//fsp/recovery/point_list

# Method

GET

# Request

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

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200 @mock=200
data Object 否
  message String 否 [0] success @mock=[0] success
  code Number 否 0 @mock=0
  point_list Array 否 20171117132436 @mock=20171117132436, 时间点
    time_point String 否 20171117132436
    type String 否 0 全备，1 差异，2增量
msg String 否 @mock=

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

方法名：verifyFspRecoveryVolumeSpace

# URL

//fsp/recovery/verify_volume_space

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
wk_uuid String 否 42614852-BB62-1EF7-FED0-D2354BF3149D @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机id
bk_uuid String 否 F85DFEC0-149E-373D-0B9E-3DA9A5C43940 @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机（目标节点）uuid
dst_path String 否 /fsp_bk/192.168.71.77_26821/20190111113656/ @mock=???, 备份数据路径
sync_item String 否 / @mock=C:\, 同步项目（磁盘），逗号分隔

# Response

名称 类型 必选 初始值 简介 Mock规则
msg String 否 @mock=
data Object 否
  code Number 否 0 @mock=0
  message String 否 [0] success @mock=[0] success
  wk_vol_list Array 否 , 源盘符列表
    used String 否 1234 @mock=1234, 已用
    name String 否 C: @mock=C:, 磁盘名
    total String 否 1234 @mock=1234, 总容量
  bk_vol_list Array 否 , 目标盘符列表
    total Number 否 1234 @mock=1234, 总容量
    name String 否 C: @mock=C:, 磁盘名
    free String 否 1234 @mock=1234, 空闲
ret Number 否 200 @mock=200

# （废除）全服恢复-1 检测条件-license

方法名：verifyFspRecoveryLicense

# URL

//fsp/recovery/verify_license

# Method

POST

# Request

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

# Response

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

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

方法名：verifyFspRecoveryOldRule

# URL

//fsp/recovery/verify_old_rule

# Method

POST

# Request

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

# Response

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

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

方法名：verifyFspRecoveryOsVersion

# URL

//fsp/recovery/verify_os_version

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
dst_path String 否 /fsp_bk/192.168.71.77_26821/20190111113656/ @mock=???, ??
wk_uuid String 否 F85DFEC0-149E-373D-0B9E-3DA9A5C43940 @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机id
bk_uuid String 否 42614852-BB62-1EF7-FED0-D2354BF3149D @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机（目标节点）uuid

# Response

名称 类型 必选 初始值 简介 Mock规则
data Object 否
  message String 否 [0] success @mock=[0] success
  code Number 否 0 @mock=0
  wk_os_ver String 否 Microsoft Windows 10/x64 Edition @mock=Microsoft Windows 10/x64 Edition, 目标系统版本
  bk_os_ver String 否 Microsoft Windows 10/x64 Edition @mock=Microsoft Windows 10/x64 Edition, 目标系统版本
msg String 否 @mock=
ret Number 否 200 @mock=200

# 全服恢复-2 新建规则

方法名：createFspRecovery

# URL

//fsp/recovery

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
fsp_recovery Object 否
  dst_path String 否 /fsp_bk/192.168.71.77_26821/20190111113656/ 目标路径
  monitor_type Number 否 0 迁移设置：MSCS支持
  encrypt_switch String 否 0 0不开启，1开启
  net_mapping Array 否 网络设置：网卡映射
    bk_nic Object 否 网卡列表
      type String 否 0 一般用获取网卡接口同样值即可; 0: 静态; 1: dhcp;
      name String 否 Ethernet0 网卡名
      ip String 否 192.168.72.74/255.255.240.0 带子网掩码的ip
    wk_nic Object 否 网卡列表
      name String 否 Ethernet0 网卡名
      type String 否 0 一般用获取网卡接口同样值即可; 0: 静态; 1: dhcp;
      ip String 否 192.168.72.73/255.255.240.0 带子网掩码的ip
  wk_uuid String 否 42614852-BB62-1EF7-FED0-D2354BF3149D 工作机id
  mirr_sync_attr String 否 1 文件安全属性
  secret_key String 否 加密key
  bk_path Array 否 ["/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_width String 否 带宽控制机，格式：303:00-14:002m,202:00-15:0080m
  fsp_name String 否 testRC 名字
  bk_uuid String 否 F85DFEC0-149E-373D-0B9E-3DA9A5C43940 备机（目标节点）的uuid ，云版可不填
  net_mapping_type String 否 2 网络设置：网络迁移配置，1：同步原机网络配置，2：不同步；
  mirr_open_type String 否 0 文件打开方式
  restore_point String 否 20190111113656 还原时间点
  mirr_file_check String 否 0 校验方式
  compress String 否 0 压缩：0不开启；1，低；2，中；
  service_uuid String 否 空
  excl_path Array 否 源机排除目录
  wk_path Array 否 ["/", "/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_flag String 否 0 错误处理方式
  fsp_wk_shut_flag String 否 2 迁移设置：自动关工作机
  sync_item String 否 / 同步项
  failover String 否 0 迁移设置，手工切换0，自动切换1（2019/1/15 向lianghr确认）
  fsp_type String 否 5 任务类型：3：备份；5：还原；10：备份模板；11：还原模板；
  random_str String 否 11111111-1111-1111-1111-111111111111 新建不用传

# Response

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

# 全服恢复-2 修改规则

方法名：modifyFspRecovery

# URL

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

# Method

PUT

# Request

名称 类型 必选 初始值 简介 Mock规则
fsp_recovery Object 否
  restore_point String 否 20180724164452 @mock=20180724164452, 还原时间点
  fsp_wk_shut_flag String 否 2 @mock=2, 迁移设置：自动关工作机
  excl_path Array 否 , 源机排除目录
  secret_key String 否 @mock=, 加密key
  band_width String 否 303:00-14:002m @mock=303:00-14:002m, 带宽控制机，格式：303:00-14:002m,202:00-15:0080m
  compress String 否 0 @mock=0, 压缩：0不开启；1，低；2，中；
  wk_path Array 否 , 源路径
  net_mapping Array 否 , 网络设置：网卡映射
    wk_nic Object 否 , 网卡列表
      ip String 否 192.168.72.73/255.255.240.0 @mock=192.168.72.73/255.255.240.0, 带子网掩码的ip
      type String 否 0 @mock=0, 一般用获取网卡接口同样值即可; 0: 静态; 1: dhcp;
      name String 否 Ethernet0 @mock=Ethernet0, 网卡名
    bk_nic Object 否 , 网卡列表
      type String 否 0 @mock=0, 一般用获取网卡接口同样值即可; 0: 静态; 1: dhcp;
      ip String 否 192.168.72.74/255.255.240.0 @mock=192.168.72.74/255.255.240.0, 带子网掩码的ip
      name String 否 Ethernet0 @mock=Ethernet0, 网卡名
  service_uuid String 否 @mock=, 空
  wk_uuid String 否 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机id
  net_mapping_type String 否 2 @mock=2, 网络设置：网络迁移配置
  bk_path Array 否 , 备机（目标节点）路径，备份数据存放路径，云版可不填
  fsp_name String 否 rrrrr @mock=rrrrr, 名字
  mirr_sync_flag String 否 0 @mock=0, 错误处理方式
  mirr_file_check String 否 0 @mock=0, 校验方式
  monitor_type Number 否 0 @mock=0, 迁移设置：MSCS支持
  sync_item String 否 C: @mock=C:, 同步项
  mirr_sync_attr String 否 1 @mock=1, 文件安全属性
  random_str String 否 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 用于防止并发修改的随机串
  dst_path String 否 ??? @mock=???, 目标路径
  encrypt_switch String 否 0 @mock=0, 0不开启，1开启
  bk_uuid String 否 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机（目标节点）的uuid ，云版可不填
  mirr_open_type String 否 0 @mock=0, 文件打开方式
  failover String 否 0 迁移设置，手工（0）/自动（1）切换
  fsp_type String 否 任务类型：3：备份；5：还原；10：备份模板；11：还原模板；

# Response

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

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

方法名：desribeFspRecovery

# URL

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

# Method

GET

# Request

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

# Response

名称 类型 必选 初始值 简介 Mock规则
data Object 否
  code Number 否 0 @mock=0
  fsp_recovery Object 否
    wk_port String 否 26821 @mock=26821, 控制机控制端口
    fsp_wk_shut_flag String 否 2 @mock=2, 迁移设置：自动关工作机
    compress String 否 0 @mock=0, 压缩：0不开启；1，低；2，中；
    encrypt_switch String 否 0 @mock=0, 0不开启，1开启
    mirr_sync_attr String 否 1 @mock=1, 文件安全属性
    move_type String 否 0 @mock=0, 默认0
    excl_path String 否 源机排除目录
    wk_ip String 否 0.0.0.0 @mock=0.0.0.0, 工作机控制地址
    band_width String 否 303:00-14:002m @mock=303:00-14:002m, 带宽控制机，格式：303:00-14:002m,202:00-15:0080m
    mirr_open_type String 否 0 @mock=0, 文件打开方式
    wk_path String 否
    wk_uuid String 否 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机id
    restore_point String 否 20180724164452 @mock=20180724164452, 还原时间点
    fsp_name String 否 rrrrr @mock=rrrrr, 名字
    secret_key String 否 @mock=, 加密key
    failover String 否 0 迁移设置，手工（0）/自动（1）切换
    service_uuid String 否 @mock=, 空
    monitor_type Number 否 0 @mock=0, 迁移设置：MSCS支持
    sync_item String 否 C: @mock=C:, 同步项
    bk_path String 否
    bk_port String 否 26831 @mock=26831, 备机控制端口
    mirr_file_check String 否 0 @mock=0, 校验方式
    mirr_sync_flag String 否 0 @mock=0, 错误处理方式
    mirror_method String 否 0 @mock=0, 首次镜像方式
    bk_uuid String 否 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机（目标节点）的uuid ，云版可不填
    net_mapping Array 否 @mock=, 网络设置：网卡映射
    net_mapping_type String 否 2 @mock=2, 网络设置：网络迁移配置
    bk_ip String 否 0.0.0.0 @mock=0.0.0.0, 备机控制地址
    random_str String 否 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 用于防止并发修改的随机串
    fsp_type String 否 任务类型：3：备份；5：还原；10：备份模板；11：还原模板；
  message String 否
msg String 否 @mock=
ret Number 否 200 @mock=200

# 全服恢复-3 删除规则

SDK方法名：deleteFspRecovery

# URL

//fsp/recovery

# Method

DELETE

# Request

名称 类型 必选 初始值 简介 Mock规则
fsp_uuids Array 否 ["11111111-1111-1111-1111-111111111111"] , *规则数组

# Response

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

# 全服恢复-3 获取规则列表（基本信息）

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

# URL

//fsp/recovery

# Method

GET

# Request

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

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200 @mock=200
data Object 否
  code Number 否 0 @mock=0
  count Number 否 10 @mock=10, 规则数量
  total Number 否 100 @mock=100, 规则总数
  message String 否
  info_list Array 否 5
    wk_node_name String 否 @pick(["Smith", "Will", "Nary"]) @mock=@pick(["Smith", "Will", "Nary"]), 源节点名
    wk_path String 否 C:\123\ @mock=C:\123, 源路径
    fsp_uuid String 否 @pick(["0DD4E727-70AB-62C6-BEB5-D012DFAE46E3", "0DD4E727-70AB-62C6-BEB5-D012DFAE46E4"]) @mock=@pick(["0DD4E727-70AB-62C6-BEB5-D012DFAE46E3", "0DD4E727-70AB-62C6-BEB5-D012DFAE46E4"]), 规则UUID
    username String 否 @pick(["admin", "user", "super"]) @mock=@pick(["admin", "user", "super"]), 用户名
    excl_path String 否 @mock=, 排除路径
    bk_uuid String 否 7AD64D7A-7D1D-AC51-5DF1-29A58345A288 @mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 目标节点名
    bk_path String 否 C:\ascasldfjlksjf\ @mock=C:\ascasldfjlksjf, 目标节点路径
    fsp_name String 否 testbak @mock=testbak, 规则名
    wk_uuid String 否 7AD64D7A-7D1D-AC51-5DF1-29A58345A288 @mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 源节点名
    band_width String 否 @pick(["100", "150", "200"]) @mock=@pick(["100", "150", "200"]), 带宽控制
    bk_node_name String 否 @pick(["kevin", "Jane", "Grey"]) @mock=@pick(["kevin", "Jane", "Grey"]), 目标节点名
    fsp_type String 否 任务类型：3：备份；5：还原；10：备份模板；11：还原模板；
msg String 否 @mock=

# 全服恢复-3 规则操作

方法名：[action] + 'FspRecovery'

# URL

//fsp/recovery/operate

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
fsp_uuids Array 否 ["11111111-1111-1111-1111-111111111111"] 规则数组
operate String 否 start start, stop, move, reboot

# Response

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

# 全服恢复-3 规则状态

方法名: listFspRecoveryStatus

# URL

//fsp/recovery/status

# Method

GET

# Request

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

# Response

名称 类型 必选 初始值 简介 Mock规则
msg String 否 @mock=
data Object 否
  status Object 否
    status String 否 STOP @mock=STOP, 状态文字
    db_status String 否 @mock=, ？默认空
    fsp_uuid String 否 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, uuid
    f_total String 否 0 @mock=0, ? 默认0
    progress String 否 0 @mock=0, 进度
  count Number 否 0 @mock=0
  message String 否
  code Number 否 0 @mock=0
ret Number 否 200 @mock=200
Last Updated: 5/13/2020, 3:56:32 AM