整机CDM

February 26, 2024About 54 min

整机CDM

SDK类名:/cdm/Cdm;

----- 整机复制 -----

URL

 /dash/cdm

Method

GET

Request

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

Response

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

整机复制 --- 新建

SDK方法名:createCdm;

URL

/cdm

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
fsp_backupObject
  secret_keyString
  band_widthString
  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_switchString0
  mirr_sync_attrString1
  bk_uuidStringF85DFEC0-149E-373D-0B9E-3DA9A5C43940
  wk_data_typeNumber1
  bk_pathArray["/fsp_bk/"]
  sync_itemString/
  bkup_policyNumber2
  start_typeNumber启动方式:
0:立即启动;
1:手动启动;
2:预约启动;
0
  mirr_file_checkString0
  compressString0
  monitor_typeNumber0
  failoverString0
  wk_pathArray["/"]
  fsp_nameStringtest
  wk_uuidString42614852-BB62-1EF7-FED0-D2354BF3149D
  fsp_wk_shut_flagString2
  bk_data_typeNumber1
  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"
  fsp_typeNumber3
  del_policyNumber1
  timeoutNumber1
  cbt_switchNumber1
  threshold_vaild_byteString
  advanced_policyObject
    bk_cdpNumber1
    execute_intervalNumber1
    cdp_keep_dataNumber是否保存cdp数据:
0:否;
1:是;
(原本为execute_interval当中的“不保存CDP数据”选项)
    cdp_detailNumber1
    cdp_dailyNumber1
    cdp_paramString
    cdp_switchNumber1
    cdp_snapshot_daysNumber1
    cdp_snapshot_execute_intervalNumber1
  vp_uuidString
  storage_uuidString
  data_ip_uuidString
  database_switchNumber是否开启数据库保护:
0:未开启;
1:开启
0
  database_typeString0:oracle;
1: mysql;(task6526暂时屏蔽)
2: mssql;
3: custom;
0
  oracle_dbagent_paramObject
    oracle_sidString
    sql_plus_pathString
    usernameString
    passwordString
    portNumber
    table_spaceArray
    timeoutNumber
  mysql_dbagent_paramObject
    mysql_pathString
    usernameString
    passwordString
    portNumber
    database_nameArray
    timeoutNumber
  sqlserver_dbagent_paramObject
    timeoutNumber
    enableNumber0,10
  custom_dbagent_paramObject
    pre_snapshot_scriptString开始数据库保护并且选择自定义保护时不可为空
    post_snapshot_scriptString同上不可为空
  autoString是否自动演练
  orch_vm_nameString演练虚机名称
  scripts_typeString自动验证方式 0:ping验证。1.端口验证。2脚本验证
  scriptsString自动验证脚本内容-base64

Response

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

整机复制 --- 获取单个

SDK方法名:describeCdm;

