备份中心

February 26, 2024About 71 min

备份中心

SDK类名:/resource/AppSystem;

------- 二级目录 -------

URL

/------- 二级目录 -------

Method

GET

Request

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

Response

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

获取列表

SDK类名:/resource/AppSystem;

SDK方法名:secDirList;

URL

/sec_dir

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  totalNumber1
  info_listArray
    idNumber主键id1
    dir_uuidString二级目录uuidB8566905-411E-B2CD-A742-77B1346D8E35
    dir_nameString二级目录名称备份中心
    childrenArray子目录
      idNumber主键id2
      dir_uuidStringB8566905-411E-B2CD-A742-77B1346D8E84
      dir_nameString二级目录
      childrenArray子目录,以此类推
    can_upNumber
    can_opNumber
    can_delNumber
  messageString

新建

SDK类名:/resource/AppSystem;

SDK方法名:createSecDir;

URL

/sec_dir

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
pidNumber父级目录id
dir_nameString二级目录名称

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功
  dir_uuidString二级目录uuid,成功返回67E33CDB-D75B-15B3-367D-50C764F5A26E
  pidString父级目录id,成功返回2

修改

SDK类名:/resource/AppSystem;

SDK方法名:modifySecDir;

URL

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

Method

PUT

Request

名称类型必选简介Mock初始值Mock规则
dir_nameString二级目录名称

Response

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

删除

SDK类名:/resource/AppSystem;

SDK方法名:deleteSecDir;

URL

/sec_dir

Method

DELETE

Request

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

Response

名称类型必选简介Mock初始值Mock规则
msgString
dataObject
  codeNumber0
  messageString
  fail_listArray
    codeNumber1
    messageString
    dir_uuidString
    dir_nameString
  success_listArray
    codeNumber1
    messageString
    dir_uuidString
    dir_nameString
retNumber200

------- 应用系统管理 -------

URL

/dash1

Method

GET

Request

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

Response

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

获取列表

SDK类名:/resource/AppSystem;

SDK方法名:appSystemList;

URL

/app_sys

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
limitNumber1
pageNumber1
search_fieldString
search_valueString

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  totalNumber1
  info_listArray
    sys_uuidString应用系统uuid
    sys_nameString应用系统名称
    dir_nameString二级目录名称
    total_memeberString成员数量
    current_levelString当前运行等级
    random_strString随机串
    can_delNumber当前用户是否有权限删除,0否1是0
    can_upNumber当前用户是否有权限修改,0否1是0
    can_opNumber当前用户是否有权限操作,0否1是0
  messageString

获取列表(附加成员列表)

SDK类名:/resource/AppSystem;

SDK方法名:appSystemMembersList;

URL

/app_sys/get_app_sys_members

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
rule_typeNumber规则类型,0,文件备份;1,虚机复制;2,整机备份
os_typeNumber操作系统类型,0,linux;1,windows
nameString过滤项,成员名称

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString
  info_listArray
    idString唯一id1
    labelString应用系统名称123
    sys_uuidString应用系统uuid
    childrenArray成员列表2
      idNumber唯一id"@integer(1, 31)"
      labelString成员名称"@integer(1, 31)"
      cpuStringcpu数量
      core_per_sockStringcpu核心数
      mem_mbString内存
      os_typeNumber操作系统类型,0,linux;1,windows1
      vp_uuidString获取虚机成员列表时返回,虚机对应的平台uuid
      vm_uuidString虚机的uuid
      vm_refString虚机成员返回,虚机的id
      ipString节点成员返回,节点的控制台地址172.20.2.80
      rep_pathArray节点成员返回,节点的复制路径

获取单个

SDK类名:/resource/AppSystem;

SDK方法名:describeAppSystem;

URL

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

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功
  app_sysObject
    dir_uuidString
    sys_nameString
    level_cfgArray
      dayArray[0,1,2,3,4,5,6]
      periodsArray
        levelNumber1
        start_timeString10:10
        end_timeString12:20
    node_uuidsArray节点成员uuid
    vm_uuidArray虚机成员uuid
    vp_vm_listObject虚拟平台虚机列表
      keyArraykey是虚拟平台名称2
        vm_uuidString虚机uuid
        vm_ipString虚机ip0.0.0.0
        vm_nameString虚机名称虚机名称

新建

SDK类名:/resource/AppSystem;

SDK方法名:createAppSystem;

URL

/app_sys

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
dir_uuidString二级目录uuid73412DAD-A7A6-4605-A9FF-081495C8800B
sys_nameString应用系统名称应用系统name
level_cfgArray运行等级,Array
  dayArray星期日(0)到星期六(6)[0,1,2,3,4,5,6]
  periodsArray
    levelNumber等级分类:
A:0,
B:1,
C:2
0
    start_timeString开始时间10:10
    end_timeString结束时间12:20
node_uuidsArray节点成员["EA52A961-9883-66FE-188B-D7266AD9594B", "09EEA553-C3B8-0D7A-4797-F7A7E2D4FAE1"]
vm_uuidsArray虚机成员[]

Response

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

修改

SDK类名:/resource/AppSystem;

SDK方法名:modifyAppSystem;

URL

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

Method

PUT

Request

名称类型必选简介Mock初始值Mock规则
dir_uuidString
sys_nameString
level_cfgArray
  dayArray[0,1,2,3,4,5,6]
  periodsArray
    levelNumber1
    start_timeString10:10
    end_timeString12:20
node_uuidsArray["EF4825D6-7FB3-7961-6271-5E5B2603414D"]
vm_uuidsArray["EF4825D6-7FB3-7961-6271-5E5B2603414D"]
random_strString上次修改生成的随机串

Response

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

删除

SDK类名:/resource/AppSystem;

SDK方法名:deleteAppSystem;

URL

/app_sys

Method

DELETE

Request

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

Response

名称类型必选简介Mock初始值Mock规则
msgString
dataObject
  codeNumber0
  messageString
  fail_listArray
    codeNumber1
    messageString
    sys_uuidString
    sys_nameString
  success_listArray
    codeNumber1
    messageString
    sys_uuidString
    sys_nameString
retNumber200

获取虚机成员列表

SDK类名:/resource/AppSystem;

SDK方法名:getVmList;

URL

/app_sys/vm_list

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
where_args[vp_uuid]String虚拟平台uuid
search_fieldStringvm_name
search_valueStringvm_name

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  totalNumber1
  info_listArray
    vp_uuidString
    vm_nameString虚机1
    vm_uuidStringB8566905-411E-B2CD-A742-77B1346D8E34
    ipString导入的虚机ip
  messageString

查看全部成员列表

SDK方法名:getMembersList;

URL

/app_sys/members_list

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
sys_uuidString应用系统uuid
pageNumber页数
limitNumber条数

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  app_sysObject应用系统信息
    idString1
    sys_uuidString应用系统uuidB8566905-411E-B2CD-A742-77B1346D8E34
    sys_nameString应用系统名称sys_name
  info_listArray
    uuidStringuuidB8566905-411E-B2CD-A742-77B1346D8E34
    nameString成员名称member_name
    typeString成员类型:
0:节点;
1:虚机
0
    ipString节点:管理地址;
虚机:导入ip
127.0.0.1
  totalNumber总条数100
  messageString

------- 恢复管理 -------

URL

/dash/recovery

Method

GET

Request

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

Response

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

获取接管列表

SDK类名:/recovery/Recovery;

SDK方法名:recoveryList;

URL

/recovery

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
pageNumber页数
limitNumber条数
typeNumber规则类型:
5:整机备份;
11:虚机备份;
77:应用容灾;
search_fieldString过滤字段:
sys_name:应用系统名称;
rule_name:规则名称;
wk_node_name:工作机名称;
search_valueString过滤值:
wk_status_filterString工作机状态过滤
ONLINE;在线;
OFFLINE:离线;
tgt_status_filterString目标虚机状态过滤:
ONLINE;在线;
OFFLINE:离线;
failback_status_filterNumber接管状态过滤:
未接管:0;
切换中:1;
已接管:2;

Response

