i2UP接口文档

文件复制

November 23, 2021About 31 min

文件复制

SDK类名：/rep/RepBackup；

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

SDK方法名：listRepBackupCdpZfs

URL

/rep/backup/cdp_zfs

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
retNumber否200
msgString否
dataObject否
  codeNumber否0
  messageString否[0] 操作成功。
  listArray否["zpoolname1","zpoolname2","zpoolname3"]zfs 池名称列表

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

SDK方法名：repBackupVerifyDevice;

URL

/rep/backup/verify_device

Method

POST

Request

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

Response

名称类型必选初始值简介Mock规则
msgString否
retNumber否200
dataObject否
  codeNumber否0如果不是返回成功，就说明当前路径是挂载盘，挂载盘不支持CDP
  messageString否

复制规则 - 获取可配置CDP快照数

SDK方法名：getRepBackupCdpSnapNum;

URL

/rep/backup/cdp_snap_num

Method

GET

Request

名称类型必选初始值简介Mock规则
bk_uuidString灾备机uuid
cdp_zfs_poolStringZFS存储池

Response

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

复制规则 - 新建

SDK方法名：createRepBackup

URL

/rep/backup

Method

POST

Request

名称类型必选初始值简介Mock规则
rep_backupObject否规则表单对象
  rep_uuidStringB8166905-411E-B2CD-A742-77B1346D8E84前端生成的规则uuid，接口兼容处理，如果前端不传接口会自己处理
  rep_nameString否rep_backup复制规则名（必传）
  rep_typeNumber否00: default; 1: cluster; 2: block; 10: template;（必传）
  wk_uuidString否B8566905-411E-B2CD-A742-77B1346D8E84工作机id（必传）
  wk_pathArray否["E:\test\"]工作目录（必传）
  bk_uuidString否B8566905-411E-B2CD-A742-77B1346D8E84备机（目标节点）的uuid ，云版可不填（block也有）
  bk_pathArray否["E:\test2\"]备机（目标节点）路径，备份数据存放路径，云版可不填（block也有）
  excl_pathArray否源机排除目录
  auto_startNumber否1规则自动启动（block也有）
  compressNumber否0压缩：0不开启；1，低；2，中；3，高（block也有）
  encrypt_switchNumber否00不开启，1开启（block也有）
  encryptNumber传输加密类型：0-不加密 1-传输AES加密 2-SM4加密
  secret_keyString否加密key（block也有）
  band_widthString否带宽控制，格式：303:00-14:002m,202:00-15:0080m（block也有）
  mirr_sched_switchNumber否0高级设置 - 启用禁止镜像：1；关闭：0；（block也有）
  mirr_schedString否高级设置 - 禁止镜像策略；Eg: 303:00-14:00,202:00-15:00（block也有）
  mirr_open_typeNumber否0文件打开方式， 0 普通文件， 1 自动选择， 2 MFT
  mirr_sync_attrNumber否1文件安全属性， 0 不同步； 1同步
  mirr_sync_flagNumber否0错误处理方式， 0 遇到错误停止， 1 写日志
  mirr_file_checkNumber否0校验方式，0：md5；1：文件大小和时间校验，不同则严格校验；2: 文件时间校验，不同则覆盖目标文件；3：文件总是覆写；
  mirr_skipString否0镜像设置 - 跳过镜像；0：正常镜像；1：直接进入复制状态；2：仅同步目录；
  snapshot_switchNumber否1快照开关
  snapshot_policyNumber否0快照个数达到上限时策略
  snapshot_startNumber否1546913351开始时间，Eg: 1515568566
  snapshot_limitNumber否24快照数目
  snapshot_intervalNumber否1快照间隔
  file_type_filter_switchNumber否0包含0排除1
  file_type_filterString否文件类型过滤，比如：.doc,.docx
  bkup_one_timeNumber否1515568566定时任务，执行时间（备份策略） Eg: 1515568566
  bk_path_policyNumber否1源路径目标路径路径映射关系：0：一对一，1：多对一；
  disk_limitString否0该规则最大可用存储空间
  del_policyNumber否1删除策略，0：不开启；1：开启；
  thread_numString否0并行任务数
  oph_pathString否E:\test4\孤儿文件，移动到指定路径、归档，必填
  oph_policyNumber否2孤儿文件处理策略：0不处理，1删除，2移动到指定路径；6 归档；
  latency_thresholdNumber否延迟告警毫秒数，默认值0不告警
  cdp_switchNumber否10：不启用；1：开启
  cdp_process_timeString否05:07:28hh:mm:ss , 默认00:00:00
  cdp_pathString否E:\test3\CDP数据目录 : 如开启CDP则必填
  cdp_paramString否3,30,0CDP参数：是几个参数的合并
  cdp_data_inc_switchNumber否0按数据增量做快照开关
  cdp_baseline_formatNumber否0Baseline存储格式: 保持源目录结构 打包
  cdp_bl_bkup_switchNumber否0创建baseline副本 0否1是；
  cdp_bl_sched_switchNumber否1指定生成Baseline（全备份）的策略
  cdp_bl_schedString否2|105
  cdp_snap_onNumber否0使用快照做Baseline；0关1开；
  cdp_snap_countNumber否240CDP快照数量，0到9999之间的整数
  cdp_snap_intervalNumber否30CDP快照间隔,5,10,15,20,25,30,40,50,60，单位是分钟
  cdp_zfs_poolString否CDP zfs存储池，选择系统上已有的存储池，仅在cdp页面快照打开且备机是Linux系统时的时候显示.，如果获取的value值为空，则cdp不支持linux快照方式。
  cdp_data_incNumber否0数据增量的大小，单位为M
  cdp_data_inc_flagString否用来表示数据增量单位 M G T
  ct_name_typeNumber否0文件名替换，0表示不启用。1加前后缀，原来部分保持不变；2前后缀加小写，3前后缀加大写 4自定义
  ct_name_str1String否文件名转换：prefix string / regex string
  ct_name_str2String否文件名转换：suffix string / replace string
  ct_name_str3String否文件名转换：restore regex string
  ct_name_str4String否文件名转换：restore regex string
  cmp_switchNumber否0比较计划，0: 关; 1: 开;
  cmp_file_checkNumber否0比较计划，校验方式，0：md5；1：文件大小和时间；
  cmp_scheduleArray否比较计划，策略
    sched_everyNumber否每，0天，1周，2月；
    sched_timeArray否["@time('HH:mm')"]哪几点
    sched_dayArray否["@integer(1, 31)"]哪几天
  cmp_limitString比较计划，保留数
  mscs_autostartNumber否开关: 集群故障转移到另一节点时，自动启动复制规则
勾选是1
不勾选是0
  mir_detect_scriptString否高级设置 - 检测脚本路径
  mir_detect_src_scriptString高级设置 - 源端检测脚本
  mscs_groupObject否已选集群组
  filter_deleteNumber0过滤删除，1：开；0关
  data_ip_uuidStringB8166905-411E-B2CD-A742-77B1346D8E84数据地址uuid
  bk_file_cryptNumber0备端数据加密，1是，0否；默认为0
  bk_crypt_typeNumber1备端数据加密类型：
1：aes，
2：sm4
  bk_crypt_keyString''备端数据加密，密钥
  traversing_syncNumber遍历时传输： 1-开启 0-不开启
  compress_switchNumber传输压缩开关：0，1

Response

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

复制规则 - 获取单个

SDK方法名：describeRepBackup；以新建接口内容为准

URL

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

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
dataObject否
  codeNumber否0@mock=0
  messageString否
  rep_backupObject否, 规则表对象
    cdp_pathString否@mock=, CDP数据目录 : 如开启CDP则必填
    disk_limitString否0@mock=0, 该规则最大可用存储空间
    policy_operationNumber否, 达到上限所做的操作：0，循环；1，停止
    rep_uuidString否EFB53F11-7BA2-2001-3418-85865EA58E47@mock=EFB53F11-7BA2-2001-3418-85865EA58E47, 复制规则uuid
    policy_intervalNumber否, 定时备份间隔
    mirr_schedString否303:00-14:00,202:00-15:00@mock=303:00-14:00,202:00-15:00, 镜像窗口时间控制
    policy_limitNumber否, 保留副本的个数
    encrypt_switchNumber否0@mock=0, 0不开启，1开启
    random_strString否0DD4E727-70AB-62C6-BEB5-D012DFAE46E3@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 用于防止并发修改的随机串
    auto_startNumber否1@mock=1, 规则自动启动
    del_policyNumber否1@mock=1, 删除策略
    cdp_bl_sched_switchNumber否0@mock=0, 指定生成Baseline（全备份）的策略
    rep_typeNumber否0@mock=0, 0: default; 1: cluster; 2: block; 10: template;
    cdp_bl_bkup_switchNumber否0@mock=0, 创建baseline副本 0 1
    cdp_paramString否@mock=, CDP参数：是几个参数的合并
    rep_nameString否rrrrr@mock=rrrrr, 复制规则名
    compressNumber否0@mock=0, 压缩：0不开启；1，低；2，中；3，高
    bk_portString否26831@mock=26831, 备机控制端口
    mirr_sync_flagNumber否0@mock=0, 错误处理方式
    cdp_baseline_formatNumber否0@mock=, Baseline存储格式: 保持源目录结构 打包
    file_type_filterString否@mock=, 文件类型过滤，比如：.doc,.docx
    snapshot_policyNumber否1@mock=0, 快照个数达到上限时策略
    bk_ipString否0.0.0.0@mock=0.0.0.0, 备机控制地址
    snapshot_switchNumber否0@mock=0, 快照开关
    wk_portString否26821@mock=26821, 控制机控制端口
    band_widthString否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_uuidString否0DD4E727-70AB-62C6-BEB5-D012DFAE46E3@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 组id
    file_checkNumber否, ???
    cdp_process_timeString否@mock=, hh:mm:ss , 默认00:00:00
    oph_pathString否@mock=, 孤儿文件，移动到指定路径
    create_timeString否, 创建时间 unix时间戳
    user_uuidString否0DD4E727-70AB-62C6-BEB5-D012DFAE46E3@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 用户id
    excl_pathArray否@mock=, 源机排除目录
    secret_keyString否@mock=, 加密key
    scheduleString否@mock=, 定期启动策略
    bk_uuidString否C0744ABF-5571-8288-1930-439612B6234A@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机（目标节点）的uuid ，云版可不填
    bk_path_policyNumber否1@mock=0, 源路径目标路径路径映射关系：0：一对一，1：多对一；
    snapshot_startNumber否1515568566@mock=1515568566, 开始时间
    cdp_switchNumber否1@mock=, 0：不启用；1：开启
    snapshot_intervalNumber否1@mock=0, 快照间隔
    wk_ipString否0.0.0.0@mock=0.0.0.0, 工作机控制地址
    oph_policyNumber否0@mock=0, 孤儿文件处理策略：0不处理，1删除，2移动到指定路径；6 归档；
    mirr_sync_attrNumber否1@mock=1, 文件安全属性
    wk_uuidString否C0744ABF-5571-8288-1930-439612B6234A@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机id
    policy_startNumber否, 开始时间，参数只针对普通备份有效，整机备份暂不支持指定开始时间；格式：Unix 时间戳
    file_type_filter_switchNumber否0@mock=0, 包含0排除1
    bkup_one_timeNumber否1515568566@mock=1515568566, 定时任务，执行时间（备份策略）
    mirr_sched_switchNumber否0@mock=0, 镜像窗口时间控制 开关
    cdp_bl_schedString否2|001
    mirr_open_typeNumber否0@mock=0, 文件打开方式
    snapshot_limitNumber否23@mock=24, 快照数目
    wk_pathArray否['D:\DataTest\']@mock=D:\DataTest\, hidden 路径映射？
    mirr_file_checkNumber否0@mock=0, 校验方式
    mirr_skipString否0@mock=0, 正常镜像
    bk_pathArray否['D:\DataTest2\']@mock=D:\DataTest2\, 备机（目标节点）路径，备份数据存放路径，云版可不填
    cdp_data_incNumber否
    cdp_data_inc_switchNumber否
    cdp_data_inc_flagString否
    latency_thresholdNumber否
    mscs_autostartNumber否开关: 集群故障转移到另一节点时，自动启动复制规则
勾选是1
不勾选是0
    mir_detect_scriptString否高级设置 - 检测脚本路径
    filter_deleteNumber0过滤删除，1：开；0关
    cmp_limitString比较计划，保留数
    data_ip_uuidStringA7EC7CF9-FCA2-D467-ECD6-E028AA9C8319数据地址
retNumber否200@mock=200
msgString否@mock=

复制规则 - 修改

SDK方法名：modifyRepBackup；以新建接口内容为准

URL

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

Method

PUT

Request

名称类型必选初始值简介Mock规则
rep_backupObject否, 规则表单对象
  cdp_paramString否@mock=, CDP参数：是几个参数的合并
  rep_typeNumber否0@mock=0, 0: default; 1: cluster; 2: block; 10: template;
  bkup_one_timeNumber否1515568566@mock=1515568566, 定时任务，执行时间（备份策略）
  snapshot_switchNumber否0@mock=0, 快照开关
  cdp_baseline_formatString否@mock=, Baseline存储格式: 保持源目录结构 打包
  mirr_sync_flagString否0@mock=0, 错误处理方式
  mirr_open_typeString否0@mock=0, 文件打开方式
  auto_startString否1@mock=1, 规则自动启动
  snapshot_policyString否0@mock=0, 快照个数达到上限时策略
  cdp_bl_sched_switchNumber否0@mock=0, 指定生成Baseline（全备份）的策略
  snapshot_intervalString否0@mock=0, 快照间隔
  bk_pathArray否D:\DataTest2\@mock=D:\DataTest2, 备机（目标节点）路径，备份数据存放路径，云版可不填
  snapshot_startNumber否1515568566@mock=1515568566, 开始时间
  random_strString否0DD4E727-70AB-62C6-BEB5-D012DFAE46E3@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 用于防止并发修改的随机串
  cdp_pathString否@mock=, CDP数据目录 : 如开启CDP则必填
  file_type_filter_switchNumber否0@mock=0, 包含0排除1
  cmp_scheduleObject否, 周期任务（备份策略）
    sched_timeArray否@time('HH:mm')@mock=@time('HH:mm'), 哪几点
    sched_dayArray否"@integer(1, 31)"@mock="@integer(1, 31)", 哪几天
    sched_everyNumber否2@mock=2, 0：每天；1：每周：2：每月；3：每隔；
  snapshot_limitString否24@mock=24, 快照数目
  cmp_switchNumber否0@mock=0, 比较计划，0: off; 1: on;
  oph_pathString否@mock=, 孤儿文件，移动到指定路径
  secret_keyString否@mock=, 加密key
  excl_pathArray否@mock=, 源机排除目录
  scheduleString否@mock=, 定期启动策略
  policy_intervalNumber否, 定时备份间隔
  cdp_switchString否@mock=, 0：不启用；1：开启
  wk_uuidString否0DD4E727-70AB-62C6-BEB5-D012DFAE46E3@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机id
  policy_operationNumber否, 达到上限所做的操作：0，循环；1，停止
  wk_pathArray否D:\DataTest\@mock=D:\DataTest, hidden 路径映射？
  mirr_skipString否0@mock=0, 正常镜像
  policy_limitNumber否, 保留副本的个数
  cdp_bl_schedString否@mock=, Baseline（全备份）策略 "2|00
  del_policyString否1@mock=1, 删除策略
  mirr_schedString否303:00-14:00,202:00-15:00@mock=303:00-14:00,202:00-15:00, 镜像窗口时间控制
  encrypt_switchString否0@mock=0, 0不开启，1开启
  band_widthString否303:00-14:002m,202:00-15:0080m@mock=303:00-14:002m,202:00-15:0080m, 带宽控制
  compressString否0@mock=0, 压缩：0不开启；1，低；2，中；3，高
  mirr_sync_attrString否1@mock=1, 文件安全属性
  policy_startNumber否, 开始时间，参数只针对普通备份有效，整机备份暂不支持指定开始时间；格式：Unix 时间戳
  cdp_process_timeString否@mock=, hh:mm:ss , 默认00:00:00
  bk_path_policyString否0@mock=0, 源路径目标路径路径映射关系：0：一对一，1：多对一；
  cdp_bl_bkup_switchNumber否0@mock=0, 创建baseline副本 0 1
  file_type_filterString否@mock=, 文件类型过滤，比如：.doc,.docx
  disk_limitString否0@mock=0, 该规则最大可用存储空间
  oph_policyString否0@mock=0, 孤儿文件处理策略：0不处理，1删除，2移动到指定路径；6 归档；
  mirr_file_checkString否0@mock=0, 校验方式
  cmp_file_checkNumber否0@mock=0, 校验方式：0: 严格校验; 1: 时间;
  mirr_sched_switchNumber否0@mock=0, 镜像窗口时间控制 开关
  thread_numString否0并行任务数
  cdp_data_incNumber否数据增量大小
  cdp_data_inc_switchNumber否按数据增量做快照开关
  cdp_data_inc_flagString否M G T
  mscs_autostartNumber否开关: 集群故障转移到另一节点时，自动启动复制规则
勾选是1
不勾选是0
  mir_detect_scriptString否高级设置 - 检测脚本路径
  filter_deleteNumber0过滤删除，1：开；0关
  batch_adv_switchNumber批量修改高级设置开关， 1：开 0：关
  batch_encrypt_switchNumber批量修改压缩加密开关， 1：开 0：关
  batch_mirr_switchString批量修改镜像设置开关， 1：开 0：关
  batch_cdp_switchString批量修改CDP设置开关， 1：开 0：关
  batch_cmp_switchString批量修改比较计划设置开关， 1：开 0：关
  batch_switchNumber批量修改：1， 普通修改：0
  cmp_limitString比较计划，保留数
  data_ip_uuidStringB8166905-411E-B2CD-A742-77B1346D8E84
数据地址uuid
  compress_switchNumber传输压缩开关：0，1

Response

名称类型必选初始值简介Mock规则
dataObject否
  codeNumber否0@mock=0
  messageString否
  uuidString否0DD4E727-70AB-62C6-BEB5-D012DFAE46E3@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 复制规则uuid, 批量修改所用
retNumber否200@mock=200
msgString否@mock=

复制规则 - 删除

SDK方法名：deleteRepBackup；

URL

/rep/backup

Method

DELETE

Request

名称类型必选初始值简介Mock规则
rep_uuidsArray否["11111111-1111-1111-1111-111111111111"]*规则数组
forceNumber1 - 强制删除
0 - 非强制删除
del_policyNumber0是否删除备份数据，0，1；
非必填，默认0

Response

名称类型必选初始值简介Mock规则
msgString
dataObject
  codeNumber11110001
  messageString
  fail_listArray
    codeNumber11110001
    messageString[-1] 离线
    rep_uuidStringBC92C981-D637-AC10-7CB0-450504DF8A3C
    rep_nameStringtest1
  success_listArray
    codeNumber11110001
    messageString[0] success
    rep_uuidStringBA92C981-D637-AC10-7CB0-450504DF8A3C
    rep_nameStringtest2
retNumber200

复制规则 - 操作

SDK方法名：{operate}RepBackup

URL

/rep/backup/operate

Method

POST

Request

名称类型必选初始值简介Mock规则
operateString否startstart：启动；stop：停止
rep_uuidsArray否规则数组

Response

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

复制规则 - 状态

SDK方法名：listRepBackupStatus；

URL

/rep/backup/status

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
msgString否
retNumber否200
dataObject否
  codeNumber否0
  messageString否
  statusArray否状态列表2
    rep_uuidString否0DD4E727-70AB-62C6-BEB5-D012DFAE46E3规则uuid
    statusNumber否STOP规则状态：
STOP：停止；
M_STOP：手动停止；
REPLICATION：复制；
MIRROR：镜像；
EXCEPTION：异常；
STALE：失效；
SWITCH：切换；
WAITING：等待；
EXECUTING：执行中；
IDLE：就绪；
DEAD：异常；
EXCPT：异常；
    latencyNumber否10复制延迟，单位ms
    latency_thresholdNumber10复制规则延时超限告警阈值， ms
    file_totalString1遍历文件总数
    file_currentString当前遍历数
    progressString60执行进度
    blistString遍历未完成：
0：否；
1：是；

复制规则 - 列表

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

URL

/rep/backup

Method

GET

Request

名称类型必选初始值简介Mock规则
search_valueString否''可选，搜索字段对应值（可以模糊）
limitNumber否15可选，不传就是全部
typeNumber否0: default; 1: cluster; 10: template;
pageNumber否1可选，不传就是全部
search_fieldString否可选，搜索字段

Response

名称类型必选初始值简介Mock规则
msgString否
dataObject否
  info_listArray否2
    bk_pathArray否/目标节点路径
    band_widthString否303:00-14:002m,202:00-15:0080m带宽控制，格式：
303:00-14:002m,202:00-15:0080m（block也有）
    bk_node_nameString否@pick(["kevin", "Jane", "Grey"])目标节点名@mock=@pick(["kevin", "Jane", "Grey"])
    wk_pathArray否/源路径
    rep_nameString否testbak规则名@mock=testbak,
    usernameString否@pick(["admin", "user", "super"])用户名@mock=@pick(["admin", "user", "super"]),
    random_strString否@pick(["111", "222"])用于防止并发修改的随机串@mock=@pick(["111", "222"])
    bk_uuidString否7AD64D7A-7D1D-AC51-5DF1-29A58345A288目标节点UUID@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288,
    rep_uuidString否@pick(["EFB53F11-7BA2-2001-3418-85865EA58E47", "0DD4E727-70AB-62C6-BEB5-D012DFAE46E3"])规则UUID@mock=@pick(["EFB53F11-7BA2-2001-3418-85865EA58E47", "0DD4E727-70AB-62C6-BEB5-D012DFAE46E3"]),
    rep_typeNumber否00: default 普通;
1: cluster 集群;
2: block ASM ;
10: template 模板;
@mock=0,
    wk_uuidString否7AD64D7A-7D1D-AC51-5DF1-29A58345A288源节点UUID@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288,
    wk_node_nameString否@pick(["Smith", "Will", "Nary"])源节点名@mock=@pick(["Smith", "Will", "Nary"]),
    excl_pathArray否/etc, 排除路径
    bk_path_policyString否0源路径目标路径路径映射关系：
0：绝对路径（源路径目标路径多对一）
1：相对路径（源路径目标路径一对一）；
    is_from_haNumber否@pick([0, 1])是否属于HA关联规则；1 属于， 默认 0
    mscs_groupObject否集群信息
      nameString否dGVzdA==名称
      addressString否172.20.68.13地址
      object_idString否dfadsfakjldfjdkfdfjdsfjid
    can_upNumber否1允许更新
    cmp_switchNumber1比较开关，0：关；1：开
    can_opNumber1允许操作
    can_delNumber1允许删除
    proxy_addrString172.20.1.2代理节点地址
    proxy_portString8080代理节点端口
    proxy_uuidString749BA2ED-E9A1-D16F-AAC3-07FE8E0AF5C8代理节点uuid
  totalNumber否100规则总数@mock=100,
  messageString否
  codeNumber否0@mock=0
retNumber否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_methodNumber否0恢复方式： 0：按规则来恢复 1：按数据目录来恢复
rep_uuidString否规则uuid，rc_method为1时，可不传
bk_uuidString否灾备机uuid，rc_method为0时，可不传
data_pathString否恢复数据路径；rc_method为0时，可不传
pageNumber否1可选，page
limitNumber否10可选，limit，这俩必须一起传，单传一个没用

Response

名称类型必选初始值简介Mock规则
dataObject否
  listArray否3
    bs_timeString否2018-10-23_13-28-35baseline时间
    next_bs_timeString否2018-10-23_13-23-08上一个baseline时间
    wk_pathArray否["E:\test\"]生成 baseline 当时的工作路径（现在路径可能已经改了）
    bk_pathArray否["E:\test\"]生成 baseline 当时的灾备路径（现在路径可能已经改了）
    bk_path_policyNumber否源路径目标路径路径映射关系：
0：一对一
1：多对一；
    wk_os_typeNumber否00: linux, 1: windows
    bk_os_typeNumber否10: linux, 1: windows
    snapshotNumber10：未使用快照方式 1：使用快照方式
  codeNumber否0@mock=0
  messageString否[0] 操作成功@mock=[0] 操作成功
  totalNumber否
msgString否@mock=
retNumber否200@mock=200

复制规则 - cdp baseline 列表 删除

SDK方法名：deleteRepBackupBaseline；

URL

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

Method

DELETE

Request

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

Response

名称类型必选初始值简介Mock规则
dataObject否
  success_listArray否3
    messageString否[0] 操作成功@mock=[0] 操作成功
    codeNumber否0@mock=0
    cdp_timeString否2017-11-17 17:24:14@mock=2017-11-17 17:24:14, CDP时间点
  messageString否[0] 操作成功@mock=[0] 操作成功
  codeNumber否0@mock=0
  totalNumber否3@mock=3
  fail_listArray否3
    cdp_timeString否2017-11-17 17:24:14@mock=2017-11-17 17:24:14, CDP时间点
    messageString否[12345678] 操作失败, 原因 xxxxxx@mock=[12345678] 操作失败, 原因 xxxxxx
    codeNumber否12345678@mock=12345678
msgString否@mock=
retNumber否200@mock=200

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

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

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

URL

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

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
msgString否
dataObject否
  codeNumber否0
  messageString否[0] 操作成功操作成功
  orphan_listArray否
    nameString否@word目录或文件名
    timeString否@datetime()创建/修改时间
    is_dirBoolean否@boolean是否为目录
    sizeNumber否@integer(100)文件大小，返回的是"number"
  separatorString否/用来拼接的路径分隔符 , 正反斜杠
  rep_oph_pathString否/test/oph_path复制规则孤儿文件路径
retNumber否200

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

SDK方法名：deleteRepBackupOrphan；

URL

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

Method

DELETE

Request

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

Response

名称类型必选初始值简介Mock规则
dataObject否
  success_listArray否3
    messageString否[0] 操作成功@mock=[0] 操作成功
    orphanString否xxxxxx@mock=xxxxxx, 孤儿文件
    codeNumber否0@mock=0
  messageString否[0] 操作成功@mock=[0] 操作成功
  fail_listArray否3
    codeNumber否12345678@mock=12345678
    orphanString否xxxxxx@mock=xxxxxx, 孤儿文件
    messageString否[12345678] 操作失败, 原因 xxxxxx@mock=[12345678] 操作失败, 原因 xxxxxx
  codeNumber否0@mock=0
  totalNumber否3@mock=3
retNumber否200@mock=200
msgString否@mock=

复制规则 - 孤儿文件 下载

SDK方法名：downloadRepBackupOrphan；

URL

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

Method

GET

Request

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

Response

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

复制规则 - 快照 列表 获取

SDK方法名：listRepBackupSnapshot；

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

URL

/rep/backup/snapshot_list

Method

GET

Request

名称类型必选初始值简介Mock规则
rc_methodString否恢复方式：
0：按规则来恢复
1：按数据目录来恢复
rep_uuidString否规则uuid，rc_method为1时，可不传
bk_uuidString否灾备机uuid，rc_method为0时，可不传
data_pathString否恢复数据路径；rc_method为0时，可不传
pageNumber否1可选，page
limitNumber否10可选，limit，这俩必须一起传，单传一个没用

Response

名称类型必选初始值简介Mock规则
msgString否
retNumber否200
dataObject否
  codeNumber否0
  snapshot_listArray否
    snapshot_nameString否c5809dd2-e8be-4389-ac0d-0a657ff94da0_snap_2017-11-17_17-24-14快照名称
    snapshot_sizeString否1.34 GB大小
    snapshot_timeString否2017-11-17 17:24:14时间
    wk_pathArray否["E:\test\"]生成快照时的工作路径
    bk_pathArray否["E:\test\"]生成快照时的的灾备路径
    bk_path_policyNumber否源路径目标路径路径映射关系：
0：一对一
1：多对一；
    wk_os_typeNumber否00: linux, 1: windows
    bk_os_typeNumber否00: linux, 1: windows
  os_typeString否@pick(["1", "2"])系统: 0: linux, 1: windows
  messageString否[0] success
  totalNumber否

复制规则 - 快照 创建

SDK方法名：createRepBackupSnapshot；URL参数为 rep_uuid；

URL

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

Method

POST

Request

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

Response

名称类型必选初始值简介Mock规则
retNumber否200
msgString否
dataObject否
  codeNumber否0
  messageString否[0] 操作成功。

复制规则 - 快照 删除

SDK方法名：deleteRepBackupSnapshot；URL参数为 rep_uuid；

URL

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

Method

DELETE

Request

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

Response

名称类型必选初始值简介Mock规则
retNumber否200
msgString否
dataObject否
  codeNumber否0
  messageString否[0] 操作成功。

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

SDK方法名：listRepBackupMscsGroup;

URL

/rep/backup/mscs_group

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
retNumber否200
msgString否
dataObject否
  codeNumber否0
  messageString否
  listArray否2
    addressString否172.20.0.128
    nameString否XSZ_FILE_test
    object_idString否b153ed13-e55d-4eb9-a88b-9dd6ffd7f6b2

5 Dashboard - 获取规则列表

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

URL

//dashboard/rep

Method

GET

Request

名称类型必选初始值简介Mock规则
limitNumber否10可选，默认 30
pageNumber否1可选，默认 1
typeNumber否00: default; 1: cluster; 2: block; 10: template;

Response

名称类型必选初始值简介Mock规则
msgString否
dataObject否
  info_listArray否2
    bk_pathArray否
    band_widthString否303:00-14:002m,202:00-15:0080m
    bk_node_nameString否@pick(["kevin", "Jane", "Grey"])
    wk_pathArray否
    usernameString否@pick(["admin", "user", "super"])
    rep_nameString否testbak
    random_strString否@pick(["111", "222"])
    bk_uuidString否@uuid7AD64D7A-7D1D-AC51-5DF1-29A58345A288
    rep_uuidString否@uuid
    rep_typeNumber否0
    wk_uuidString否@uuid7AD64D7A-7D1D-AC51-5DF1-29A58345A288
    wk_node_nameString否@pick(["Smith", "Will", "Nary"])
    excl_pathArray否
    bk_path_policyString否0
    n_statusString否@pick(["UNKNOWN", "ONLINE"])
  countNumber否10
  totalNumber否100
  messageString否
  codeNumber否0
retNumber否200

复制规则 - 批量新建

SDK方法名：batchCreateRepBackup;

URL

/rep/backup/batch

Method

POST

Request

名称类型必选初始值简介Mock规则
base_info_listObject否复制规则公共信息部分-跟复制规则一致
  mirr_open_typeString否0文件打开方式
  mirr_sync_attrString否1文件安全属性
  mirr_sync_flagString否0错误处理方式
  mirr_file_checkString否0校验方式
  mirr_skipString否0镜像设置 - 跳过镜像；0：正常镜像；1：直接进入复制状态；2：仅同步目录；
  snapshot_switchNumber否1快照开关
  snapshot_policyString否0快照个数达到上限时策略
  snapshot_startNumber否1546913351开始时间，Eg: 1515568566
  snapshot_limitString否24快照数目
  snapshot_intervalString否1快照间隔
  file_type_filter_switchNumber否0包含0排除1
  file_type_filterString否文件类型过滤，比如：.doc,.docx
  bkup_one_timeNumber否1515568566定时任务，执行时间（备份策略） Eg: 1515568566
  bk_path_policyString否1源路径目标路径路径映射关系：0：一对一，1：多对一；
  disk_limitString否0该规则最大可用存储空间
  del_policyString否1删除策略，0：不开启；1：开启；
  thread_numString否0并行任务数
  oph_pathString否E: est4/孤儿文件，移动到指定路径、归档，必填
  oph_policyString否2孤儿文件处理策略：0不处理，1删除，2移动到指定路径；6 归档；
  latency_thresholdNumber否1延迟告警毫秒数，默认值0不告警
  cdp_switchString否10：不启用；1：开启
  cdp_process_timeString否05:07:28hh:mm:ss , 默认00:00:00
  cdp_pathString否E: est3/CDP数据目录 : 如开启CDP则必填
  cdp_paramString否3,30,0CDP参数：是几个参数的合并
  cdp_data_inc_switchNumber否0按数据增量做快照开关
  cdp_baseline_formatString否0Baseline存储格式: 保持源目录结构 打包
  cdp_bl_bkup_switchNumber否0创建baseline副本 0否1是；
  cdp_bl_sched_switchNumber否1指定生成Baseline（全备份）的策略
  cdp_bl_schedString否2|105
  cdp_snap_onNumber否0使用快照做Baseline；0关1开；
  cdp_snap_countNumber否240CDP快照数量，0到9999之间的整数
  cdp_snap_intervalNumber否30CDP快照间隔,5,10,15,20,25,30,40,50,60，单位是分钟
  cdp_zfs_poolString否CDP zfs存储池，选择系统上已有的存储池，仅在cdp页面快照打开且备机是Linux系统时的时候显示.，如果获取的value值为空，则cdp不支持linux快照方式。
  cdp_data_incNumber否0数据增量的大小，单位为M
  cdp_data_inc_flagString否用来表示数据增量单位 M G T
  ct_name_typeNumber否0文件名替换，0表示不启用。1加前后缀，原来部分保持不变；2前后缀加小写，3前后缀加大写 4自定义
  ct_name_str1String否文件名转换：prefix string / regex string
  ct_name_str2String否文件名转换：suffix string / replace string
  ct_name_str3String否文件名转换：restore regex string
  ct_name_str4String否文件名转换：restore regex string
  cmp_switchNumber否0比较计划，0: 关; 1: 开;
  cmp_file_checkNumber否0比较计划，校验方式，0：md5；1：文件大小和时间；
  cmp_scheduleArray否比较计划，策略
    sched_everyNumber否1每，0天，1周，2月；
    sched_timeArray否["@time('HH:mm')"]哪几点
    sched_dayArray否["@integer(1, 31)"]哪几天
  mscs_autostartNumber否1开关: 集群故障转移到另一节点时，自动启动复制规则 勾选是1 不勾选是0
  encrypt_switchString否00不开启，1开启（block也有）
  compress_switchNumber0传输压缩开关：0，1
  compressString否0压缩：0不开启；1，低；2，中；3，高（block也有）
  secret_keyString否加密key（block也有）
  rep_prefixString否bk_复制规则前缀
  batch_nameString批量任务：用于批量创建的规则名称
  rep_sufixString批量任务：复制规则后缀
  variable_typeNumbernode批量任务：
变量名，
0,节点名称；1，节点ip；2，虚机名称
  auto_startString否1规则自动启动（block也有）
  band_widthString否带宽控制，格式：303:00-14:002m,202:00-15:0080m（block也有）
  rep_typeNumber否00: default; 1: cluster; 2: block; 10: template;（必传）
  mirr_schedString否高级设置 - 禁止镜像策略；Eg: 303:00-14:00,202:00-15:00（block也有）
  mirr_sched_switchNumber否0高级设置 - 启用禁止镜像：1；关闭：0；（block也有）
  mir_detect_scriptString否高级设置 - 检测脚本路径
  mscs_groupObject否已选集群组
rep_backupArray否节点及路径信息
  wk_uuidString否工作机UUID
  bk_uuidString否灾备机UUID
  wk_pathArray否工作机路径
  bk_pathArray否灾备机路径
  excl_pathArray否工作机排除目录

Response

名称类型必选初始值简介Mock规则
retNumber否200
msgString否
dataObject否
  codeNumber否0
  messageString否

复制规则 - 检查目标路径

SDK方法名：checkBkPath;

URL

/rep/backup/check_bk_path

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString
Last update: 11/3/2023, 3:54:28 PM
Contributors: ganl