URL

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

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
dataObject
  codeNumber0
  messageString
  rep_backupObject
    cdp_pathString
    disk_limitString0
    policy_operationNumber1
    rep_uuidStringEFB53F11-7BA2-2001-3418-85865EA58E47
    policy_intervalNumber1
    mirr_schedString303:00-14:00,202:00-15:00
    policy_limitNumber1
    encrypt_switchNumber0
    random_strString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
    auto_startNumber1
    del_policyNumber1
    cdp_bl_sched_switchNumber0
    rep_typeNumber0
    cdp_bl_bkup_switchNumber0
    cdp_paramString
    rep_nameStringrrrrr
    compressNumber0
    bk_portString26831
    mirr_sync_flagNumber0
    cdp_baseline_formatNumber0
    file_type_filterString
    snapshot_policyNumber1
    bk_ipString0.0.0.0
    snapshot_switchNumber0
    wk_portString26821
    band_widthString303:00-14:002m,202:00-15:0080m
    group_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
    file_checkNumber1
    cdp_process_timeString
    oph_pathString
    create_timeString
    user_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
    excl_pathArray
    secret_keyString
    scheduleString
    bk_uuidStringC0744ABF-5571-8288-1930-439612B6234A
    bk_path_policyNumber1
    snapshot_startNumber1515568566
    cdp_switchNumber1
    snapshot_intervalNumber1
    wk_ipString0.0.0.0
    oph_policyNumber0
    mirr_sync_attrNumber1
    wk_uuidStringC0744ABF-5571-8288-1930-439612B6234A
    policy_startNumber1
    file_type_filter_switchNumber0
    bkup_one_timeNumber1515568566
    mirr_sched_switchNumber0
    cdp_bl_schedString2|00
    mirr_open_typeNumber0
    snapshot_limitNumber23
    wk_pathArray["D:\DataTest\"]
    mirr_file_checkNumber0
    mirr_skipString0
    bk_pathArray["D:\DataTest2\"]
    cdp_data_incNumber1
    cdp_data_inc_switchNumber1
    cdp_data_inc_flagString
    latency_thresholdNumber1
    mscs_autostartNumber1
    mir_detect_scriptString
    filter_deleteNumber0
    cmp_limitString
    data_ip_uuidStringA7EC7CF9-FCA2-D467-ECD6-E028AA9C8319
retNumber200
msgString

整机复制 --- 修改

SDK方法名:modifyCdm;

URL

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

Method

PUT

Request

名称类型必选简介Mock初始值Mock规则
fsp_backupObject
  secret_keyString
  band_widthString
  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_switchString0
  mirr_sync_attrString1
  bk_uuidStringF85DFEC0-149E-373D-0B9E-3DA9A5C43940
  wk_data_typeNumber1
  bk_pathArray["/fsp_bk/"]
  sync_itemString/
  bkup_policyNumber2
  mirr_file_checkString0
  compressString0
  monitor_typeNumber0
  failoverString0
  wk_pathArray["/"]
  fsp_nameStringtest
  wk_uuidString42614852-BB62-1EF7-FED0-D2354BF3149D
  fsp_wk_shut_flagString2
  bk_data_typeNumber1
  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"
  fsp_typeNumber3
  random_strString11111111-1111-1111-1111-111111111111
  del_policyNumber1
  timeoutNumber1
  cbt_switchNumber1
  threshold_vaild_byteString
  advanced_policyObject
    bk_cdpNumber1
    execute_intervalNumber1
    cdp_detailNumber1
    cdp_dailyNumber1
    cdp_paramString
    cdp_switchNumber1
    cdp_snapshot_daysNumber1
    cdp_snapshot_execute_intervalNumber1
  vp_uuidString
  storage_uuidString
  data_ip_uuidString
  oracle_dbagent_paramObject
    oracle_sidString
    sql_plus_pathString
    usernameString
    passwordString
    portNumber1
    table_spaceArray
    timeoutNumber1
  mysql_dbagent_paramObject
    mysql_pathString
    usernameString
    passwordString
    portNumber1
    database_nameArray
    timeoutNumber1
  sqlserver_dbagent_paramObject
    timeoutNumber1
    enableNumber0
  database_typeString0
  database_switchNumber0
  autoString
  orch_vm_nameString
  scripts_typeString
  scriptsString
  start_typeNumber0

Response

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

整机复制 - 删除

SDK方法名:deleteCdm;

URL

/cdm

Method

DELETE

Request

名称类型必选简介Mock初始值Mock规则
fsp_uuidsArray["11111111-1111-1111-1111-111111111111"]
del_policyNumber1
forceNumber1
recycleNumber0

Response

名称类型必选简介Mock初始值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

整机复制 --- 列表

SDK方法名:listCdm;

URL

/cdm

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
typeNumber任务类型:
8代表整机复制
3
limitNumber分页条数10
pageNumber页数1
where_argsArray多重复合搜索条件,整机复制规则迁移时所需条件
where_args[wk_uuid]=""
where_args[vp_uuid]=""
where_args[storage_uuid]=""
statusString可选,总览页面跳转时按照状态过滤时需要
WAIT MAINTAIN REPLICATION FINISH STOP UNKNOWN

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] success
  info_listArray
    band_widthString带宽配置2400:00-22:594m
    bk_path_policyString一对一;多对一0
    random_strString随机字符串0E807AD3-DD1E-9224-2B9B-E713CF258467
    wk_node_nameString工作机名称name
    bk_node_nameString灾备机名称name
    usernameString用户名admin
    bk_uuidString灾备机uuidF28184D8-869B-BF56-A77C-3CC835FAAC35
    fsp_nameString规则名称asdasddsasdasd
    fsp_typeString规则类型8
    fsp_uuidString规则uuidE28184D8-869B-BF56-A77C-3CC835FAAC34
    wk_uuidString工作机uuid0E807AD3-DD1E-9224-2B9B-E713CF258467
    bkup_scheduleArray
      backup_type_showString备份计划
全备
      policysString备份策略每天22:00自动执行
      backup_typeString备份类型0
      sched_everyString每隔多久0
      running_timeString运行时间22:00
      sched_timeArray计划:时间["22:00"]
      sched_dayArray计划:天
      limitString保留数量1
    can_opNumber允许操作1
    can_delNumber允许删除1
    can_upNumber允许更新1
    resource_settingsObject整机备份-资源配置相关设置
      vm_listArray虚机列表
        vm_nameString工作机名称vm_name
        new_vm_nameString目标机名称new_vm_name
        custom_configString自定义设置-1:打勾,0:不打勾0
        cpuStringcpu数量2
        core_per_sockString核心数2
        mem_mbString内存1024
        dynamic_memString是否开启动态内存0
        networksArray网卡信息
          source_network_nameString源机网卡名称source_network_name
          mac_addressStringmac地址08:00:20:0A:8C:6D
          keep_macString保留mac地址0
          network_idString网卡idnetwork_id
          network_nameString网卡名称network_name
        disk_listArray磁盘列表
          is_ignoredString磁盘名称0
          disk_nameString磁盘名称VMware Virtual disk 1.0
          disk_pathString磁盘路径/
          new_dsString存储NFS-172.20.67.90--250496693
          idString
      tgt_uuidString目标平台uuid0E807AD3-DD1E-9224-2B9B-E713CF258467
      new_dcString数据中心ha-datacenter
      new_hostString主机localhost.localdomain"
      new_dsString存储disk (1)
      new_dc_morStringha-datacenter
      network_nameString网卡名称vm4
      network_idString网卡id''
      bk_uuidString灾备机uuid0E807AD3-DD1E-9224-2B9B-E713CF258467
      bk_pathString备份路径/disk
    verify_settingsObject验证配置
      add_drillString是否开启验证0
      autoString是否自动验证0
      drill_plat_uuidString演练平台uuid0E807AD3-DD1E-9224-2B9B-E713CF258467
      vm_listArray虚机列表
        vm_nameString虚机名称vm_name
        orch_vm_nameString新虚机名称orch_vm_name
        scripts_typeString验证方式0
        scriptsString验证内容''
    wk_data_typeString源类型0
    bk_data_typeString目标端类型7
    bkup_policyString备份策略1
  totalNumber1

整机复制 --- 状态

SDK方法名:listCdmStatus;

URL

/cdm/status

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
fsp_uuidsArray必传,uuid数组,页面加载第一次获取状态一个一个获取,之后是批量获取;["11111111-1111-1111-1111-111111111111"]
force_refreshNumber点击操作栏刷新按钮必传,下发1,表示从rpc获取;其他情况不传

Response

名称类型必选简介Mock初始值Mock规则
msgString
retNumber200
dataObject
  messageString
  statusObject
    fsp_uuidString@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, uuid0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
    f_totalString@mock=0, ? 默认00
    progressString@mock=0, 进度0
    statusString@mock=STOP, 状态文字STOP
    db_statusString@mock=, ?默认空
    wk_statusString工作机状态,ONLINE,OFFLINEONLINE
    version_numberNumber备份数10
    validated_version_numberNumber有效备份数10
    latencyNumber复制延迟,ms单位10
    buf_totalNumber数据积压byte0
  codeNumber0
  countNumber0

整机复制 --- 根据工作机获取规则

SDK方法名:getByWk;

URL

/cdm/get_by_wk

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
wk_uuidString工作节点uuid
vp_uuidString(可选)平台uuid。新建挂接等规则时切换平台时赋值,确定整机复制平台。迁移规则后会出现一个工作机对应两个平台的情况。

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  cdmObject
    idString1
    auto_startString1
    band_widthString
    bkup_one_timeNumber0
    bkup_policyNumber2
    bkup_scheduleArray
    compressString0
    cmp_file_checkString0
    cmp_scheduleNull
    cmp_switchString0
    create_timeString1606974951
    encrypt_switchString0
    mirr_file_checkString0
    mirr_open_typeString0
    mirr_sync_attrString1
    mirr_sync_flagString0
    mirr_skipString0
    random_strStringA7CF6F34-E4C3-9AC7-A17C-0C16CEB6332A
    secret_keyString
    snapshot_intervalString24
    snapshot_limitString24
    snapshot_policyString0
    snapshot_startNull
    snapshot_switchString0
    bk_path_policyString1
    uuidStringEA3D09E2-DFD5-F8E5-4311-259BFD4A7287
    del_policyNumber0
    thread_numString1
    file_type_filterNull
    file_type_filter_switchString0
    cmp_sync_fileString1
    stateObject
      fsp_uuidStringEA3D09E2-DFD5-F8E5-4311-259BFD4A7287
      statusStringFINISH
      version_numberNull
      validated_version_numberNull
      latencyNumber0
    runtime_switchString0
    runtime_rangeNull
    filter_deleteString0
    cmp_limitNull
    wk_node_nameString172.20.67.251
    bk_node_nameString172.20.67.242-back
    wk_ipString172.20.67.251
    wk_portString26821
    bk_ipString172.20.67.242
    bk_portString26821
    usernameStringadmin
    user_uuidString1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
    backup_typeString0
    boot_timeNull
    excl_pathArray
    failoverString0
    fsp_nameString67.251-ffo
    fsp_typeNumber8
    fsp_uuidStringEA3D09E2-DFD5-F8E5-4311-259BFD4A7287
    fsp_wk_shut_flagString2
    wk_pathArray
      pathStringPhysicalDrive1\
      nameStringPhysicalDrive1
      iconStringfolder
      sizeNumber48315294720
      fileString
      attrNumber0
      leafString
      subNodesArray
        childrenString
        has_policyString
        nameStringE:
        sizeNumber48315236352
        leafString1
        is_dirString
        attrNumber0
      nodeUuidString9ED08024-6268-F977-BB80-EB6A7D055A33
      showSizeString45.00 GB
      disabledString
      has_policyString
      is_showString
    wk_data_typeNumber0
    heartbeatNull
    max_fail_timesNull
    monitor_ipsString
    monitor_typeNumber0
    move_typeNull
    net_mappingArray
    net_mapping_typeString0
    post_over_scriptNull
    pre_over_scriptNull
    recovery_data_pathNull
    restore_pointNull
    running_serviceArray["sshd"]
    snapshotString0
    wk_uuidString9ED08024-6268-F977-BB80-EB6A7D055A33
    statusStringFINISH
    sync_itemString
    bk_pathArray[""]
    bk_uuidString5781FFD6-75B5-0479-32F3-D0AE85427A83
    bk_data_typeNumber7
    timeoutNumber0
    excl_driverArray
    cbt_switchNumber0
    threshold_vaild_byteString128
    advanced_policyObject
      bk_cdpNumber0
      execute_intervalNumber5
      cdp_dailyNumber1
      cdp_paramString
      cdp_switchNumber0
      cdp_snapshot_execute_intervalNumber1
      cdp_snapshot_daysNumber1
    vp_uuidString1EA61ECF-BEB4-CA12-6E6D-7A3556D1A8E9
    storage_uuidString5F51D353-082F-65E6-DB89-0DC86459DECD
    group_uuidNull
    proxy_uuidNull
    by_typeNumber0
    bak_wk_uuidNull
    bak_wk_addressNull
    bak_wk_nameNull
    biz_grp_listArray
    biz_grp_nameArray
    is_biz_adminNumber1
    can_delNumber1
    can_opNumber1
    can_upNumber1

备份点列表

SDK方法名:getPointList;

URL

/cdm/point_full_info_list

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
bk_uuidString
pathString非CDM:bk_path/工作机ip_工作机port;
CDM:storage的path
typeString非CDM:空;
CDM:storage的type(localfs,nfs,gluesterfs)
suffixString非CDM:空; CDM:工作机ip_工作机port
pageNumber页码
limitNumber每页条数
rule_uuidString备份规则uuid;不传或传空则获取所有
search_keyString过滤条件:
DATA_USE:备份点占用说明
search_valueString按DATA_USER过滤时:
0:未占用;
1:占用;
2:默认值,表示所有
2
startNumber查询起始时间戳,非必填
endNumber查询结束时间戳,非必填
orderString查询顺序,默认正序:DESC,倒叙:ASC
restore_pointString【可选】点击备份点还原按钮跳转到恢复界面获取备份点列表时传

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
dataObject
  messageString[0] success
  codeNumber0
  listArray10
    restorepointString还原时间点2020/03/18 09:50:00
    typeNumber全量0,增量1
    snapshotNumber1是快照,0不是快照
    snapshot_timestampString快照时间戳。记录当前cbt对应的快照
    disksArray3
      pathString磁盘路径
      sizeString磁盘大小单位MB1024
      indexNumber磁盘顺序1
      isBootNumber是否启动盘,0:否;1,是1
      interfaceString0 为 ide,1 为 scsi, 2 为 virtual ide
      groupString
    os_versionString操作系统版本Microsoft Windows Server 2012Microsoft Windows Server 2012
    mem_sizeStringmemory大小 单位MB1024
    cpu_coresStringcpu 个数4
    bios_typeString可能的类型有 legacy 和 uefi 默认 legacy
    networkObject
      cardsArray3
        macString
        cidrArrayip/mask对+1
        gatewayArray
        dnsObject
          domainString@ip
          serversArray
        typeString网卡类型,0物理网卡,1虚拟网卡
        nameString网卡名
      dnsObject
        domainString@ip
        serversString@ip
    timezoneString时区
    repNumber默认值0,1表示实时数据,2表示可用数据0
    backup_data_sizeString备份数据大小,单位字节
    has_virtioString是否安装 viostor 驱动'false'
    has_virtio_scsiString是否安装 vioscsi 驱动'false'
    has_net_kvmString是否安装 netkvm 驱动'false'
    rule_uuidString备份规则uuid@guid
    cdm_rule_numNumber接管/演练 数量
    ffo_mount_numNumber挂接任务 数量
    auto_drill_numNumber自动演练数量@integer(0,4)
  totalNumber总数
msgString

获取网卡列表

SDK方法名:getNetworkList;

URL

/cdm/network_list

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
uuidString容灾平台uuid
typeString0:接管;
1:演练;
storage_idString存储id

Response

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

根据存储获取工作机列表

SDK方法名:getNodeList;

URL

/cdm/restore_node_list

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
bk_uuidString灾备机uuid
pathString存储的path
typeString存储的type

Response

名称类型必选简介Mock初始值Mock规则
msgString
dataObject
  codeNumber11110001
  messageString
  listArray
    nameString工作机名称 或者 地址 用于 显示在页面 让用户选择
    directoryString工作机备份数据目录, 例如 192.168.1.120_26821
retNumber200

获取资源列表

SDK方法名:getResourceList;

URL

/cdm/drp_list

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
limitNumber分页条数10
pageNumber页数1
search_fieldString按条件过滤字段名''
search_valueString按条件过滤值''

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] success
  info_listArray
    vp_uuidString容灾平台uuidC0744ABF-5571-8288-1930-439612B6234A
    vp_nameString容灾平台名称vp_name
    statusString容灾平台状态ONLINE
    cpu_totalStringCPU核数8
    cpu_usedStringCPU使用量6
    cpu_mhzStringCPU赫兹总量3.20
    cpu_usageStringCPU使用率0
    mem_totalString内存总数1024
    mem_usedString内存使用数量1024
    mem_usageString内存使用率0
    storage_totalString存储总数0
    storage_usedString已使用存储数0
    storage_usageString存储使用率0
    vm_totalString虚机总数0
    vm_runningString虚机运行数0
    network_totalString网卡总数0
    hostsArray
      nameString主机名
      cpu_totalStringcpu总数0
      cpu_mhzStringcpu赫兹3.20
      cpu_usageStringCPU使用率0
      mem_totalString总内存1024
      mem_usedString已使用内存0
      ipString主机ip127.0.0.1
      connection_stateStringVcenter中,主机的连接状态。''
      uuidString主机硬件识别码
    storagesArray
      storage_idStringstorage idstorage
      nameString存储名name
      totalString总数btye0
      usedString已使用byte0
      typeStringLocal, NFS, GlusterFSLocal
      pathStringeg, /a/b/c/d for Local AND 172.20.16.21:/mnt/a for NFS/GlusterFS/
      enabledNumber是否已授权,0否,1是0
    managed_hostsArray接管主机资源列表
      nameString名称managed_hosts_name
      cpu_totalStringcpu总数16
      cpu_mhzStringcpu赫兹3.20
      cpu_usageStringcpu使用率0
      mem_totalString内存总数1024
      mem_usedString内存使用数1024
      ipString地址127.0.0.1
      connection_stateStringVcenter中,主机的连接状态。''
    orch_hostsArray演练主机资源列表
      nameString名称orch_hosts_name
      cpu_totalStringcpu总数16
      cpu_mhzStringcpu赫兹3.20
      cpu_usageStringcpu使用率0
      mem_totalString内存总数1024
      mem_usedString内存使用数1024
      ipString地址127.0.0.1
      connection_stateStringVcenter中,主机的连接状态。''
  totalNumber1