名称类型必选简介Mock初始值Mock规则
dataObject
  info_listArray
    rule_uuidString规则uuid
    rule_nameString规则名称
    rule_typeString整机备份:5;虚机复制11
    sys_uuidString应用系统uuid
    sys_nameString应用系统名称
    wk_uuidString工作机节点uuid 或 虚机uuid
    wk_node_nameString工作机节点名称 或虚机名称
    wk_ipString工作机数据地址
    wk_config_addrString工作机管理地址
    wk_os_typeNumber工作机系统类型:
0:linux;
1:windows;
0
    tgt_nameString目标虚机名称
    can_failoverNumber允许接管0
    can_failbackNumber允许回切0
    in_failover_switchNumber整机备份,是否开启增量回切功能:
0:否;
1:是;
0
    in_failover_settingsObject整机增量回切设置
      virtual_cidrString接管虚机本机CIDR
      virtuai_gatewayString接管虚机本机网关
      virtual_ipString管理地址
      virtual_portNumber管理端口
      virtual_data_ipString数据地址
      oph_policyNumber孤儿文件处理:
0:不处理;
1:删除
0
      data_pathArray接管机的目录。
      rc_dirArray要恢复到工作机的目录
      excl_dirArray排除路径
    failover_uuidString(整机备份)增量回切uuid,用来获取回切日志
  totalNumber100
  messageString
  codeNumber0
retNumber200
msgString

获取接管规则状态(工作机、上次运行时间、回切)

SDK类名:/recovery/Recovery;

SDK方法名:recoveryStatus;

URL

/recovery/status

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  statusArray
    rule_uuidString规则uuid
    statusString工作机节点/虚机 状态
    last_success_timeString上次规则成功执行时间
    last_success_drill_timeString上次成功验证时间
    failover_statusString增量回切状态:
TMP_FAILOVER:临时接管中
FAILOVERING:回切中;
FAILOVER_SUCCESS:回切成功;
FAILOVER_FAILED:回切失败;
FAILOVER_NOT_START:未启动回切;
FAILOVER_STARTING:启动回切中;
    faliover_progressString增量回切百分比
    in_failover_switchNumber
整机备份,是否开启增量回切功能:
0:否;
1:是;
    in_failover_settingsObject上次增量回切的设置
      virtual_cidrString接管虚机本机CIDR
      virtuai_gatewayString接管虚机本机网关
      virtual_ipString管理地址
      virtual_portNumber管理端口
      virtual_data_ipString数据地址
      oph_policyNumber孤儿文件处理:
0:不处理;
1:删除
      data_pathArray接管机的目录。
      rc_dirArray要恢复到工作机的目录
      excl_dirArray排除路径
    tgt_vm_nameString目标虚机名称
    failback_statusNumber接管状态:
0:未接管;
1:切换中;
2:已接管;

目前只应用容灾规则显示

------- 批量任务 -------

URL

/dash/batch_task

Method

GET

Request

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

Response

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

任务列表

SDK类名:/taskCenter/BatchTask;

SDK方法名:batchTaskList;

URL

/batch_task

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
limitNumber每页条数
pageNumber页数
typeNumber任务类型:
0:文件复制
1:虚机复制
2:整机复制

不传默认所有类型
like_args[xxx]Stringlike_args[batch_name] = '.....'

Response

名称类型必选简介Mock初始值Mock规则
msgString
retNumber200
dataObject
  codeNumber0
  messageString[0] success
  info_listArray
    batch_uuidString批量任务uuid
    batch_nameString任务名称任务名称
    batch_typeNumber任务类型:
0:文件复制
1:虚机复制
2:整机复制
0
    member_countNumber成员数量2
    statusString状态FINISH
    progressNumber进度100
  totalNumber100

任务状态

SDK类名:/taskCenter/BatchTask;

SDK方法名:batchTaskStatus;

URL

/batch_task/status

Method

GET

Request

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

Response

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

任务操作

SDK类名:/taskCenter/BatchTask;

SDK方法名:{operate}BatchTask;

URL

/batch_task/operate

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
operateString操作名称: start,stop,delete
batch_uuidString批量任务uuid
delete_tgtvmNumber删除虚机复制规则时,判断是否删除目标虚拟机。
1:删除
0:不删除。
del_policyString删除整机备份规则时,*删除策略,0:不开启;1:开启;

Response

名称类型必选简介Mock初始值Mock规则
msgString
retNumber200
dataObject
  messageString
  codeNumber0
  fail_listArray
    codeString
    messageString
    batch_uuidString
  success_listArray批量创建虚机复制 时返回列表
    codeString
    messageString成功失败信息
    rule_nameString虚机复制名称
    rule_uuidString虚机复制uuid
    fsp_nameString整机备份名称
    fsp_uuidString整机备份uuid
    rep_nameString复制规则名称
    rep_uuidString复制名称uuid

------- 总览 -------

URL

/dash/resource_view

Method

GET

Request

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

Response

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

资源概览(旧)

SDK类名:/dashboard/Dashboard;

SDK方法名:resourceView;

URL

/dashboard/source

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] success
  info_listArray容灾平台资源列表(目前是只有一个容灾平台)
    vp_uuidString容灾平台uuid
    vp_nameString容灾平台name
    ipString容灾平台ip(页面显示此ip)
    statusString容灾平台状态
    vm_totalString虚机总数
    vm_runningString正在运行的虚机数量
    host_countString主机数
    storage_countString存储数
    network_totalString网卡数量
    cpu_totalStringcpu总核数
    cpu_usedStringcpu已使用mhz
    cpu_mhzStringCPU mhz总量
    cpu_usageStringcpu使用率
    mem_totalString内存总数
    mem_usedString内存占用数
    mem_usageString内存使用率
    storage_totalString存储总数
    storage_usedString存储使用数
    storage_usageString存储占用率
    protection_coverageObject资源保护覆盖率设置(总和为100)
      level_aNumber70
      level_bNumber30
      level_cNumber20
    cpu_protectionArraycpu保护覆盖率
      levelNumberA:0,B:1,C:20
      cpu_totalStringcpu总数(可用资源)
      cpu_usedString规则已使用cpu数
      cpu_coverageNumbercpu覆盖率70
    mem_protectionArray内存保护覆盖率
      levelStringA:0,B:1,C:2
      mem_totalString内存总量(可用资源)
      mem_usedString规则已使用内存数
      mem_coverageNumber内存覆盖率
    managed_hostsArray接管主机资源列表
      nameString
      cpu_totalString100
      cpu_usageString95
      mem_totalString
      mem_usedString
      ipString
      connection_stateNumberVcenter中,主机的连接状态。
    orch_hostsArray演练主机资源列表
      nameString
      cpu_totalString100
      cpu_usageString50
      mem_totalString
      mem_usedString
      ipString
      connection_stateStringVcenter中,主机的连接状态。
  totalNumber1

资源概览 - 获取资源池列表

SDK方法名:listBackupCenter;

URL

/dashboard/list_backup_center

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString
  exsi_listArrayexsi资源池列表5
    vp_uuidString平台uuid@guid
    vp_nameString平台名称@name
    ipString地址@ip
  vcenter_listArrayvcenter资源池列表5
    vp_uuidString平台uuid@guid
    vp_nameString平台名称@name
    ipString地址@ip

资源概览 - 获取资源使用率和保护覆盖率

SDK方法名:getBackupCenterInfo;

URL

/dashboard/backup_center_info

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
vp_uuidString资源池uuid

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString
  vp_uuidString资源池uuid@guid
  statusString平台状态
  vm_totalString虚机总数@integer(1, 20 )
  vm_runningString正在运行的虚机数量@integer(1, 10 )
  host_countString主机数量@integer(1, 20 )
  storage_countString存储数量@integer(1, 20 )
  network_totalString网卡总数@integer(1, 20 )
  cpu_mhzStringCPU mhz总量@integer(10000, 20000 )
  cpu_usedStringcpu已使用mhz@integer(1000, 10000 )
  cpu_usageStringcpu使用率@integer(10, 100 )
  cpu_totalStringcpu总核心数@integer(1,16 )
  mem_totalString内存总数@integer(64,128 )
  mem_usedString内存占用数@integer(1,64 )
  mem_usageString内存使用率@integer(10, 100 )
  storage_totalString存储总数@integer(60, 100 )
  storage_usedString存储使用数@integer(10, 60 )
  storage_usageString存储占用率@integer(10, 100 )
  cpu_protectionArraycpu保护覆盖率3
    levelString分类:
A:0,B:1,C:2
@integer(0, 2)
    cpu_totalStringcpu总数(可用资源)100
    cpu_usedString规则已使用cpu数@integer(10, 100 )
    cpu_coverageStringcpu覆盖率@integer(10, 100 )
  mem_protectionArray内存保护覆盖率3
    levelString分类:
A:0,B:1,C:2
@integer(0, 2)
    mem_totalString内存总量(可用资源)100
    mem_usedString规则已使用内存数@integer(10, 100 )
    mem_coverageString内存覆盖率@integer(10, 100 )
  protection_coverageObject资源保护覆盖率设置(总和为100)
    level_aString40
    level_bString35
    level_cString25

资源概览 - 获取接管、演练平台列表

SDK方法名:listHosts;

URL

/dashboard/list_hosts

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] success
  managed_hostsArray接管主机列表2
    ipString@ip
    nameString@name
    cpu_mhzString@integer(1000,10000)
    cpu_totalString100
    cpu_usedString@integer(10, 100)
    cpu_usageString@integer(10, 100 )
    mem_totalString100
    mem_usedString@integer(10, 100 )
    connection_stateString1
    mem_usageString@integer(10, 100)
  orch_hostsArray演练主机列表4
    ipString@ip
    nameString@name
    cpu_mhzString@integer(1000,10000)
    cpu_totalString100
    cpu_usedString@integer(10, 100)
    cpu_usageString@integer(10, 100 )
    mem_totalString100
    mem_usedString@integer(10, 100 )
    mem_usageString@integer(10, 100)
    connection_stateString

设置资源保护覆盖率

SDK类名:/dashboard/Dashboard;

SDK方法名:resourceProtectionCoverage;

URL

/dashboard/resource_protection_coverage

Method

PUT

Request

名称类型必选简介Mock初始值Mock规则
vp_uuidString资源池uuid
level_aNumber
level_bNumber
level_cNumber

Response

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

任务概览列表

SDK类名:/dashboard/Dashboard;

SDK方法名:taskView;

URL

/dashboard/task

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString
  info_listArray
    keyNumber前端要用到的索引
    dir_uuidString二级目录uuidB8566905-411E-B2CD-A742-77B1346D8E84
    dir_nameString二级目录名称二级目录
    level_aNumberA类数量1
    level_bNumberB类数量2
    level_cNumberC类数量3
    app_sys_listArray应用系统列表
      keyString前端要用到的索引
      idNumber3
      sys_uuidString应用系统uuidB8566905-411E-B2CD-A742-77B1346D8E84
      sys_nameString应用系统名称app_sys_name
      wk_total_numNumber工作机总数1
      wk_online_numNumber工作机在线总数0
      bk_total_numNumber灾备机总数2
      bk_online_numNumber灾备机在线总数2
      slave_numNumber从节点数量3
      take_over_numNumber接管数(处于“临时切换成功”状态的规则数量)2
      rule_numNumber规则数量10
      rule_listArray应用系统规则列表
        rule_uuidString规则uuid
        group_uuidString规则的group_uuid,可以为null
        rule_nameString规则名称rule_name
        wk_nameString工作机名称wk_name
        wk_uuidString工作机uuidB8566905-411E-B2CD-A742-77B1346D8E84
        wk_ipString工作机ip172.20.2.200
        wk_os_versionString工作机操作系统类型Windows Server 2012 R2
        wk_statusString工作机状态ONLINE
        bk_nameString灾备机/从节点 名称wk_name
        bk_uuidString灾备机/从节点 uuidB8566905-411E-B2CD-A742-77B1346D8E84
        bk_ipString灾备机/从节点 ip172.20.2.200
        bk_os_versionString灾备机/从节点 操作系统信息Windows Server 2012 R2
        bk_statusString灾备机/从节点 状态OFFLINE
        rule_typeString规则类型:ha,ffo,coopy,vp_repffo
        backup_numNumber备份数10
        backup_num_effectiveNumber有效备份数10
        statusString规则状态(高可用后端返回的是主节点上的规则状态)RUN
        master_uuidStringHA 规则,主节点uuid
        fake_ruleNumber是否为空规则(只显示应用系统成员):
1:是;0:否
0
        can_startNumber启动1
        can_stopNumber停止1
        can_recoveryNumber恢复(暂未用到)1
        can_failoverNumber接管1
        can_failbackNumber回切1
    childrenArray
    wk_total_numNumber工作机总数1
    wk_online_numNumber工作机在线数1
    rule_numString二级目录规则总数
  wk_numNumber生产节点数
  bk_numNumber灾备节点数

------- 其他 -------

URL

/dash/bc/other

Method

GET

Request

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

Response

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

统计报表

SDK类名:/common/GeneralInterface

SDK方法名:listStatisticsReport;

URL

/statistics/report

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
start_timeString2019-11
end_timeString2020-04

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  info_listArray
    timeString2020-04
    app_sysNumber系统接入(创建应用系统数)1
    nodeNumber服务器接入(创建节点数)1
    vp_repNumber虚机备份(虚机复制数)1
    ffoNumber整机备份数(ffo)1
    vp_drillNumber验证数(虚机演练数)1
    take_overNumber接管数1
  app_sys_totalNumber当前筛选条件下总的51
  node_totalNumber22
  vp_rep_totalNumber21
  ffo_totalNumber25
  vp_drill_totalNumber44
  take_over_totalNumber30

应急演练,获取华云平台登录虚机地址

SDK类名:/resource/VirtualizationSupport;

SDK方法名: archerVmConsole;

URL

/vp/platform/archer_vm_console

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
rule_uuidString演练规则uuid

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString
  console_urlString登录虚机地址

------ 整机副本 ------

URL

/------ 整机副本 ------

Method

GET

Request

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

Response

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

自动注册节点(底层调用)

SDK方法名:autoRegisterNode;

URL

/api/client/rest_rpc/node

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
uuidString整机副本规则uuid
vp_uuidString虚拟平台地址
vm_uuidString目标虚机uuid
node_nameString节点名称
os_typeNumber系统类型:
0:linux;
1:windows;
1
os_userString用户名
os_pwdString密码,AES加密(同rpc.node_os_auth)
cc_ipString控制台ip
config_addrString节点管理地址
config_portNumber节点管理端口
rootString节点安装目录(用来拼接各种目录路径)
disk_limitNumber磁盘使用上限
mem_limitNumber内存使用上限
disk_free_space_limitNumber磁盘剩余空间阈值
cache_pathString数据缓存目录(存在就用,不存在仍然用root拼接)
log_pathString日志目录(存在就用,不存在仍然用root拼接)

Response

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

整机副本 - 新建

SDK类名:/fullMachineCopy/FullMachineCopy;

SDK方法名:createFullMachineCopy;

URL

/full_machine_copy

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
fsp_backupObject
  fsp_typeNumber固定传21:整机副本21
  wk_data_typeNumber固定传0:块设备0
  bk_data_typeNumber固定传21:华云平台21
  fsp_nameString规则名称
  wk_uuidString工作机uuid
  bk_uuidString灾备机uuid
  data_ip_uuidString数据地址uuid
  timeoutNumber超时阈值0
  wk_pathArray原路径(参考整机备份块设备)
  bk_pathArray灾备路径
  resource_settingsObject虚机设置
    tgt_uuidString目标平台uuid
    new_dcString数据中心
    new_dc_morString数据中心标识
    new_hostString主机名称
    new_dsString数据存储
    create_vm_typeNumber创建虚机策略:
0:指定节点;
1:系统调配;
    vm_listArray
      disk_listArray磁盘信息
        boot_indexString引导顺序
        file_nameString磁盘名称
        new_dsString存储名称
        sizeString磁盘大小
        is_ignoredString磁盘信息-是否忽略: 选中为0,不选为1
        disk_nameString磁盘信息-名称
从RPC接口返回的虚机磁盘名称,下发RPC仅需要最后磁盘名称
        disk_pathString磁盘信息-路径
