备份中心

November 18, 2022About 21 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子目录,以此类推
  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:虚机备份);
search_fieldString过滤字段:
sys_name:应用系统名称;
rule_name:规则名称;
wk_node_name:工作机名称;
search_valueString过滤值:

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工作机节点名称 或虚机名称
    tgt_nameString目标虚机名称
  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上次成功验证时间

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

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
    childrenArray
      String
    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
Last update: 11/18/2022, 3:56:21 PM
Contributors: ganl