获取主机存储资源

SDK方法名:getHostStorageList;

URL

/cdm/host_storage_list

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
vp_uuidString容灾平台uuid

Response

名称类型必选简介Mock初始值Mock规则
msgString
retNumber200
dataObject
  messageString
  codeNumber0
  hostsArray
    nameString
    ipString172.20.2.80
    uuidString主机硬件识别码
    storagesArray
      storage_idStringstorage id1
      nameString
      totalString
      usedString
      typeString
      pathString

按虚机恢复获取磁盘

SDK方法名:getVmInfo;

URL

/cdm/vm_info

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
vp_uuidString容灾平台uuid
bk_uuidString灾备机uuid
vm_refString虚机id

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  vm_disksArray
    idString
    nameString
    pathString
    sizeString
    isBootString

获取备份点列表(刷新虚机规则对应关系)

SDK方法名:listDrillRestorePoint;

URL

/cdm/auto_drill_restore_point_list

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
rule_uuidStringCDM整机复制规则

Response

名称类型必选简介Mock初始值Mock规则
codeString
msgString
listArray
  uuidString演练规则uuid
  restorepointString还原点名

环境检测 -- Oracle是否开启归档

SDK方法名:verifyOracleArchiveMode;

URL

/cdm/verify_oracle_archive_mode

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
wk_uuidString工作机uuid
bk_uuidString灾备机uuid
usernameString
passwordString
sqlplus_pathString
sidString
timeoutString
portString