Vmware暂时传 空串,Hyper-V传用户选的磁盘路径(结尾带)
        idStringhyper-v有,磁盘uuid
        disk_provision_typeNumber磁盘置备类型(仅限目标平台为vmware):
0:源机磁盘配置;
1:为精简置备;
2:为厚置备延迟置零;
3:为厚置备置零;
      vm_nameString工作机
      new_vm_nameString目标机名称
      new_vm_hostnameString目标机主机名
      custom_configNumber自定义设置:
是否勾选自定义设置:
0:否;
1:是;
      cpuString自定义设置:处理器数量
      core_per_sockString自定义设置:处理器核心
      mem_mbString自定义设置:内存
      dynamic_memString自定义设置:默认传0即可
      networksArray自定义设置:网卡信息
        source_network_nameString源端网卡名称
        mac_addressString源端mac地址
        keep_macString是否保留MAC(华云传'')
        network_idString目标平台网卡ID
        network_nameString目标平台网卡名称
        subnet_nameString子网名称(华云)
        auto_ipBoolean自动ip开关:
true:开;
false:关;
(华云)
        ipStringip地址(华云)
        security_group_nameString安全组名称(华云)
        gatewayString网关(华云平台参数)
        is_defrouteBoolean是否默认网关(华云平台参数)false
  auto_registerNumber是否自动注册节点:
0:否;
1:是;
  node_nameString自动注册目标机节点名称
  node_lic_listArray节点绑定许可列表
  node_cache_pathString节点数据缓存路径
  node_log_pathString节点日志路径

Response

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

整机副本 - 修改

方法名:modifyFullMachineCopy;

URL

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

Method

PUT

Request

名称类型必选简介Mock初始值Mock规则
fsp_backupObject
  fsp_typeNumber21
  wk_uuidString
  bk_uuidString
  data_ip_uuidString
  timeoutNumber0
  wk_pathArray
  bk_pathArray
  resource_settingsObject
    tgt_uuidString
    new_dcString
    new_hostString
    new_dsString
    new_dc_morString
    vm_listArray
      disk_listArray
        boot_indexString
        file_nameString
        new_dsString
        sizeString
        is_ignoredString
        disk_nameString
        disk_pathString
        idString
        disk_provision_typeNumber1
      vm_nameString
      new_vm_nameString
      custom_configNumber1
      cpuString
      core_per_sockString
      mem_mbString
      dynamic_memString
      networksArray
        source_network_nameString
        mac_addressString
        keep_macString
        network_idString
        network_nameString
        subnet_nameString
        auto_ipBooleanfalse
        ipString
        security_group_nameString
        gatewayString
        is_defrouteBoolean
  fsp_nameString
  bk_data_typeNumber21
  wk_data_typeNumber0
  auto_registerNumber1
  node_nameString
  random_strString随机字串

Response

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

整机副本 - 删除

方法名:deleteFullMachineCopy;

URL

/full_machine_copy

Method

DELETE

Request

名称类型必选简介Mock初始值Mock规则
fsp_uuidsArray规则uuid数组
del_policyString删除策略:
0:不开启;
1:开启;
forceNumber是否强制删除:
0:否;
1:是;

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

整机副本 - 获取详情

方法名:describeFullMachineCopy;

URL

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

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  messageString
  fsp_backupObject
    bk_ipString0.0.0.0
    bkup_one_timeNumber1515568566
    wk_portString26821
    mirr_open_typeString0
    wk_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
    secret_keyString
    bk_data_typeNumber0
    bkup_policyNumber0
    wk_pathString
    bk_pathString
    fsp_nameStringrrrrr
    mirror_methodString0
    bk_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
    wk_data_typeNumber1
    mirr_file_checkString0
    excl_pathString
    monitor_typeNumber0
    band_widthString303:00-14:002m
    service_uuidString
    backup_typeString@pick([0, 1, 2])
    bkup_scheduleArray
      sched_dayString@integer(1, 31)
      sched_time_endString@time('HH:mm')
      limitString@integer(1, 64)
      sched_gap_minString@integer(1, 64)
      sched_timeString@time('HH:mm')
      sched_everyNumber2
      sched_time_startString@time('HH:mm')
    compressString0
    move_typeString0
    wk_ipString0.0.0.0
    mirr_sync_attrString1
    bk_portString26831
    fsp_wk_shut_flagString2
    failoverNumber1
    mirr_sync_flagString0
    random_strString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
    sync_itemStringC:
    net_mappingArray
    net_mapping_typeString2
    encrypt_switchString0
    fsp_typeString
    cbt_switchNumber1
    threshold_vaild_byteNumber1
    advanced_policyObject
      bk_cdpNumber1
      execute_intervalNumber1
      cdp_detailNumber1
      cdp_dailyNumber1
      cdp_switchNumber1
      cdp_paramString
    storageObject
      typeString
      pathString
    vp_uuidString
    storage_uuidString
    data_ip_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
    thread_numNumber1
    in_failover_switchNumber1
    in_failover_settingsObject
      virtual_cidrString
      virtuai_gatewayString
      virtual_ipString
      virtual_portNumber1
      virtual_data_ipString
      oph_policyNumber1
      data_pathArray
      rc_dirArray
      excl_dirArray
    auto_registerNumber自动注册目标虚机节点0
    node_nameString目标虚机节点名称
    node_uuidString目标虚机节点uuid(成功注册后才有值)
  codeNumber0

整机副本 - 获取列表

SDK方法名:listFullMachineCopy;

URL

/full_machine_copy

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
search_fieldString
search_valueString
limitNumber10
pageNumber1

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  info_listArray
    fsp_uuidString规则uuid@pick(["0DD4E727-70AB-62C6-BEB5-D012DFAE46E3", "0DD4E727-70AB-62C6-BEB5-D012DFAE46E4"])
    fsp_nameString规则名称
    wk_uuidString工作机uuid7AD64D7A-7D1D-AC51-5DF1-29A58345A288
    wk_node_nameString工作机名称@pick(["Smith", "Will", "Nary"])
    resource_settingsObject虚机设置参数
      vm_listArray
        new_vm_nameString目标机名称
    tgt_nameString目标平台名称
    vm_nameString目标虚机名称
    usernameString所有者用户名@pick(["admin", "user", "super"])
    can_opString
    can_upString
    can_delNumber1
  totalNumber100
  countNumber10
  codeNumber0
  messageString

整机副本 - 获取状态

SDK方法名:listFullMachineCopyStatus;

URL

/full_machine_copy/status

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
fsp_uuidsArray
force_refreshNumber强制刷新:
0:否;
1:是;
0

Response

名称类型必选简介Mock初始值Mock规则
msgString
retNumber200
dataObject
  statusObject
    statusStringSTOP
    db_statusString
    fsp_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
    f_totalString0
    progressString0
    target_vm_ipString目标机ip
    host_nameString主机名
  countNumber0
  messageString
  codeNumber0

整机副本 - 操作

SDK方法名:operateFullMachineCopy;

URL

/full_machine_copy/operate

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
fsp_uuidsArray
operateStringstart:启动;
stop:停止;

Response

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

------ 应用容灾 ------

URL

/------ 应用容灾 ------

Method

GET

Request

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

Response

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

应用容灾 - 新建

SDK类名:/appContinuity/AppContinuity;

SDK方法名:createAppContinuity;

URL

/app_continuity

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
rep_nameString规则名称
biz_grp_listArray绑定业务组列表
wk_uuidString工作机uuid
vp_uuidString目标平台
vm_nameString目标虚机名称
vm_refString目标虚机ID
bk_uuidString目标节点
data_ip_uuidString目标节点数据地址uuid
wk_pathArray工作路径
bk_pathArray目标路径
excl_pathArray排除路径
mirr_file_checkNumber校验方式:
0:严格校验;
1:时间校验;
mirr_sync_flagNumber错误处理方式:
0:遇到错误停止;
1:写日志;
mirr_open_typeNumber文件打开方式:
0:普通文件;
1:自动选择;
2:MFT;
mirr_sync_attrNumber文件安全属性:
0:不同步;
1:同步;
encrypt_switchNumber加密开关:
0:关;
1:开;
secret_keyString加密秘钥
compressNumber压缩等级:
0:关;
1:极速压缩;
2:普通压缩;
3:快速压缩;
4:均衡压缩;
oph_policyNumber孤儿文件策略:
0:不处理;
1:删除;
2:移动到指定路径;
6:移动到指定路径并删除;
oph_pathString孤儿文件指定路径
thread_numNumber并行任务数
bkup_scheduleArray快照策略(参照整机备份-周期性备份策略)
  sched_dayArray哪几天
  sched_timeArray哪几点
  sched_everyNumber0:每天;
