# 复制规则

SDK类名:/rep/RepBackup;

# 复制规则 - 获取 cdp zfs池列表

SDK方法名:listRepBackupCdpZfs

# URL

//rep/backup/cdp_zfs

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
bk_uuid String 灾备机uuid

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功。
  list Array ["zpoolname1","zpoolname2","zpoolname3"] zfs 池名称列表

# 复制规则 - 检查是否挂载盘

# URL

//rep/backup/verify_device

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
node_uuid String 灾备机uuid
dir_name String 某个路径,用来检查这路径是本地磁盘还是挂载盘

# Response

名称 类型 必选 初始值 简介 Mock规则
msg String
ret Number 200
data Object
  code Number 0 如果不是返回成功,就说明当前路径是挂载盘,挂载盘不支持CDP
  message String

# 复制规则 - 新建

SDK方法名:createRepBackup

# URL

//rep/backup

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
rep_backup Object 规则表单对象
  rep_name String rep_backup 复制规则名(必传)
  rep_type Number 0 0: default; 1: cluster; 2: block; 10: template;(必传)
  wk_uuid String B8566905-411E-B2CD-A742-77B1346D8E84 工作机id(必传)
  wk_path Array ["E:\test\"] 工作目录(必传)
  bk_uuid String B8566905-411E-B2CD-A742-77B1346D8E84 备机(目标节点)的uuid ,云版可不填(block也有)
  bk_path Array ["E:\test2\"] 备机(目标节点)路径,备份数据存放路径,云版可不填(block也有)
  excl_path Array 源机排除目录
  auto_start String 1 规则自动启动(block也有)
  compress String 0 压缩:0不开启;1,低;2,中;3,高(block也有)
  encrypt_switch String 0 0不开启,1开启(block也有)
  secret_key String 加密key(block也有)
  band_width String 带宽控制,格式:303:00-14:002m,202:00-15:0080m(block也有)
  mirr_sched_switch Number 0 高级设置 - 启用禁止镜像:1;关闭:0;(block也有)
  mirr_sched String 高级设置 - 禁止镜像策略;Eg: 303:00-14:00,202:00-15:00(block也有)
  mirr_open_type String 0 文件打开方式
  mirr_sync_attr String 1 文件安全属性
  mirr_sync_flag String 0 错误处理方式
  mirr_file_check String 0 校验方式
  mirr_skip String 0 镜像设置 - 跳过镜像;0:正常镜像;1:直接进入复制状态;2:仅同步目录;
  snapshot_switch Number 1 快照开关
  snapshot_policy String 0 快照个数达到上限时策略
  snapshot_start Number 1546913351 开始时间,Eg: 1515568566
  snapshot_limit String 24 快照数目
  snapshot_interval String 1 快照间隔
  file_type_filter_switch Number 0 包含0排除1
  file_type_filter String 文件类型过滤,比如:.doc,.docx
  bkup_one_time Number 1515568566 定时任务,执行时间(备份策略) Eg: 1515568566
  bk_path_policy String 1 源路径目标路径路径映射关系:0:一对一,1:多对一;
  disk_limit String 0 该规则最大可用存储空间
  del_policy String 1 删除策略,0:不开启;1:开启;
  thread_num String 0 并行任务数
  oph_path String E:\test4\ 孤儿文件,移动到指定路径、归档,必填
  oph_policy String 2 孤儿文件处理策略:0不处理,1删除,2移动到指定路径;6 归档;
  latency_threshold Number 延迟告警毫秒数,默认值0不告警
  cdp_switch String 1 0:不启用;1:开启
  cdp_process_time String 05:07:28 hh:mm:ss , 默认00:00:00
  cdp_path String E:\test3\ CDP数据目录 : 如开启CDP则必填
  cdp_param String 3,30,0 CDP参数:是几个参数的合并
  cdp_data_inc_switch Number 0 按数据增量做快照开关
  cdp_baseline_format String 0 Baseline存储格式: 保持源目录结构 打包
  cdp_bl_bkup_switch Number 0 创建baseline副本 0否1是;
  cdp_bl_sched_switch Number 1 指定生成Baseline(全备份)的策略
  cdp_bl_sched String 2 1 0
  cdp_snap_on Number 0 使用快照做Baseline;0关1开;
  cdp_snap_count Number 240 CDP快照数量,0到9999之间的整数
  cdp_snap_interval Number 30 CDP快照间隔,5,10,15,20,25,30,40,50,60,单位是分钟
  cdp_zfs_pool String CDP zfs存储池,选择系统上已有的存储池,仅在cdp页面快照打开且备机是Linux系统时的时候显示.,如果获取的value值为空,则cdp不支持linux快照方式。
  cdp_data_inc Number 0 数据增量的大小,单位为M
  cdp_data_inc_flag String 用来表示数据增量单位 M G T
  ct_name_type Number 0 文件名替换,0表示不启用。1加前后缀,原来部分保持不变;2前后缀加小写,3前后缀加大写 4自定义
  ct_name_str1 String 文件名转换:prefix string / regex string
  ct_name_str2 String 文件名转换:suffix string / replace string
  ct_name_str3 String 文件名转换:restore regex string
  ct_name_str4 String 文件名转换:restore regex string
  cmp_switch Number 0 比较计划,0: 关; 1: 开;
  cmp_file_check Number 0 比较计划,校验方式,0:md5;1:文件大小和时间;
  cmp_schedule Array 比较计划,策略
    sched_every Number 每,0天,1周,2月;
    sched_time Array ["@time('HH:mm')"] 哪几点
    sched_day Array ["@integer(1, 31)"] 哪几天
  mscs_autostart Number 开关: 集群故障转移到另一节点时,自动启动复制规则

勾选是1 不勾选是0 |   mir_detect_script | String | 否 | | 高级设置 - 检测脚本路径 |   mscs_group | Object | 否 | | 已选集群组 |

# Response

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

# 复制规则 - 获取单个

SDK方法名:describeRepBackup;以新建接口内容为准

# URL

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

# Method

GET

# Request

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

# Response

名称 类型 必选 初始值 简介 Mock规则
data Object
  code Number 0 @mock=0
  message String
  rep_backup Object , 规则表对象
    cdp_path String @mock=, CDP数据目录 : 如开启CDP则必填
    disk_limit String 0 @mock=0, 该规则最大可用存储空间
    policy_operation Number , 达到上限所做的操作:0,循环;1,停止
    rep_uuid String EFB53F11-7BA2-2001-3418-85865EA58E47 @mock=EFB53F11-7BA2-2001-3418-85865EA58E47, 复制规则uuid
    policy_interval Number , 定时备份间隔
    mirr_sched String 303:00-14:00,202:00-15:00 @mock=303:00-14:00,202:00-15:00, 镜像窗口时间控制
    policy_limit Number , 保留副本的个数
    encrypt_switch String 0 @mock=0, 0不开启,1开启
    random_str String 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 用于防止并发修改的随机串
    auto_start String 1 @mock=1, 规则自动启动
    del_policy String 1 @mock=1, 删除策略
    cdp_bl_sched_switch Number 0 @mock=0, 指定生成Baseline(全备份)的策略
    rep_type Number 0 @mock=0, 0: default; 1: cluster; 2: block; 10: template;
    cdp_bl_bkup_switch Number 0 @mock=0, 创建baseline副本 0 1
    cdp_param String @mock=, CDP参数:是几个参数的合并
    rep_name String rrrrr @mock=rrrrr, 复制规则名
    compress String 0 @mock=0, 压缩:0不开启;1,低;2,中;3,高
    bk_port String 26831 @mock=26831, 备机控制端口
    mirr_sync_flag String 0 @mock=0, 错误处理方式
    cdp_baseline_format String @mock=, Baseline存储格式: 保持源目录结构 打包
    file_type_filter String @mock=, 文件类型过滤,比如:.doc,.docx
    snapshot_policy String 0 @mock=0, 快照个数达到上限时策略
    bk_ip String 0.0.0.0 @mock=0.0.0.0, 备机控制地址
    snapshot_switch Number 0 @mock=0, 快照开关
    wk_port String 26821 @mock=26821, 控制机控制端口
    band_width String 303:00-14:002m,202:00-15:0080m @mock=303:00-14:002m,202:00-15:0080m, 带宽控制,格式:303:00-14:002m,202:00-15:0080m
    group_uuid String 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 组id
    file_check Number , ???
    cdp_process_time String @mock=, hh:mm:ss , 默认00:00:00
    oph_path String @mock=, 孤儿文件,移动到指定路径
    create_time String , 创建时间 unix时间戳
    user_uuid String 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 用户id
    excl_path Array @mock=, 源机排除目录
    secret_key String @mock=, 加密key
    schedule String @mock=, 定期启动策略
    bk_uuid String 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机(目标节点)的uuid ,云版可不填
    bk_path_policy String 0 @mock=0, 源路径目标路径路径映射关系:0:一对一,1:多对一;
    snapshot_start Number 1515568566 @mock=1515568566, 开始时间
    cdp_switch String @mock=, 0:不启用;1:开启
    snapshot_interval String 0 @mock=0, 快照间隔
    wk_ip String 0.0.0.0 @mock=0.0.0.0, 工作机控制地址
    oph_policy String 0 @mock=0, 孤儿文件处理策略:0不处理,1删除,2移动到指定路径;6 归档;
    mirr_sync_attr String 1 @mock=1, 文件安全属性
    wk_uuid String 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机id
    policy_start Number , 开始时间,参数只针对普通备份有效,整机备份暂不支持指定开始时间;格式:Unix 时间戳
    file_type_filter_switch Number 0 @mock=0, 包含0排除1
    bkup_one_time Number 1515568566 @mock=1515568566, 定时任务,执行时间(备份策略)
    mirr_sched_switch Number 0 @mock=0, 镜像窗口时间控制 开关
    cdp_bl_sched String 2 0 0
    mirr_open_type String 0 @mock=0, 文件打开方式
    snapshot_limit String 24 @mock=24, 快照数目
    wk_path Array D:\DataTest\ @mock=D:\DataTest\, hidden 路径映射?
    mirr_file_check String 0 @mock=0, 校验方式
    mirr_skip String 0 @mock=0, 正常镜像
    bk_path Array D:\DataTest2\ @mock=D:\DataTest2\, 备机(目标节点)路径,备份数据存放路径,云版可不填
    cdp_data_inc Number
    cdp_data_inc_switch Number
    cdp_data_inc_flag String
    latency_threshold Number
    mscs_autostart Number 开关: 集群故障转移到另一节点时,自动启动复制规则

勾选是1 不勾选是0 |     mir_detect_script | String | 否 | | 高级设置 - 检测脚本路径 | ret | Number | 否 | 200 | @mock=200 | msg | String | 否 | | @mock= |

# 复制规则 - 修改

SDK方法名:modifyRepBackup;以新建接口内容为准

# URL

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

# Method

PUT

# Request

名称 类型 必选 初始值 简介 Mock规则
rep_backup Object , 规则表单对象
  cdp_param String @mock=, CDP参数:是几个参数的合并
  rep_type Number 0 @mock=0, 0: default; 1: cluster; 2: block; 10: template;
  bkup_one_time Number 1515568566 @mock=1515568566, 定时任务,执行时间(备份策略)
  snapshot_switch Number 0 @mock=0, 快照开关
  cdp_baseline_format String @mock=, Baseline存储格式: 保持源目录结构 打包
  mirr_sync_flag String 0 @mock=0, 错误处理方式
  mirr_open_type String 0 @mock=0, 文件打开方式
  auto_start String 1 @mock=1, 规则自动启动
  snapshot_policy String 0 @mock=0, 快照个数达到上限时策略
  cdp_bl_sched_switch Number 0 @mock=0, 指定生成Baseline(全备份)的策略
  snapshot_interval String 0 @mock=0, 快照间隔
  bk_path Array D:\DataTest2\ @mock=D:\DataTest2, 备机(目标节点)路径,备份数据存放路径,云版可不填
  snapshot_start Number 1515568566 @mock=1515568566, 开始时间
  random_str String 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 用于防止并发修改的随机串
  cdp_path String @mock=, CDP数据目录 : 如开启CDP则必填
  file_type_filter_switch Number 0 @mock=0, 包含0排除1
  cmp_schedule Object , 周期任务(备份策略)
    sched_time Array @time('HH:mm') @mock=@time('HH:mm'), 哪几点
    sched_day Array "@integer(1, 31)" @mock="@integer(1, 31)", 哪几天
    sched_every Number 2 @mock=2, 0:每天;1:每周:2:每月;3:每隔;
  snapshot_limit String 24 @mock=24, 快照数目
  cmp_switch Number 0 @mock=0, 比较计划,0: off; 1: on;
  oph_path String @mock=, 孤儿文件,移动到指定路径
  secret_key String @mock=, 加密key
  excl_path Array @mock=, 源机排除目录
  schedule String @mock=, 定期启动策略
  policy_interval Number , 定时备份间隔
  cdp_switch String @mock=, 0:不启用;1:开启
  wk_uuid String 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机id
  policy_operation Number , 达到上限所做的操作:0,循环;1,停止
  wk_path Array D:\DataTest\ @mock=D:\DataTest, hidden 路径映射?
  mirr_skip String 0 @mock=0, 正常镜像
  policy_limit Number , 保留副本的个数
  cdp_bl_sched String @mock=, Baseline(全备份)策略 "2 0
  del_policy String 1 @mock=1, 删除策略
  mirr_sched String 303:00-14:00,202:00-15:00 @mock=303:00-14:00,202:00-15:00, 镜像窗口时间控制
  encrypt_switch String 0 @mock=0, 0不开启,1开启
  band_width String 303:00-14:002m,202:00-15:0080m @mock=303:00-14:002m,202:00-15:0080m, 带宽控制
  compress String 0 @mock=0, 压缩:0不开启;1,低;2,中;3,高
  mirr_sync_attr String 1 @mock=1, 文件安全属性
  policy_start Number , 开始时间,参数只针对普通备份有效,整机备份暂不支持指定开始时间;格式:Unix 时间戳
  cdp_process_time String @mock=, hh:mm:ss , 默认00:00:00
  bk_path_policy String 0 @mock=0, 源路径目标路径路径映射关系:0:一对一,1:多对一;
  cdp_bl_bkup_switch Number 0 @mock=0, 创建baseline副本 0 1
  file_type_filter String @mock=, 文件类型过滤,比如:.doc,.docx
  disk_limit String 0 @mock=0, 该规则最大可用存储空间
  oph_policy String 0 @mock=0, 孤儿文件处理策略:0不处理,1删除,2移动到指定路径;6 归档;
  mirr_file_check String 0 @mock=0, 校验方式
  cmp_file_check Number 0 @mock=0, 校验方式:0: 严格校验; 1: 时间;
  mirr_sched_switch Number 0 @mock=0, 镜像窗口时间控制 开关
  thread_num String 0 并行任务数
  cdp_data_inc Number 数据增量大小
  cdp_data_inc_switch Number 按数据增量做快照开关
  cdp_data_inc_flag String M G T
  mscs_autostart Number 开关: 集群故障转移到另一节点时,自动启动复制规则

勾选是1 不勾选是0 |   mir_detect_script | String | 否 | | 高级设置 - 检测脚本路径 |

# Response

名称 类型 必选 初始值 简介 Mock规则
data Object
  code Number 0 @mock=0
  message String
  uuid String 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 复制规则uuid, 批量修改所用
ret Number 200 @mock=200
msg String @mock=

# 复制规则 - 删除

SDK方法名:deleteRepBackup;

# URL

//rep/backup

# Method

DELETE

# Request

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

# Response

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

# 复制规则 - 操作

SDK方法名:{operate}RepBackup

# URL

//rep/backup/operate

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
operate String start start:启动;stop:停止
rep_uuids Array 规则数组

# Response

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

# 复制规则 - 状态

SDK方法名:listRepBackupStatus;

# URL

//rep/backup/status

# Method

GET

# Request

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

# Response

名称 类型 必选 初始值 简介 Mock规则
msg String
ret Number 200
data Object
  code Number 0
  message String
  status Array 2
    rep_uuid String 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 规则uuid
    status Number REPLICATION 状态文字
    latency Number 10 复制延迟,单位ms

# 复制规则 - 列表

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

# URL

//rep/backup

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
search_value String 可选,搜索字段对应值(可以模糊)
limit Number 可选,不传就是全部
type Number 0: default; 1: cluster; 10: template;
page Number 可选,不传就是全部
search_field String 可选,搜索字段

# Response

名称 类型 必选 初始值 简介 Mock规则
msg String @mock=
data Object
  info_list Array 10
    bk_path Array , 目标节点路径
    band_width String 303:00-14:002m,202:00-15:0080m @mock=303:00-14:002m,202:00-15:0080m, 带宽控制
    bk_node_name String @pick(["kevin", "Jane", "Grey"]) @mock=@pick(["kevin", "Jane", "Grey"]), 目标节点名
    wk_path Array , 源路径
    username String @pick(["admin", "user", "super"]) @mock=@pick(["admin", "user", "super"]), 用户名
    rep_name String testbak @mock=testbak, 规则名
    random_str String @pick(["111", "222"]) @mock=@pick(["111", "222"]), 用于防止并发修改的随机串
    bk_uuid String 7AD64D7A-7D1D-AC51-5DF1-29A58345A288 @mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 目标节点名
    rep_uuid String @pick(["EFB53F11-7BA2-2001-3418-85865EA58E47", "0DD4E727-70AB-62C6-BEB5-D012DFAE46E3"]) @mock=@pick(["EFB53F11-7BA2-2001-3418-85865EA58E47", "0DD4E727-70AB-62C6-BEB5-D012DFAE46E3"]), 规则UUID
    rep_type Number 0 @mock=0, 0: default; 1: cluster; 2: block; 10: template;
    wk_uuid String 7AD64D7A-7D1D-AC51-5DF1-29A58345A288 @mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 源节点名
    wk_node_name String @pick(["Smith", "Will", "Nary"]) @mock=@pick(["Smith", "Will", "Nary"]), 源节点名
    excl_path Array , 排除路径
    bk_path_policy String 0 @mock=0, 0:绝对路径(源路径目标路径多对一),1:相对路径(源路径目标路径一对一);
    is_from_ha Number @pick([0, 1]) 是否属于HA关联规则;1 属于, 默认 0
    can_op Number 1
    mscs_group Object
      name String dGVzdA==
      address String 172.20.68.13
      object_id String dfadsfakjldfjdkfdfjdsfj
    can_up String 1
  count Number 10 @mock=10, 规则数量
  total Number 100 @mock=100, 规则总数
  message String
  code Number 0 @mock=0
ret Number 200 @mock=200

# 复制规则 - cdp baseline 列表 获取

SDK方法名:listRepBackupBaseLine;

用途:

1,复制规则-更多-查看cdpbaseline;

2,cdp恢复-先调这个接口得到什么baseline列表-根据用户选择的“CDP恢复时间点”从baseline列表找到当时的路径,显示在页面上;(此时路径表格的“添加”键调dir接口时,需要传rep_uuid和cdp_time)

# URL

//rep/backup/cdp_bl_list

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
rc_method Number 0 恢复方式: 0:按规则来恢复 1:按数据目录来恢复
rep_uuid String 规则uuid,rc_method为1时,可不传
bk_uuid String 灾备机uuid,rc_method为0时,可不传
data_path String 恢复数据路径;rc_method为0时,可不传
page Number 1 可选,page
limit Number 10 可选,limit,这俩必须一起传,单传一个没用

# Response

名称 类型 必选 初始值 简介 Mock规则
data Object
  list Array 3
    bs_time String 2018-10-23_13-28-35 baseline时间
    next_bs_time String 2018-10-23_13-23-08 上一个baseline时间
    wk_path Array ["E:\test\"] 生成 baseline 当时的工作路径(现在路径可能已经改了)
    bk_path Array ["E:\test\"] 生成 baseline 当时的灾备路径(现在路径可能已经改了)
    bk_path_policy Number 源路径目标路径路径映射关系:

0:一对一 1:多对一; |   code | Number | 否 | 0 | @mock=0 |   message | String | 否 | [0] 操作成功 | @mock=[0] 操作成功 |   total | Number | 否 | | | msg | String | 否 | | @mock= | ret | Number | 否 | 200 | @mock=200 |

# 复制规则 - cdp baseline 列表 删除

SDK方法名:deleteRepBackupBaseline;

# URL

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

# Method

DELETE

# Request

名称 类型 必选 初始值 简介 Mock规则
cdp_time_list Array 2017-11-17 17:24:14 cdp_time 列表

# Response

名称 类型 必选 初始值 简介 Mock规则
data Object
  success_list Array 3
    message String [0] 操作成功 @mock=[0] 操作成功
    code Number 0 @mock=0
    cdp_time String 2017-11-17 17:24:14 @mock=2017-11-17 17:24:14, CDP时间点
  message String [0] 操作成功 @mock=[0] 操作成功
  code Number 0 @mock=0
  total Number 3 @mock=3
  fail_list Array 3
    cdp_time String 2017-11-17 17:24:14 @mock=2017-11-17 17:24:14, CDP时间点
    message String [12345678] 操作失败, 原因 xxxxxx @mock=[12345678] 操作失败, 原因 xxxxxx
    code Number 12345678 @mock=12345678
msg String @mock=
ret Number 200 @mock=200

# 复制规则 - 孤儿文件 列表 获取

SDK方法名:listRepBackupOrphan;入参path只包含子路经 , 后端以规则 oph_path + path 查文件夹 ,

返回文件夹末尾不带分隔符 , 需前端拼接

# URL

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

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
path String 不包含孤儿文件存放路径的父路径

# Response

名称 类型 必选 初始值 简介 Mock规则
msg String
data Object
  code Number 0
  message String [0] 操作成功 操作成功
  orphan_list Array 100
    name String @word 目录或文件名
    time String @datetime() 创建/修改时间
    is_dir Boolean @boolean 是否为目录
    size Number @integer(100) 文件大小,返回的是"number"
  separator String / 用来拼接的路径分隔符 , 正反斜杠
  rep_oph_path String /test/oph_path 复制规则孤儿文件路径
ret Number 200

# 复制规则 - 孤儿文件 列表 删除

SDK方法名:deleteRepBackupOrphan;

# URL

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

# Method

DELETE

# Request

名称 类型 必选 初始值 简介 Mock规则
path String / 不包含孤儿文件存放路径的父路径
orphan_list Array [""] 孤儿文件名 列表

# Response

名称 类型 必选 初始值 简介 Mock规则
data Object
  success_list Array 3
    message String [0] 操作成功 @mock=[0] 操作成功
    orphan String xxxxxx @mock=xxxxxx, 孤儿文件
    code Number 0 @mock=0
  message String [0] 操作成功 @mock=[0] 操作成功
  fail_list Array 3
    code Number 12345678 @mock=12345678
    orphan String xxxxxx @mock=xxxxxx, 孤儿文件
    message String [12345678] 操作失败, 原因 xxxxxx @mock=[12345678] 操作失败, 原因 xxxxxx
  code Number 0 @mock=0
  total Number 3 @mock=3
ret Number 200 @mock=200
msg String @mock=

# 复制规则 - 孤儿文件 下载

SDK方法名:downloadRepBackupOrphan;

# URL

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

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
orphan String 孤儿文件名,Eg: test.txt
path String / 不包含孤儿文件存放路径的父路径

# Response

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

# 复制规则 - 快照 列表 获取

SDK方法名:listRepBackupSnapshot;

URL参数为 rep_uuid;如果备机为windows,列表上方显示的【快照总的占用空间】为第一条快照的 snapshot_size

# URL

//rep/backup/snapshot_list

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
rc_method String 恢复方式:

0:按规则来恢复 1:按数据目录来恢复 | rep_uuid | String | 否 | | 规则uuid,rc_method为1时,可不传 | bk_uuid | String | 否 | | 灾备机uuid,rc_method为0时,可不传 | data_path | String | 否 | | 恢复数据路径;rc_method为0时,可不传 | page | Number | 否 | 1 | 可选,page | limit | Number | 否 | 10 | 可选,limit,这俩必须一起传,单传一个没用 |

# Response

名称 类型 必选 初始值 简介 Mock规则
msg String
ret Number 200
data Object
  code Number 0
  snapshot_list Array
    snapshot_name String c5809dd2-e8be-4389-ac0d-0a657ff94da0_snap_2017-11-17_17-24-14 快照名称
    snapshot_size String 1.34 GB 大小
    snapshot_time String 2017-11-17 17:24:14 时间
    wk_path Array ["E:\test\"] 生成快照时的工作路径
    bk_path Array ["E:\test\"] 生成快照时的的灾备路径
    bk_path_policy Number 源路径目标路径路径映射关系:

0:一对一 1:多对一; |   os_type | String | 否 | @pick(["1", "2"]) | 系统: 0: linux, 1: windows |   message | String | 否 | [0] success | |   total | Number | 否 | | |

# 复制规则 - 快照 创建

SDK方法名:createRepBackupSnapshot;URL参数为 rep_uuid;

# URL

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

# Method

POST

# Request

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

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功。

# 复制规则 - 快照 删除

SDK方法名:deleteRepBackupSnapshot;URL参数为 rep_uuid;

# URL

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

# Method

DELETE

# Request

名称 类型 必选 初始值 简介 Mock规则
snapshot_names Array [] 快照名称数组

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功。

# 5 Dashboard - 获取规则列表

SDK类名:/dashboard/Dashboard; SDK方法名:repBackup;

# URL

//dashboard/rep

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
limit Number 10 可选,默认 30
page Number 1 可选,默认 1
type Number 0 0: default; 1: cluster; 2: block; 10: template;

# Response

名称 类型 必选 初始值 简介 Mock规则
msg String
data Object
  info_list Array 2
    bk_path Array
    band_width String 303:00-14:002m,202:00-15:0080m
    bk_node_name String @pick(["kevin", "Jane", "Grey"])
    wk_path Array
    username String @pick(["admin", "user", "super"])
    rep_name String testbak
    random_str String @pick(["111", "222"])
    bk_uuid String 7AD64D7A-7D1D-AC51-5DF1-29A58345A288
    rep_uuid String @guid
    rep_type Number 0
    wk_uuid String 7AD64D7A-7D1D-AC51-5DF1-29A58345A288
    wk_node_name String @pick(["Smith", "Will", "Nary"])
    excl_path Array
    bk_path_policy String 0
    n_status String @pick(["UNKNOWN", "ONLINE"])
  count Number 10
  total Number 100
  message String
  code Number 0
ret Number 200

# 复制规则 - 获取集群组信息

# URL

//rep/backup/mscs_group

# Method

GET

# Request

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

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 10001002
  message String
  list Array 2
    address String 172.20.0.128
    name String XSZ_FILE_test
    object_id String b153ed13-e55d-4eb9-a88b-9dd6ffd7f6b2
Last Updated: 5/13/2020, 3:56:32 AM