Response

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

整机复制 - 数据库保护自定义脚本检测

SDK方法名: cdmScriptPathCheck;

URL

/cdm/script_path_check

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
wk_uuidString工作机uuid
file_dirString脚本路径(多个时用逗号链接)

Response

名称类型必选简介Mock初始值Mock规则
retString
msgString
dataObject
  codeString0
  messageString
  invalid_file_pathString校验不通过时,缺失的文件路径,用逗号连接

整机复制 - 获取节点设备列表

SDK方法名:listCdmDriverInfo;

URL

/cdm/device_info

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
dataObject
  messageString
  codeNumber0
  dev_listArray
    nameStringfnrlu
    sizeNumber7997189767647315
    attrString1-系统盘 0-数据盘1
    leafNumber0
    is_dirNumber1
    has_policyNumber
    childrenArray
      nameStringlvm1
      sizeNumber2059209815596581
  node_uuidString
retNumber200
msgString

------ 整机恢复 ------

SDK类名:/cdm/CdmRecovery;

URL

/dash/cdm_recovery

Method

GET

Request

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

Response

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

整机恢复 --- 新建

SDK方法名:createCdmRecovery;

URL

/cdm_recovery

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
fsp_recoveryObject
  fsp_nameString名称testRC
  by_typeString0:按工作机;1:按存储;2:按虚拟机
  bak_wk_uuidStringby_type为0时传:工作机uuid;
  bak_wk_addressStringby_type为1时传:工作机地址;
  bak_wk_nameStringby_type为1时传:工作机名称;
  vm_nameStringby_type为2时传,虚机名称;
  vm_refStringby_type为2时传,虚机id;
  vp_uuidString容灾平台uuid
  storage_uuidString存储uuid
  bk_uuidString灾备机uuidF85DFEC0-149E-373D-0B9E-3DA9A5C43940
  restore_pointString备份点20190111113656
  wk_uuidString还原目标机uuid42614852-BB62-1EF7-FED0-D2354BF3149D
  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/"]
  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/"]
  dst_pathString
  monitor_typeNumber0
  net_mappingArray
    bk_nicObject
      typeString0
      nameStringEthernet0
      ipString192.168.72.74/255.255.240.0
    wk_nicObject
      nameStringEthernet0
      typeString0
      ipString192.168.72.73/255.255.240.0
  mirr_sync_attrString1
  band_widthString
  net_mapping_typeString2
  mirr_open_typeString0
  mirr_file_checkString0
  service_uuidString
  excl_pathArray
  mirr_sync_flagString0
  fsp_wk_shut_flagString2
  sync_itemString/
  failoverString0
  fsp_typeString5
  random_strString11111111-1111-1111-1111-111111111111
  data_ip_uuidStringF85DFEC0-149E-373D-0B9E-3DA9A5C43940
  compress_switchNumber压缩开关:
0:关;
1:开;
  compressNumber压缩等级:
  encrypt_switchNumber加密开关:
0:关;
1:开;
  encryptString加密类型:
0:不加密,
1:AES,
2:SM4,
  secret_keyString加密key

Response

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

整机恢复 --- 操作

SDK方法名:operateCdmRecovery;

URL

/cdm_recovery/operate

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
fsp_uuidsArray
operateString开始:start;
停止:stop;
恢复:recovery;
重启:reboot;

Response

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

整机恢复 --- 列表

SDK方法名:listCdmRecovery;

URL

/cdm_recovery

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  countNumber10
  totalNumber100
  messageString
  info_listArray
    wk_node_nameString@mock=@pick(["Smith", "Will", "Nary"]), 源节点名@pick(["Smith", "Will", "Nary"])
    wk_pathString@mock=C:\123, 源路径C:\123\
    fsp_uuidString@mock=@pick(["0DD4E727-70AB-62C6-BEB5-D012DFAE46E3", "0DD4E727-70AB-62C6-BEB5-D012DFAE46E4"]), 规则UUID@pick(["0DD4E727-70AB-62C6-BEB5-D012DFAE46E3", "0DD4E727-70AB-62C6-BEB5-D012DFAE46E4"])
    usernameString@mock=@pick(["admin", "user", "super"]), 用户名@pick(["admin", "user", "super"])
    excl_pathString@mock=, 排除路径
    bk_uuidString@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 目标节点名7AD64D7A-7D1D-AC51-5DF1-29A58345A288
    bk_pathString@mock=C:\ascasldfjlksjf, 目标节点路径C:\ascasldfjlksjf\
    fsp_nameString@mock=testbak, 规则名testbak
    wk_uuidString@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 源节点uuid7AD64D7A-7D1D-AC51-5DF1-29A58345A288
    band_widthString@mock=@pick(["100", "150", "200"]), 带宽控制@pick(["100", "150", "200"])
    bk_node_nameString@mock=@pick(["kevin", "Jane", "Grey"]), 目标节点名@pick(["kevin", "Jane", "Grey"])
    fsp_typeString任务类型:
9代表整机恢复
9
    can_upNumber1
    can_opNumber1
    can_delNumber1
    stateObject状态 - 后台任务获取,统计专用
      fsp_uuidStringC829B94A-85F2-F8C8-16F6-B203EE2EFA5E
      latencyNumber0
      statusStringFINISH
      timeNumber1629096647
      validated_version_numberNull
      version_numberNull
      wk_statusStringONLINE

整机恢复 - 删除

URL

/cdm_recovery

Method

DELETE

Request

名称类型必选简介Mock初始值Mock规则
fsp_uuidsArray["11111111-1111-1111-1111-111111111111"]
forceNumber1

Response

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

整机恢复 --- 状态

SDK方法名:listCdmRecoveryStatus;

URL

/cdm_recovery/status

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
fsp_uuidsArray必传,uuid数组,页面加载第一次获取状态一个一个获取,之后是批量获取;["11111111-1111-1111-1111-111111111111"]
force_refreshNumber点击操作栏刷新按钮必传,下发1,表示从rpc获取;其他情况不传

Response

名称类型必选简介Mock初始值Mock规则
msgString
retNumber200
dataObject
  statusObject
    fsp_uuidString@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 规则uuid0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
    statusString@mock=STOP, 状态文字:

UNKNOWN:未知;
PREPARE:准备;
NEGO:协商;
CALC:计算中;
MIRROR:镜像;
FSP_RC_IDLE:还原就绪;
FSP_WAITING:还原中;
FFO_DONE:重启就绪;
FINISH:完成 ;
STOP:停止;
STOP
    progressString@mock=0, 进度0
    version_numberString无效值null
    validated_version_numberString无效值null
    latencyNumber无效值0
    wk_statusString还原目标机状态ONLINE
  countNumber@mock=0, ? 默认00
  messageString
  codeNumber@mock=2000