1:每周:
2:每月;
3:每隔;
  limitString快照保留期限
  sched_gap_hourNumber每隔 - 间隔时间(小时),必须能够被24整除
  sched_time_startString每隔,开始时间
band_widthString带宽控制,格式:
303:00-14:002m,202:00-15:0080m(block也有)
take_over_settingsObject接管配置
  disk_listArray目标虚机磁盘列表
    file_nameString磁盘名称
    sizeString磁盘大小
    new_dsString存储名称
    boot_indexNumber引导顺序
  networksArray目标虚机网卡列表
    network_nameString名称
    network_idStringID
    subnet_nameString子网名称
    auto_ipBoolean自动ip开关:
true:开;
false:关;
(华云平台参数)
    ipStringip地址
    security_group_nameString安全组名称
    gatewayString网关(华云平台参数)
    is_defrouteBoolean是否默认网关(华云平台参数)false
  cpuString目标机处理器数量
  core_per_sockString目标机处理器核心数
  mem_mbString目标机内存
verify_settingsObject验证设置
  add_drillNumber是否开启验证:、
0:否;
1:是;
  autoString自动验证:
自动:1;
手动:0;
  drill_plat_uuidString演练平台uuid
  create_vm_typeNumber创建虚机策略:
0:指定节点;
1:系统调配;
1
  hostnameString主机名称
  vm_listArray虚机列表
    vm_nameString虚机名称(目标虚机)
    orch_vm_nameString演练新虚机名称
    scripts_typeNumber脚本验证的方式:
0:ping;
1:tcp端口验证;
2:脚本验证(默认为0);
    scriptsString验证内容
    custom_configNumber是否开启自定义验证:
0:否;
1:是
    orch_disksArray
      file_nameString名称
      sizeString大小
      new_dsString存储
      boot_indexString引导顺序
      disk_nameString
      disk_pathString
      idString
    orch_networksArray
      source_network_nameString源端网卡名称(目标虚机)
      mac_addressString远端网卡mac地址(华云平台传'')
      keep_macString保留mac(华云平台传'')
      network_nameString目标平台(和演练平台是同一个)网卡名称,不可以修改
      network_idString目标平台(和演练平台是同一个)网卡id,不可以修改
      subnet_nameString子网名称(华云平台参数)
      ipStringip地址(华云平台参数)
      security_group_nameString安全组名称(华云平台参数)
      gatewayString网关(华云平台参数)
      is_defrouteBoolean是否默认网关(华云平台参数)false
    orch_cpu_numString演练虚机cpu个数
    orch_cores_per_cpu_numString演练虚机cpu核心数
    orch_memory_mbString演练虚机内存
is_continue_policyNumber规则停止后继续定时快照:
0:关;
1:开;

Response

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

应用容灾 - 修改

SDK方法名:modifyAppContinuity;

URL

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

Method

PUT

Request

名称类型必选简介Mock初始值Mock规则
rep_nameString
wk_uuidString
vp_uuidString
biz_grp_listArray
vm_nameString
vm_refString
bk_uuidString
data_ip_uuidString
wk_pathArray
bk_pathArray
excl_pathArray
mirr_file_checkNumber1
mirr_sync_flagNumber1
mirr_open_typeNumber1
mirr_sync_attrNumber1
encrypt_switchNumber1
secret_keyString
compressNumber1
bkup_scheduleArray
  sched_dayArray
  sched_timeArray
  sched_everyNumber1
  limitString
band_widthString
verify_settingsObject
  add_drillNumber1
  autoString
  drill_plat_uuidString
  vm_listArray
    vm_nameString
    orch_vm_nameString
    scripts_typeNumber1
    scriptsString
    custom_configNumber1
    orch_disksArray
      file_nameString
      sizeString
      new_dsString
      boot_indexString
      disk_nameString
      disk_pathString
      idString
    orch_networksArray
      source_network_nameString
      network_nameString
      network_idString
      subnet_nameString
      ipString
      security_group_nameString
      mac_addressString
      keep_macString
      gatewayString
      is_defrouteBoolean
    orch_cpu_numString
    orch_cores_per_cpu_numString
    orch_memory_mbString
take_over_settingsObject
  disk_listArray
    file_nameString
    sizeString
    new_dsString
    boot_indexNumber1
  networksArray
    network_nameString
    network_idString
    subnet_nameString
    auto_ipBooleanfalse
    ipString
    security_group_nameString
    gatewayString
    is_defrouteBoolean
  cpuString
  core_per_sockString
  mem_mbString
random_strString随机字串

Response

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

应用容灾 - 删除

方法名:deleteAppContinuity;

URL

/app_continuity

Method

DELETE

Request

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

Response

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

应用容灾 - 获取详情

方法名:describeAppContinuity;

URL

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

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  messageString
  codeNumber0
  app_continuityObject
    rep_nameString
    wk_uuidString
    vp_uuidString
    biz_grp_listArray
    vm_nameString
    vm_refString
    bk_uuidString
    data_ip_uuidString
    wk_pathArray
    bk_pathArray
    excl_pathArray
    mirr_file_checkNumber1
    mirr_sync_flagNumber1
    mirr_open_typeNumber1
    mirr_sync_attrNumber1
    encrypt_switchNumber1
    secret_keyString
    compressNumber1
    bkup_scheduleArray
      sched_dayArray
      sched_timeArray
      sched_everyNumber1
      limitString
    band_widthString
    verify_settingsObject
      add_drillNumber1
      autoString
      drill_plat_uuidString
      vm_listArray
        vm_nameString
        orch_vm_nameString
        scripts_typeNumber1
        scriptsString
        custom_configNumber1
        orch_disksArray
          file_nameString
          sizeString
          new_dsString
          boot_indexString
          disk_nameString
          disk_pathString
          idString
        orch_networksArray
          source_network_nameString
          network_nameString
          network_idString
          subnet_nameString
          ipString
          security_group_nameString
          mac_addressString
          keep_macString
        orch_cpu_numString
        orch_cores_per_cpu_numString
        orch_memory_mbString
    take_over_settingsObject
      disk_listArray
        file_nameString
        sizeString
        new_dsString
        boot_indexNumber1
      networksArray
        network_nameString
        network_idString
        subnet_nameString
        auto_ipBooleanfalse
        ipString
        security_group_nameString
      cpuString
      core_per_sockString
      mem_mbString
    failover_script_uuidString切换(接管)脚本uuid
    failback_script_uuidString回切(回退)脚本uuid

应用容灾 - 列表

SDK方法名:listAppContinuity;

URL

/app_continuity

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  info_listArray2-4
    rep_uuidString规则uuid@uuid
    rep_nameString规则名称rep-@first
    wk_uuidString工作机uuid@uuid
    wk_node_nameString工作机名称工作机-@cname
    wk_ipString
    bk_uuidString
    bk_ipString
    vp_uuidString目标平台uuid@uuid
    vp_nameString目标平台名称target-plat-@first
    vp_config_addrString
    vm_nameString目标虚机名称target-vm-@first
    vm_refString目标虚机ID
    user_uuidString
    usernameString@pick(["admin", "user", "super"])
    can_delNumber1
    can_opString
    can_upString
  totalNumber100
  countNumber10
  codeNumber0
  messageString

应用容灾 - 操作

SDK方法名: operateAppContinuity;

URL

/app_continuity/operate

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
rep_uuidsArray
operateStringstart:启动;
stop:停止;
snapshot_immediately:立即快照;
snapshot_delete:删除快照;
failover:接管;
failback:回退;

modify_script:脚本管理(接管列表调用)
snap_nameString快照时间点(删除快照参数);
snap_pointString快照时间点(接管参数);
failover_script_uuidString切换(接管)脚本uuid
failback_script_uuidString回切(回退)脚本uuid

Response

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

应用容灾 - 获取状态