----- 接管/演练 -----

SDK类名:/cdm/CdmRule;

URL

/dash/cdm_rule

Method

GET

Request

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

Response

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

接管/演练 --- 列表

SDK方法名:takeOverDrillList;

URL

/cdm_rule

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
limitNumber分页条数10
pageNumber页数1
where_argsArray
  wk_uuidString工作机uuidBC92C981-D637-AC10-7CB0-450504DF8A3C
  bk_uuidString灾备机uuidBC92C981-D637-AC10-7CB0-450504DF8A3C

Response

名称类型必选简介Mock初始值Mock规则
dataObject
  countNumber10
  info_listArray
    rule_uuidString规则uuidBC92C981-D637-AC10-7CB0-450504DF8A3C
    vm_nameString虚机名称test
    rule_typeNumber规则类型:
0:接管;
1:演练;
0
    by_typeNumber创建方式:
0:工作机;
1:存储;
2:虚机;
0
    wk_uuidString工作机uuidC0744ABF-5571-8288-1930-439612B6234A
    wk_nameString工作机名称wkname
    bk_uuidString灾备机uuidC0744ABF-5571-8288-1930-439612B6234A
    bk_nameString灾备机名称bkname
    bk_versionString灾备机版本7.1.57.19111521
    vm_cpu_coreString虚机cpu核心数2
    vm_memString单位MB1024
    vm_disksArray
      pathString(*必填)磁盘路径/
      sizeString(*必填)磁盘大小单位MB2048
      terfaceString(*必填)0 为 ide,1 为 scsi, 2 为 virtual ide0
      isBootString(*必填)是否启动盘0
    vm_networkString网卡名Network Name
    vm_refString虚机ID100
    can_delNumber1
  totalNumber100
  codeNumber0
  messageString
msgString
retNumber200

接管/演练 --- 新建

SDK方法名:createTakeOverDrill;

URL

/cdm_rule

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
vm_nameString新虚机名称 限制不能使用以下字符 : '",;/<>:*?%|$[]
rule_typeNumber(*必填)类型 0 为接管 1 为演练
vp_uuidString(新)容灾平台vp_uuid
by_typeNumber0:按工作机;1:按存储
wk_uuidString工作机uuid,by_type为0时必传
wk_addressString工作机地址,by_type为1时必传
wk_nameString工作机名称,by_type为1时必传
bk_uuidString备机uuid
bk_pathString留空''
storage_uuidString存储的storage_uuid
bk_versionString(*必填)备份点
vm_cpu_coreString(*必填)新虚机cpu个数
vm_memString(*必填)新虚机memory大小 单位MB
network_switchNumber是否开启自定义网络配置:
0:否;
1:是;
0
vm_networkObject(*必填)网卡
  cardsArray
    macString
    cidrArrayip/mask对
    gatewayArray
    dnsObject
      domainString
      serversArray
    network_idString网卡id
    network_nameString网卡名称
  dnsObject
    domainString
    serversString
vm_disksArray
  pathString(*必填)磁盘路径
  sizeString(*必填)磁盘大小单位MB
  interfaceString(*必填)0 为 ide,1 为 scsi, 2 为 virtual ide
  isBootString(*必填)是否启动盘,0:否;1,是
bios_typeString可能的类型有 legacy 和 uefi 默认 legacy
os_versionString操作系统版本Microsoft Windows Server 2012
timezoneString时区
fsp_uuidString整机复制uuid,必传
has_virtioString是否安装 viostor 驱动'false'
has_virtio_scsiString是否安装 vioscsi 驱动'false'
has_net_kvmString是否安装 netkvm 驱动'false'
restore_infoObject所有备份点信息
start_switchNumber是否自动启动,0:关,1:开0

Response

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

接管/演练 --- 删除

SDK方法名:deleteTakeOverDrill;

URL

/cdm_rule

Method

DELETE

Request

名称类型必选简介Mock初始值Mock规则
rule_uuidsArray
forceNumber1 - 强制删除 0 - 非强制删除
del_policyNumber是否删除目标虚机,0,10

Response

名称类型必选简介Mock初始值Mock规则
msgString
dataObject
  codeNumber11110001
  messageString
  fail_listArray
    codeNumber11110001
    messageString节点离线
    rule_uuidStringBC92C981-D637-AC10-7CB0-450504DF8A3C
    vm_nameStringtest2
  success_listArray
    codeNumber11110001
    messageString删除成功
    rule_uuidStringAB92C981-D637-AC10-7CB0-450504DF8A3C
    vm_nameStringtest1
retNumber200

接管/演练 --- 获取单个

SDK方法名:describeTakeOverDrill;

URL

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

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  messageString
  cdm_ruleObject
    rule_uuidStringC0744ABF-5571-8288-1930-439612B6234A
    vm_nameStringtest
    rule_typeNumber0
    wk_uuidStringC0744ABF-5571-8288-1930-439612B6234A
    wk_ipString工作机ip172.20.2.201
    wk_portString工作机端口1828
    bk_uuidStringC0744ABF-5571-8288-1930-439612B6234A
    bk_pathString备份路径bk_path
    bk_versionStringbkVersion
    vm_cpu_coreString3
    vm_memString单位MB2
    vm_disksArray
      pathString(*必填)磁盘路径path
      sizeString(*必填)磁盘大小单位MB1020
      interfaceString(*必填)0 为 ide,1 为 scsi, 2 为 virtual ide1
      isBootString(*必填)是否启动盘1
    vm_networkStringnetwork
    vm_refString虚机ID334
    fsp_uuidStringC0744ABF-5571-8288-1930-439612B6234A
    data_ip_uuidStringA7EC7CF9-FCA2-D467-ECD6-E028AA9C8319
    vp_uuidStringC0744ABF-5571-8288-1930-439612B6234A
    storage_uuidStringC0744ABF-5571-8288-1930-439612B6234A
  codeNumber0

接管/演练 --- 获取虚机状态

SDK方法名:getVmStatus;

URL

/cdm_rule/vm_status

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
rule_uuidsArray规则uuid['0E807AD3-DD1E-9224-2B9B-E713CF258467', '1A807AD3-DD1E-9224-2B9B-E713CF258467']
force_refreshNumber点击操作栏刷新按钮必传,下发1,表示从rpc获取;其他情况不传

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  statusArray
    rule_uuidString规则uuidBC92C981-D637-AC10-7CB0-450504DF8A3C
    statusString状态可能是:

CREATING: 正在创建 (禁止其它操作)

RESTORING: 正在回切 (禁止其它操作)

IMAGE_LOCKED : 虚机关机,且虚机不能开,因为磁盘正在被操作 (禁止其它操作)

CREATE_FAILED: 创建失败 (只允许删除操作)

DOWN: 关机 (允许 删除 和开机 操作)

POWERING_DOWN:正在关机 (禁止其它操作)

POWERING_UP: 正在开机 (允许 关机 和 打开控制台 操作)

WAIT_FOR_LAUNCH:将要开机 (禁止其它操作)

UP: 虚机正在运行 (允许 关机 和 打开控制台 操作)

NON_EXIST: 虚机不存在 (只允许删除操作)

UNKNOWN : 未知 (禁止其它操作)
ONLINE

接管/演练 --- 操作

SDK方法名:operateTakeOverDrill;

URL

/cdm_rule/operate

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
rule_uuidsArray
operateStringstart/stop/open_console
typeString(*选填)打开控制台操作时可传 spice, vnc

Response

名称类型必选简介Mock初始值Mock规则
dataObject
  codeNumber0
  messageStringsuccess
  file_nameString文件名 open_console时返回
  file_contentString文件内容 open_console时返回
retNumber200
msgString

------ 挂接任务 ------

SDK类名:/cdm/FfoMount;

URL

/dash/ffo_mount

Method

GET

Request

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

Response

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

新建

SDK方法名:createFfoMount;

URL

/ffo_mount

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
mount_nameString挂接名称
by_typeString0:按工作机;1:按存储
wk_uuidString工作机uuid,by_type为0时必传
wk_addressString工作机地址,by_type为1时必传
wk_nameString工作机名称,by_type为1时必传
bk_uuidString灾备机uuid
vp_uuidString容灾平台uuid
storage_uuidString存储uuid
bk_versionString备份点
os_versionString操作系统版本
protocolString协议, iSCSI
aclString如果空,表示所有客户端都可以连
vm_disksArray
  pathString磁盘路径
  sizeString磁盘大小
  interfaceString0 为 ide,1 为 scsi, 2 为 virtual ide
  isBootString是否启动盘 0 不是 1 是
fsp_uuidString整机复制uuid,必传
specify_clientNumber指定客户端:
0:否;
1:是;
0
client_uuidString客户端uuid''

Response

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

修改

SDK方法名:modifyFfoMount;

URL

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

Method

PUT

Request

名称类型必选简介Mock初始值Mock规则
mount_nameString
wk_uuidString
bk_uuidString
vp_uuidString
storage_uuidString
bk_versionString
os_versionString
protocolString
aclString
vm_disksArray
  pathString
  sizeString
  interfaceString
  isBootString
random_strString
fsp_uuidString
specify_clientNumber
client_uuidString

Response

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

获取单个

SDK方法名:describeFfomount;

URL

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

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  messageString
  ffo_mountObject
    vp_uuidStringC0744ABF-5571-8288-1930-439612B6234A
    bk_versionStringbkVersion
    os_versionStringosVersion
    storage_uuidStringC0744ABF-5571-8288-1930-439612B6234A
    mount_nameStringmountTask
    wk_uuidStringC0744ABF-5571-8288-1930-439612B6234A
    bk_uuidStringC0744ABF-5571-8288-1930-439612B6234A
    vm_disksArray
      pathStringpath
      sizeString10240
      interfaceStringinterface
      isBootString1
    protocolStringiSCSI
    aclString
    fsp_uuidString
    data_ip_uuidStringA7EC7CF9-FCA2-D467-ECD6-E028AA9C8319
  codeNumber0

列表

SDK方法名:ffoMountList;

URL

/ffo_mount

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
limitNumber10
pageNumber1
search_fieldString搜索字段:
mount_name:挂接任务名称;
bk_version:备份点
mount_name
search_valueString搜索字段值mount_name

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  countNumber10
  info_listArray
    mount_uuidString挂接任务uuid@guid
    mount_nameString挂接任务名称
    wk_uuidString工作机uuid
    bk_uuidString灾备机uuid
    wk_node_nameString工作机名称
    bk_node_nameString灾备机名称
    bk_versionString备份点
  totalNumber100
  codeNumber0
  messageString

获取状态

SDK方法名:listFfoMountStatus;

URL

/ffo_mount/status

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
mount_uuidsArray
force_refreshNumber点击操作栏刷新按钮必传,下发1,表示从rpc获取;其他情况不传

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  statusArray
    mount_uuidString挂接任务uuid1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
    statusString已连接:CONNECTED;
未连接:UNCONNECTED;
未知:UNKNOWN;
正在创建:CREATING;
创建失败:CREATE_FAILED;
CONNECTED
    timeString当前时间1629169301
    nr_sessionString会话数量,已连接时需要显示在页面上0
    aclStringacl
    targetStringiscs 目标端名称

删除

SDK方法名:deleteFfoMount;

URL

/ffo_mount

Method

DELETE

Request

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

Response

名称类型必选简介Mock初始值Mock规则
msgString
retNumber200
dataObject
  messageString
  codeNumber0
  success_listArray
    codeString
    messageString
    mount_uuidString34A49235-12F5-4E21-205F-4D8FAACA4079
    mount_nameStringmount_name
  fail_listArray
    codeString
    messageString
    mount_uuidString34A49235-12F5-4E21-205F-4D8FAACA4079
    mount_nameStringmount_name

----- 规则远程复制 -----

SDK类名:/cdm/RemoteCoopy;

URL

/dash/cdm_remote_coopy

Method

GET

Request

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

Response

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

环境检测 -- 目标机器是否存在重复规则

SDK方法名:verifyDuplicateCdmCoopyRule;

同一个规则只能在同一个目标机器远程复制一次

URL

/cdm_remote_coopy/verify_duplicate_cdm_coopy_rule

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
fsp_uuidsArray远程复制规则uuid

Response

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

远程复制 - 新建

SDK方法名:createCdmRemoteCoopy;

URL

/cdm_remote_coopy

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
rule_uuidString
prefixString规则前缀名,与整机复制名组合成完整规则名
old_bk_uuidString原灾备机uuid
old_platform_uuidString原平台uuid
old_storage_uuidString原存储
rule_uuidsArray规则列表
proxy_uuidString代理
new_bk_uuidString目标灾备机uuid
new_platform_uuidString目标平台uuid
data_addrString目标数据地址
new_storage_uuidString目标存储uuid
start_typeString0:立即执行, 1:手动启动,2:预约执行
bkup_policyString备份策略,3 备份完成立即执行,0 定时,1 循环;
bkup_one_timeString定时任务,执行时间(备份策略)
bkup_scheduleObject周期任务(备份策略)
  sched_gap_minString间隔分钟数
60
  sched_timeString哪几点
[
"00:00:00"
]
  sched_dayString哪几天
[
"1"
]
  sched_time_endString运行时间范围 结束
23:59
  limitString数据保留期限(天)
5
  sched_time_startString运行时间范围 开始
00:00
  sched_everyString0:每天;1:每周:2:每月;3:每隔;
0
compress_switchString压缩开关
encrypt_switchString加密开关
band_widthString带宽控制

Response

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

远程复制 - 列表获取

SDK方法名:listCdmRemoteCoopy;

URL

/cdm_remote_coopy

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
limitString
pageString
search_valueString
search_argsString

Response

名称类型必选简介Mock初始值Mock规则
msgString
retNumber200
dataObject
  info_listArray2
    rule_uuidString@pick(['86FECFC4-c61C-f27a-CfA1-A51EA2c8B6fC', 'fb4e0dC7-39e5-9f7e-eD45-1623f56f4e44'])
    src_rule_nameString整机复制规则名@first
    rule_nameString远程复制规则名@first
    wk_nameString工作机名@last
    old_bk_nameString旧灾备机名@first
    new_bk_nameString新灾备机名@last
    old_storage_nameString旧存储名@first
    new_storage_nameString新存储名@last
    statusString等待WATTING、停止STOP、完成SUCCESS、镜像MIRROR@pick(['STOP', 'WAIT'])
    can_opNumber可以操作1
    can_delNumber可以删除1
    user_nameString规则所属者@first
    old_rule_infoArray提供前端页面获取备份点参数
      bk_uuidString旧规则灾备机uuid
      bk_pathString旧规则灾备机备份路径
      wk_ipString组成suffix
      wk_portString组成suffix
      rule_uuidString整机复制规则uuid
      storage_typeStringstorage的存储type
    new_rule_infoObject同上
      bk_uuidString
      bk_pathString
      wk_ipString
      wk_portString
      rule_uuidString
      storage_typeString
  codeNumber0
  totalNumber10
  messageString