SDK方法名:listAppContinuityStatus;

URL

/app_continuity/status

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
rep_uuidsArray
force_refreshNumber强制刷新:
0:否;
1:是;
0

Response

名称类型必选简介Mock初始值Mock规则
msgString
retNumber200
dataObject
  statusObject
    rep_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
    statusStringSTOP
    progressString0
    latencyNumber复制延迟,单位ms
    target_vm_ipString目标虚机ip
  countNumber0
  messageString
  codeNumber0

--- 一级副本(复用应急演练) ---

URL

/------- 一级副本 -------

Method

GET

Request

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

Response

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

一级副本 - 新建

参照 虚机演练规则;

SDK类名:/replica/First;

SDK方法名:createFirstReplica;

URL

/replica/first

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
rule_nameString虚机名称
rule_typeNumber固定传50
vp_uuidString目标平台uuid
datacenterString目标平台数据中心
hostnameString目标平台主机
datastoreString目标平台存储
vm_listArray工作机列表
  vm_nameString虚机(工作机)名称
  new_vm_nameString新虚机名称
  new_vm_hostnameString新虚机主机名
  cpuNumber处理器数量1
  core_per_sockNumber处理器核心数量1
  mem_mbNumber内存大小1024
  original_rule_uuidString应用容灾uuid
  wk_uuidString应用容灾,工作机uuid
  bk_uuidString应用容灾,目标节点uuid
  timeString备份点
  ver_sigString备份点信息
  disk_listArray自定义磁盘信息
    datastoreString
    new_dsString
    is_ignoredNumber1
    sizeString
    boot_indexNumber1
    disk_dirString
    disk_nameString
    idString
  networksArray自定义网卡信息
    source_network_nameString
    source_network_idString
    mac_addressString
    keep_macString
    network_idString
    network_nameString
    ip_addressString
    subnet_nameString
    auto_ipBooleantrue
    ipString
    security_group_nameString
    gatewayString(华云平台参数)
网关
    is_defrouteBoolean(华云平台参数)
是否默认网关
false
  os_typeNumber1
  vm_refString''
  scriptsString''
  scripts_typeNumber0
  bk_pathString''
  src_uuidString
  data_ip_uuidString
  bk_typeNumber0
  bucket_String
  sto_uuidString
  bucket_pathString
  new_flavor_idString
autoNumber0
quick_backNumber1
backup_typeStringi
lan_freeNumber23
del_bkup_dataNumber0
automateNumber0
auto_shutdownNumber1
bkup_policyNumber
bkup_scheduleObject
  sched_time_startString0
  limitNumber0
  sched_dayNumber6
  sched_everyNumber0
  sched_timeArray
  sched_gap_minNumber0
new_network_idString
new_network_nameString
create_vm_typeNumber创建虚机策略:
0:指定节点;
1:系统调配;

Response

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

一级副本 - 获取列表

SDK方法名:listFirstReplica;

URL

/replica/first

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString
  info_listArray
    group_uuidString组uuid@uuid
    rule_nameString虚机名称Donna Smith
    rule_uuidString副本uuidE3EdA75B-Db84-c4EF-75d7-DfbaacdCB5eF
    vp_uuidString虚拟平台uuidDcDd4A7d-2Ae3-bFd7-d346-14F0A9Fad77C
    vp_nameString虚拟平台名称Mary Jackson
    vp_typeNumber虚拟平台类型0
    wk_uuidString工作机uuid
    wk_node_nameString工作机名称wk-@first
    timeString备份点@time
    usernameString所有者Daniel Smith
    can_delNumber1
    can_upNumber
    can_opNumber
    vp_config_addrString虚拟平台管理地址
    hostnameString主机名称
    datastoreString存储
  totalNumber1

一级副本 - 获取详情

UUID为group_uuid;

SDK方法名:describeFirstReplica;

URL

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

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功
  first_replicaObject
    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

一级副本 - 修改

UUID为group_uuid

SDK方法名:modifyFirstReplica;

URL

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

Method

PUT

Request

名称类型必选简介Mock初始值Mock规则
rule_nameString
rule_typeNumber0
vp_uuidString
autoNumber0
vm_listArray
  new_vm_nameString
  vm_refString''
  cpuNumber1
  ver_sigString
  core_per_sockNumber1
  mem_mbNumber1024
  scriptsString''
  bk_uuidString
  bk_pathString''
  timeString
  original_rule_uuidString
  scripts_typeNumber0
  os_typeNumber1
  wk_uuidString
  src_uuidString
  data_ip_uuidString
  bk_typeNumber0
  bucket_String
  sto_uuidString
  bucket_pathString
  disk_listArray
    datastoreString
    new_dsString
    is_ignoredNumber1
    sizeString
    boot_indexNumber1
    disk_dirString
    disk_nameString
    idString
  networksArray
    source_network_nameString
    source_network_idString
    mac_addressString
    keep_macString
    network_idString
    network_nameString
    ip_addressString
    subnet_nameString
    auto_ipBooleantrue
    ipString
    security_group_nameString
    gatewayString
    is_defrouteBoolean
  new_flavor_idString
  vm_nameString
quick_backNumber1
backup_typeStringi
lan_freeNumber23
del_bkup_dataNumber0
automateNumber0
auto_shutdownNumber1
bkup_policyNumber1
bkup_scheduleObject
  sched_time_startString0
  limitNumber0
  sched_dayNumber6
  sched_everyNumber0
  sched_timeArray
  sched_gap_minNumber0
new_network_idString
new_network_nameString
datastoreString
hostnameString
datacenterString

Response

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

一级副本 - 获取状态

SDK方法名:listFirstReplicaStatus;

URL

/replica/first/status

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
rule_uuidsNumber
force_refreshNumber强制刷新

Response

名称类型必选简介Mock初始值Mock规则
msgString
retNumber200
dataObject
  countString1
  messageString
  codeNumber0
  statusArray
    statusString@pick(VP_START, MIRROR)
    progressNumber0-100
    rule_uuidStringE3EdA75B-Db84-c4EF-75d7-DfbaacdCB5eF
    target_vm_ipString目标机ip

一级副本 - 操作

SDK方法名:operateFirstReplica;

URL

/replica/first/operate

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
operateStringstart_vm:开机;
stop_vm:关机;
rule_uuidsArray规则uuid

Response

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

一级副本 - 删除

SDK方法名:deleteFirstReplica;

URL

/replica/first

Method

DELETE

Request

名称类型必选简介Mock初始值Mock规则
rule_uuidsString
group_uuidsString
delete_tgtvmNumber是否删除目标虚机,0,1

Response

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

--- 二级副本(复用整机备份) ---

URL

/------- 二级副本 -------

Method

GET

Request

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

Response

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

二级副本 - 新建

参照 整机副本规则;

SDK类名:/replica/Second;

SDK方法名:createSecondReplica;

URL

/replica/second

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
fsp_backupObject
  fsp_nameString虚机名称
  fsp_typeNumber固定传2222
  wk_uuidString工作机uuid
  bk_uuidString灾备代理节点
  wk_data_typeNumber固定传0(同整机副本)0
  bk_data_typeNumber固定传21(同整机副本)21
  resource_settingsObject虚机设置
    tgt_uuidString目标平台uuid
    new_dcString数据中心
    new_dc_morString数据中心标识
    new_hostString主机
    new_dsString存储
    vm_listArray虚机列表
      vm_nameString工作机
      new_vm_nameString目标机名称
      new_vm_hostnameString目标机主机名
      custom_configNumber自定义设置:
是否勾选自定义设置:
0:否;
1:是;
1
      cpuStringcpu数量
      core_per_sockString核心数
      mem_mbString内存
      dynamic_memString0
      disk_listArray
        boot_indexString
        file_nameString
        new_dsString
        sizeString
        is_ignoredString
        disk_nameString
        disk_pathString
        idString
        disk_provision_typeNumber1
      networksArray
        source_network_nameString
        mac_addressString
        keep_macString
        network_idString
        network_nameString
        subnet_nameString
        auto_ipBooleanfalse
        ipString
        security_group_nameString
        gatewayString(华云平台参数)
网关
        is_defrouteBoolean(华云平台参数)
是否默认网关
false
    create_vm_typeNumber创建虚机策略:
0:指定节点;
1:系统调配;
  timeoutNumber0
  data_ip_uuidString''
  wk_pathArray[]
  bk_pathArray[]
  auto_registerNumber0
  node_nameString''
  node_lic_listArray[]

Response

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

二级副本 - 获取列表

SDK方法名:listSecondReplica;

URL

/replica/second

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString
  info_listArray
    fsp_nameString虚机名称Donna Smith
    fsp_uuidString二级副本uuid0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
    tgt_nameString目标平台名称DcDd4A7d-2Ae3-bFd7-d346-14F0A9Fad77C
    usernameString所有者Daniel Smith
    wk_uuidString工作机uuid
    wk_node_nameString工作机名称
    can_delNumber1
    can_upNumber1
    can_opNumber1
    tgt_config_addrString目标平台管理地址
    hostnameString主机
    datastoreString存储
  totalNumber1

二级副本 - 获取详情

SDK方法名:describeSecondReplica;

URL

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

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString
  fsp_backupObject
    fsp_typeNumber22
    wk_uuidString
    bk_uuidString
    data_ip_uuidString''
    timeoutNumber0
    wk_pathArray
    bk_pathArray
    resource_settingsObject
      tgt_uuidString
      new_dcString
      new_hostString
      new_dsString
      new_dc_morString
      vm_listArray
        disk_listArray
          boot_indexString
          file_nameString
          new_dsString
          sizeString
          is_ignoredString
          disk_nameString
          disk_pathString
          idString
          disk_provision_typeNumber1
        vm_nameString
        new_vm_nameString
        custom_configNumber1
        cpuString
        core_per_sockString
        mem_mbString
        dynamic_memString0
        networksArray
          source_network_nameString
          mac_addressString
          keep_macString
          network_idString
          network_nameString
          subnet_nameString
          auto_ipBooleanfalse
          ipString
          security_group_nameString
          gatewayString(华云平台参数)
网关
          is_defrouteBoolean(华云平台参数)
是否默认网关
false
    fsp_nameString
    bk_data_typeNumber21
    wk_data_typeNumber0
    auto_registerNumber0
    node_nameString''
    node_lic_listArray
  totalNumber1

二级副本 - 修改

UUID为group_uuid

SDK方法名:modifySecondReplica;

URL

/replica/second

Method

PUT

Request

名称类型必选简介Mock初始值Mock规则
fsp_backupObject
  fsp_typeNumber22
  wk_uuidString
  bk_uuidString
  data_ip_uuidString''
  timeoutNumber0
  wk_pathArray
  bk_pathArray
  resource_settingsObject
    tgt_uuidString
    new_dcString
    new_hostString
    new_dsString
    new_dc_morString
    vm_listArray
      disk_listArray
        boot_indexString
        file_nameString
        new_dsString
        sizeString
        is_ignoredString
        disk_nameString
        disk_pathString
        idString
        disk_provision_typeNumber1
      vm_nameString
      new_vm_nameString
      custom_configNumber1
      cpuString
      core_per_sockString
      mem_mbString
      dynamic_memString0
      networksArray
        source_network_nameString
        mac_addressString
        keep_macString
        network_idString
        network_nameString
        subnet_nameString
        auto_ipBooleanfalse
        ipString
        security_group_nameString
        gatewayString(华云平台参数)
网关
        is_defrouteBoolean(华云平台参数)
是否默认网关
false
  fsp_nameString
  bk_data_typeNumber21
  wk_data_typeNumber0
  auto_registerNumber0
  node_nameString''
  node_lic_listArray

Response

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

二级副本 - 操作

SDK方法名:operateSecondReplica;

URL

/replica/second/operate

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
operateStringstart:启动;
stop:停止;
start_vm:开机;
stop_vm:关机;
fsp_uuidsArray

Response

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

二级副本 - 删除

SDK方法名:deleteSecondReplica;

URL

/replica/second

Method

DELETE

Request

名称类型必选简介Mock初始值Mock规则
fsp_uuidsArray
del_policyNumber删除策略:
0:不开启;
1:开启;
forceNumber是否强制删除:
0:否;
1:是;

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方法名:listSecondReplicaStatus;

URL

/replica/second/status

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
fsp_uuidsArray
force_refreshNumber强制刷新:
0:否;
1:是;

Response

名称类型必选简介Mock初始值Mock规则
msgString
retNumber200
dataObject
  statusArray
    statusString同步状态STOP
    vm_statusString虚机状态@pick(MIRROR, START)
    fsp_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
    f_totalString0
    progressString0
    target_vm_ipString目标虚机ip
  countNumber0
  messageString
  codeNumber0

------ 虚机克隆 ------

URL

/dash/vm_clone

Method

GET

Request

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

Response

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

虚机克隆规则 - 新建

SDK类名:/vmClone/VmCloneRule;

SDK方法名:createVmCloneRule;

URL

/vm_clone/rule

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
rule_nameString任务名称
wk_uuidString工作机uuid
bk_uuidString灾备机uuid
wk_pathArray工作路径
bk_pathArray灾备路径
prefixString虚机名称前缀
vm_cntNumber虚机数量
vp_uuidString目标平台uuid
new_dcString数据中心
new_dc_morString数据中心唯一标识
new_hostString主机
new_dsString存储
create_vm_typeNumber克隆目标主机选项(安超云):
0:指定节点
1:系统调配
vm_listArray虚机列表
  vm_nameString虚机名称
  vm_hostnameString虚机主机名
  cpuNumber处理器数量
  core_per_sockNumber处理器核心数
  mem_mbNumber内存
  dnsStringVMware
  networksArray
    source_network_nameString源端网卡
    mac_addressString源端MAC地址(华云平台传'')
    keep_macString保留MAC(华云平台传'')
    network_idString目标平台网卡
    network_nameString目标平台网卡名称
    subnet_nameString子网名称(华云平台参数)
    auto_ipBoolean自动ip开关:
true:开;
false:关;
(华云平台参数)
    ipStringip地址(华云平台参数)
    security_group_nameString安全组名称(华云平台参数)
    gatewayString目标网关
auto_startNumber规则自启动:
0:关;
1:开;
bkup_policyNumber备份策略:
0:预约执行;
2:立即执行;
3:手动执行;
bkup_one_timeNumber预约执行时间,unix时间戳

Response

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

虚机克隆规则 - 获取列表

SDK方法名:listVmCloneRule;

URL

/vm_clone/rule

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
pageNumber
limitNumber
search_fieldString搜索字段:
rule_name:任务名称;
vp_name:平台名称;
wk_node_name:工作机名称;
search_valueString搜索值

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString
  info_listArray2-5
    rule_uuidString规则uuid224fB2fc-FFC5-Dbc9-5883-d53CEB8Be389
    rule_nameString规则名称rule-@name
    vm_cntNumber虚机数量2-5
    wk_uuidString工作机uuid@uuid
    wk_node_nameString工作机数量wk_@first
    vp_uuidString目标平台uuid@uuid
    vp_nameString目标平台名称vp-@first
    user_uuidString用户uuid@uuid
    usernameString用户名称user-@first
  totalNumber1

虚机克隆规则 - 获取单个详情

SDK方法名:describeVmCloneRule;

URL

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

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString
  vm_clone_ruleObject
    rule_nameString
    wk_uuidString
    bk_uuidString
    wk_pathArray
    bk_pathArray
    auto_startNumber1
    prefixString
    vm_cntNumber1
    vp_uuidString
    new_dcString
    new_dc_morString
    new_hostString
    new_dsString
    create_vm_typeNumber1
    vm_listArray
      vm_nameString
      cpuNumber1
      core_per_sockNumber1
      mem_mbNumber1
      dnsString
      networksArray
        source_network_nameString
        mac_addressString
        keep_macString
        network_idString
        network_nameString
        subnet_nameString
        auto_ipString
        ipString
        security_group_nameString
        gatewayString

虚机克隆规则 - 删除

SDK方法名:deleteVmCloneRule;

URL

/vm_clone/rule

Method

DELETE

Request

名称类型必选简介Mock初始值Mock规则
rule_uuidsNumber规则uuid数组
forceNumber强制删除

Response

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