远程复制 - 操作

SDK方法名:{operate}CdmRemoteCoopy;

URL

/cdm_remote_coopy/operate

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
rule_uuidsString
operateString启动:start;
停止:stop;
迁移:migrate;
立即执行:start_immediately;
modify_original_rule_nameString修改后的原规则名

Response

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

远程复制 - 状态

SDK方法名:listCdmRemoteCoopyStatus;

URL

/cdm_remote_coopy/status

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
rule_uuidsString
force_refreshNumber点击操作栏刷新按钮必传,下发1,表示从rpc获取;其他情况不传

Response

名称类型必选简介Mock初始值Mock规则
msgString
retNumber200
dataObject
  codeNumber0
  msgString
  statusArray
    rule_uuidString@pick(['86FECFC4-c61C-f27a-CfA1-A51EA2c8B6fC', 'fb4e0dC7-39e5-9f7e-eD45-1623f56f4e44'])
    statusString状态码@pick(['ONLINE', 'OFFLINE'])
    progressString进度百分比
    totalString总的传输字节数
    currentString当前传输字节数
    ftotalString已经扫描出来的文件个数
    fcurString已经镜像完的文件个数
    blistString是否边遍历边镜像且正在遍历
0,未扫描
1,正在扫描

远程复制 - 删除

SDK方法名:deleteCdmRemoteCoopy;

URL

/cdm_remote_coopy

Method

DELETE

Request

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

Response

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

远程复制规则单独获取

SDK方法名:describeCdmRemoteCoopy;

URL

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

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retString
cdm_remote_coopyObject
  rule_uuidString规则uuid
  user_uuidString
  wk_uuidString工作机uuid
  old_bk_uuidString原灾备机uuid
  new_bk_uuidString新灾备机uuid
  old_platform_uuidString原平台uuid
  new_platform_uuidString新平台uuid
  old_storage_uuidString原存储uuid
  new_storage_uuidString新存储uuid
  data_addrString数据地址
  bkup_policyNumber备份类型
  bkup_scheduleString备份计划 0:一次性,1:重复,2:立即备份
  compress_switchNumber压缩开关
  encrypt_switchNumber加密开关
  band_widthString带宽
  statusString状态
  old_move_uuidString旧整机复制uuid
  new_move_uuidString新整机复制uuid
  create_timeString创建时间

环境检测 -- 存储空间容量检查

SDK方法名:verifyCdmCapacity;

URL

/cdm_remote_coopy/verify_cdm_capacity

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
old_storage_uuidString原存储uuid
new_storage_uuidString目标存储uuid
old_vp_uuidString旧平台uuid
new_vp_uuidString新平台uuid

Response

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

CDM 检查原备存储是否有多余CDM许可

SDK方法名:listCdmRemoteCoopyLicense;

URL

/cdm_remote_coopy/verify_license

Method

POST

Request

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

Response

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

CDM 备份空间检查(弃用)

SDK方法名:verifyCdmRemoteCoopyDiskSpace

URL

/cdm_remote_coopy/verify_disk_space

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
old_rule_uuidsArray已选的整机复制uuid列表
bk_uuidString新灾备机uuid

Response

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

CDM 目标存储已存在目录检查

SDK方法名:verifyCdmDirExist;

URL

/cdm_remote_coopy/verify_dir_exist

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
vp_uuidString目标存储平台uuid
storage_uuidString目标存储uuid
wk_uuidsArray工作机uuid列表
bk_uuidString目标灾备机

Response

名称类型必选简介Mock初始值Mock规则
retString200
msgString
dataObject
  dir_listArray已存在路径字符串数组

接管/演练 --- 自动演练

/cdm/Drill

URL

/dash/cdm_drill

Method

POST

Request

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

Response

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

自动演练规则 - 新建

SDK类名:/cdm/Drill;

SDK方法名:createCdmDrill;

URL

/cdm_drill

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
vm_nameString测试5
vm_refStringvm-10811
limitNumber数据保留期限(天)3
sched_dayArray备份策略 - 周期任务 - 哪几天,num数组; 【每月】、【每周】专用参数;取值:每月:1-31;每周:0-6(周日-周六)[1, 2, 3]
sched_timeArray备份策略 - 周期任务 - 运行时间;str数组;取值格式HH:mm["00:00"]
sched_everyNumber备份策略 - 周期任务 - 策略类型;0:每天;1:每周:2:每月;0
bkup_typeNumber备份策略 - 周期任务 - 备份方式;0:全备,1:增量,2:差异0
rule_nameString规则名称(备份规则任务和复制规则任务的名称)
rule_typeNumber对应规则类型:备份:0;复制:1;整机备份:2 ;整机复制:30
vp_uuidString演练平台对应 虚拟平台的ID
autoNumber自动演练:自动:1,手动:0;0
vm_listArray
  vm_nameString虚机(工作机)名称
  new_vm_nameString新虚机名称
  scriptsString演练脚本
  bk_uuidString源规则 bk_uuid
  bk_pathString源规则 bk_path
  timeString选择的时间点,RPC不用
  original_rule_uuidString原始规则uuid
  scripts_typeNumber(*必填)脚本验证的方式,0表示验证ping方法验证,1表示tcp端口验证测试,2表示脚本验证方式。2表示脚本验证方式目前暂存以后实现。默认值为0
  os_typeNumber(新加)虚拟机操作系统: 0:linux; 1:windows
  os_ipString虚拟机ip
  wk_uuidString工作机uuid (整机备份类型,必传)
  src_uuidString源规则的源平台uuid,获取导入的虚机信息时需要用到
  data_ip_uuidString灾备机数据地址
  ver_sigString备份点id
backup_typeStringi
del_bkup_dataNumber0
automateNumber隐藏开关,默认传0,页面不显示0
auto_shutdownNumber1

Response

名称类型必选简介Mock初始值Mock规则
messageString, 错误信息提示
codeNumber@mock=00
fail_listArray
nameString可能存在名称,此模块没有
uuidString可能存在uuid,此模块有
vm_nameStringvp 模块专有
success_listArray内容类似 fail_list
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功
  rule_uuidString
  vm_nameString
  new_vm_nameString

自动演练规则 - 获取单个

查看规则,URL参数为 group_uuid

SDK方法名:describeCdmDrill

URL

/cdm_drill/:uuid([a-f0-9-]+)

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
messageString
codeNumber0
info_listArray
vp_backupObject
del_bkup_dataNumber1
quiet_snapNumber1
quick_backNumber1
vp_uuidString1663DD96-C9BE-B49E-6044-3AB3120F4B74
bk_pathStringC:\test\
bk_uuidStringC02B76DB-EBE8-E029-B645-072B2E1A7460
lan_freeNumber1
rule_nameStringtemp
bkup_policyNumber0
bkup_one_timeNumber1515568566
bkup_scheduleArray
limitNumber3
sched_dayArray[1,2,3]
sched_timeArray["00:00"]
sched_everyNumber0
bkup_typeNumber0
create_timeString1515568566
rule_uuidStringC02B76DB-EBE8-E029-B645-072B2E1A7460
random_strStringC02B76DB-EBE8-E029-B645-072B2E1A7460
usernameStringJoseph Johnson
user_uuidStringC02B76DB-EBE8-E029-B645-072B2E1A7460
totalNumber1
vp_nameString平台名称vp_name
bk_node_nameString备机名
group_uuidString@guid
vm_listArray
vm_nameString@name
vm_refString110
band_widthString-1
vp_typeNumber
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功
  vp_drill_ruleObject
    usernameStringadmin
    rule_nameString
    rule_typeNumber0
    vp_uuidString
    bk_uuidString
    bk_pathString
    datacenterString
    hostnameString
    datastoreString
    autoNumber0
    scriptsString
    vm_listArray
      vm_nameString
      new_vm_nameString
      vm_refString99
      macString
      cpuNumber1
      ver_sigString
      core_per_sockNumber1
      mem_mbNumber1024
      overwriteNumber0
    quick_backNumber1
    backup_typeStringi
    lan_freeNumber23
    del_bkup_swapNumber0
    automateNumber0
    auto_shutdownNumber1
    bkup_policyNumber0
    bkup_scheduleObject
      sched_time_startString0
      sched_dayNumber6
      sched_everyNumber0
      limitNumber0
      sched_gap_minNumber0
      sched_timeArray
    bk_node_nameString88.107
    biz_grp_listArray
    create_timeString1533871285
    group_uuidString
    data_ip_uuidString1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
    rule_uuidString
    user_uuidString1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
    del_bkup_dataNumber0
    vp_nameString88.107
    vp_typeNumber0
    random_strStringAB790B28-62D6-7236-612F-65D73C80036F

自动演练规则 - 获取组

查看规则,URL参数为 group_uuid

SDK方法名:describeCdmDrillGroup

URL

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

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
messageString
codeNumber0
vp_backupObject
del_bkup_dataNumber1
quiet_snapNumber1
quick_backNumber1
vp_uuidString1663DD96-C9BE-B49E-6044-3AB3120F4B74
bk_pathStringC:\test\
bk_uuidStringC02B76DB-EBE8-E029-B645-072B2E1A7460
lan_freeNumber1
rule_nameStringtemp
bkup_policyNumber0
bkup_one_timeNumber1515568566
bkup_scheduleArray
limitNumber3
sched_dayArray[1,2,3]
sched_timeArray["00:00"]
sched_everyNumber0
bkup_typeNumber0
create_timeString1515568566
rule_uuidStringC02B76DB-EBE8-E029-B645-072B2E1A7460
random_strStringC02B76DB-EBE8-E029-B645-072B2E1A7460
usernameStringJoseph Johnson
user_uuidStringC02B76DB-EBE8-E029-B645-072B2E1A7460
totalNumber1
vp_nameString平台名称vp_name
bk_node_nameString备机名
group_uuidString@guid
vm_listArray
vm_nameString@name
vm_refString110
band_widthString-1
vp_typeNumber
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功
  vp_drill_ruleObject
    rule_nameString
    rule_typeNumber0
    vp_uuidString
    bk_uuidString
    bk_pathString
    datacenterString
    hostnameString
    datastoreString
    autoNumber0
    scriptsString
    vm_listArray
      vm_nameString
      new_vm_nameString
      vm_refString99
      macString
      cpuNumber1
      ver_sigString
      core_per_sockNumber1
      mem_mbNumber1024
      overwriteNumber0
    quick_backNumber1
    backup_typeStringi
    lan_freeNumber23
    del_bkup_dataNumber0
    del_bkup_swapNumber0
    automateNumber0
    auto_shutdownNumber1
    bkup_policyNumber0
    bkup_scheduleObject
      sched_time_startString0
      limitNumber0
      sched_dayNumber6
      sched_everyNumber0
      sched_timeArray
      sched_gap_minNumber0
    rule_uuidString
    group_uuidString
    vp_nameString88.107
    vp_typeNumber0
    bk_node_nameString88.107
    user_uuidString1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
    usernameStringadmin
    create_timeString1533871285
    random_strStringAB790B28-62D6-7236-612F-65D73C80036F
    biz_grp_listArray
    data_ip_uuidString1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC

自动演练规则 - 删除

删除规则

SDK方法名:deleteCdmDrill

URL

/cdm_drill

Method

DELETE

Request

名称类型必选简介Mock初始值Mock规则
rule_uuidsArray["11111111-1111-1111-1111-111111111111"]
group_uuidsArray组操作,有这个就先用这个,没有就用规则uuid
delete_tgtvmNumber是否删除演练虚机,0,10

Response

名称类型必选简介Mock初始值Mock规则
codeNumber@mock=00
messageString, 错误信息提示
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功

自动演练规则 - 操作

SDK方法名:

停止:stopCdmDrill

开始:startCdmDrill

设置状态: setStatusCdmDrill

URL

/cdm_drill/operate

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
operateString"start", "stop", "set_status":启动、停止、设置状态(仅运行状态可以)
rule_uuidsArray规则uuid列表[C6335F62-2565-1957-4BB9-587F2FF46B00]
group_uuidsArray组操作,有这个就先用这个,没有就用规则uuid
statusString仅设置状态传:状态码,0成功,-1失败
msgString仅设置状态传:用户上传的信息

Response

名称类型必选简介Mock初始值Mock规则
messageString, 错误信息提示
codeNumber@mock=00
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功

自动演练规则 - 状态

获取规则的状态

SDK方法名:listCdmDrillStatus

URL

/cdm_drill/status

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
rule_uuidsArray["11111111-1111-1111-1111-111111111111"]
force_refreshNumber点击操作栏刷新按钮必传,下发1,表示从rpc获取;其他情况不传

Response

名称类型必选简介Mock初始值Mock规则
countString@mock=11
messageString, 错误信息提示
codeNumber@mock=00
statusStringstop,executing,idle,dead,finish,switch,unknown,@pick(["STOP","EXECUTING","IDLE","DEAD","FINISH","SWITCH","UNKNOWN","VP_START","VP_CHECK","VP_CFG","VP_CBT"])
progressNumber0-100
rule_uuidString@mock=@guid()@guid
msgString
dataObject
  countString1
  messageString
  codeNumber0
  statusArray2
    statusStringSUCCESS FAILEDVP_START
    progressNumber71
    rule_uuidStringAc2F4EFC-14FE-b2Ab-7988-7AD4f44979E3
retNumber200

自动演练规则 - 获取虚机状态

获取规则的状态

SDK方法名:queryGroupVmStatus

URL

/cdm_drill/vm_status

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
rule_uuidString规则uuid,此值为空时group_uuid必选
group_uuidString规则的组uuid,此值为空时rule_uuid必选

Response

名称类型必选简介Mock初始值Mock规则
retString
msgString
dataArray
  codeString
  messageString
  listArray
    rule_uuidString
    rule_nameString规则名称
    nameString规则创建的目标虚拟机名称
    vm_statusString状态可能是:

CREATING: 正在创建 (禁止其它操作)

RESTORING: 正在回切 (禁止其它操作)


IMAGE_LOCKED : 虚机关机,且虚机不能开,因为磁盘正在被操作 (禁止其它操作)

CREATE_FAILED: 创建失败 (只允许删除操作)

DOWN: 关机 (允许 删除 和开机 操作)

POWERING_DOWN:正在关机 (允许打开控制台, 禁止其它操作)

POWERING_UP: 正在开机 (允许 关机 和 打开控制台 操作)

WAIT_FOR_LAUNCH:将要开机 (禁止其它操作)

UP: 虚机正在运行 (允许 关机 和 打开控制台 操作)
NON_EXIST: 虚机不存在 (只允许删除操作)

UNKNOWN : 未知 (可以删除,删除时弹出2次确认对话框,禁止其它操作)
Last update: 8/1/2024, 2:00:50 PM
Contributors: ganl