虚机克隆规则 - 操作

SDK方法名:operateVmCloneRule;

URL

/vm_clone/rule/operate

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
rules_uuidNumber规则uuid数组
operateString操作:
start:开始;
stop:停止;

Response

名称类型必选简介Mock初始值Mock规则
msgString
retNumber200
dataObject
  codeNumber11110001
  messageString
  fail_listArray
    codeNumber11110001
    messageString[-1] 离线
    rule_uuidString规则uuid@guid
    rule_nameString规则名称test2
  success_listArray
    codeNumber11110001
    messageString[0] success
    rule_uuidString@guid
    rule_nameStringtest1

虚机克隆规则 - 获取状态

SDK方法名:listVmCloneRuleStatus;

URL

/vm_clone/rule/status

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
rule_uuidsNumber规则uuid数组
force_refreshString

Response

名称类型必选简介Mock初始值Mock规则
msgString
retNumber200
dataObject
  statusArray
    rule_uuidString规则uuid224fB2fc-FFC5-Dbc9-5883-d53CEB8Be389
    statusString状态字段:
CLONING:克隆中
STOP
  countNumber0
  messageString
  codeNumber0

虚机克隆虚机 - 获取列表

SDK类名:/vmClone/VmCloneVm;

SDK方法名:listVmCloneVm;

URL

/vm_clone/vm

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
pageNumber
limitNumber
where_args[status]String虚机状态过滤:
search_fieldString搜索字段:
sys_name:应用系统名称
vp_name:虚拟平台名称;
vm_name:虚机名称;
search_valueString搜索值

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString
  info_listArray2-10
    uuidString虚机记录uuid@pick(['F0Bd1A0B-503F-D174-d298-eeF39aBAcfAe','fFbfcBDC-fef1-38d8-0848-F5ECb2D34627'])
    vm_nameString虚机名称vm-@first
    rule_uuidString关联的规则uuid@uuid
    rule_nameString关联的规则名称rule-@first
    sys_nameString应用系统名称sys-@first
    user_uuidString用户uuid@uuid
    usernameString用户名user-@first
    vp_uuidString目标平台uuid@uuid
    vp_nameString目标平台名称vp-@first
    vp_config_addrString目标平台管理地址
    wk_uuidString工作机uuid
    wk_node_nameString工作机名称
    wk_config_addrString工作机管理地址
    wk_ipString工作机数据地址
    bk_uuidString灾备代理节点uuid
    bk_node_nameString灾备代理节点名称
    bk_config_addrString灾备代理节点管理地址
    bk_ipString灾备代理节点数据地址
  totalNumber1

虚机克隆虚机 - 修改虚机配置

SDK方法名:modifyVmConfig;

URL

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

Method

PUT

Request

名称类型必选简介Mock初始值Mock规则
vm_nameString虚机名称
vm_hostnameString主机名称
cpuNumber处理器数量
core_per_sockNumber处理器核心数
mem_mbNumber内存
dnsStringdns(VMware)
networksArray
  source_network_nameString源端网卡
  mac_addressString源端MAC地址(华云平台传'')
  keep_macString保留MAC(华云平台传'')
  network_idString目标平台网卡
  network_nameString目标平台网卡名称
  subnet_nameString子网名称(华云平台参数)
  auto_ipBoolean自动ip开关:
true:开;
false:关;
(华云平台参数)
  ipStringip地址(华云平台参数)
  security_group_nameString安全组名称(华云平台参数)
  gatewayString目标网关

Response

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

虚机克隆虚机 - 删除

SDK方法名:deleteVmCloneVm;

URL

/vm_clone/vm

Method

DELETE

Request

名称类型必选简介Mock初始值Mock规则
uuidsArray虚机记录uuid数组
forceNumber强制删除

Response

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

虚机克隆虚机 - 操作

SDK方法名:operateVmCloneVm;

URL

/vm_clone/vm/operate

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
uuidsString虚机记录uuid数组
operateString操作:
start_vm:开机;
stop_vm:关机;

Response

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

虚机克隆虚机 - 获取状态

SDK方法名:listVmCloneVmStatus;

URL

/vm_clone/vm/status

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
force_refreshNumber强制刷新
uuidsArray['F0Bd1A0B-503F-D174-d298-eeF39aBAcfAe', 'fFbfcBDC-fef1-38d8-0848-F5ECb2D34627']

Response

名称类型必选简介Mock初始值Mock规则
msgString
retNumber200
dataObject
  statusObject
    uuidString''
    statusStringONLINE:在线;
OFFLINE:离线;
PREPARE:准备中;
UNKNOWN:未知;
MODIFYING:;
STOP
    last_resultObject上次修改结果
      resultNumber结果:
0:成功;
1:失败;
      timeString修改时间
    ipString虚机ip
  countNumber0
  messageString
  codeNumber0

虚机克隆虚机 - 获取详情

SDK方法名:describeVmCloneVm;

URL

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

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
msgString
retNumber200
dataObject
  countNumber0
  messageString
  codeNumber0
  vm_clone_vmObject
    rule_uuidString整机克隆任务的uuid
    rule_nameString
    new_dcString
    new_dc_morString
    new_hostString
    new_dsString
    vp_uuidString虚拟平台uuid
    vp_typeString
    uuidString当前虚机自己的uuid
    vm_nameString
    vm_uuidString虚机uuid,可能为空
    cpuNumber1
    core_per_sockNumber1
    mem_mbNumber1
    dnsString
    networksArray
      source_network_nameString
      mac_addressString
      keep_macString
      network_idString
      network_nameString
      subnet_nameString
      auto_ipBooleanfalse
      ipString
      security_group_nameString
      gatewayString
    user_uuidString
    create_timeNumber

--- 历史版本 ---

SDK类名:/ruleVersion/RuleVersion;

URL

/------- 历史版本 -------

Method

GET

Request

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

Response

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

历史版本 - 列表

SDK方法名:listRuleVersion;

URL

/rule_version

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
pageNumber
limitNumber
where_args[uuid]String规则uuid
where_args[type]String规则类型:
rep:文件备份;
fsp:整机备份;
vp:虚机备份;
move:迁移;
ha:高可用;
script:高可用脚本;
like_args[sys_name]String应用系统名称
like_args[protect_name]String保护对象名称

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  messageString[0] 操作成功
  info_listArray
    idString自增主键@increment
    uuidString规则uuid
    nameString规则名称
    typeString规则类型:
rep:文件备份;
fsp:整机备份;
vp:虚机备份;
move:迁移;
ha:高可用;
    majorNumber是否主版本:
0:否;
1:是;
1
    versionString版本
    sys_nameString应用系统名称
    protect_nameString保护对象名称
    usernameString操作用户名
    user_uuidString操作用户uuid
  totalNumber1
  codeNumber0

历史版本 - 查看具体信息

SDK方法名:describeRuleVersionInfo;

URL

/rule_version/info

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
idNumber主键id

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  messageString
  infoObject规则配置信息
  codeNumber0

历史版本 - 操作

SDK方法名:operateRuleVersion;

URL

/rule_version/operate

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
idsArray规则id(当前不支持批量操作)
operateString操作类型:
set_main:设置为主版本;

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageStringsuccess
  file_nameString脚本类型 - 下载操作,返回的文件名

------- 回收站 -------

SDK类名:/recycleBin/RecycleBin;

URL

/------- 回收站 -------

Method

GET

Request

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

Response

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

回收站 - 获取列表

SDK方法名:listRecycleBin;

URL

/recycle_bin

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
pageNumber页数
limitNumber条数
where_args[type]String规则类型,同历史版本:
rep:文件备份;
fsp:整机备份;
vp:虚机备份;
move:迁移;
ha:高可用;
search_fieldStringname,名称模糊查询
search_valueString

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  messageString[0] 操作成功
  info_listArray
    idString@increment
    uuidString规则UUID
    nameString规则名称
    typeString规则类型
    user_uuidString操作用户UUID
    usernameString操作用户名
  totalNumber1
  codeNumber0

回收站 - 获取配置

SDK方法名:describeRecycleBin;

URL

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

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString
  infoObject规则数据库配置信息,对应不同类型规则
Last update: 8/1/2024, 2:00:50 PM
Contributors: ganl