通用接口

June 24, 2022About 22 min

通用接口

SDK类名:/common/GeneralInterface;

版本信息

获取控制台版本相关信息

SDK方法名:describeVersion

URL

/version

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] success
  prod_typeStringSTD
  versionString7.0.0.80
  api_versionString2.0.0
  bundle_versionString2e44b27
  build_dateString20181018
  migration_versionNumber201803130622295

新版本信息

获取新版本信息以及升级包下载地址

SDK方法名:latestVersion

URL

/check/latest_version

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
platStringplat | String平台 PC端Install.log中的平台信息,Android直接传mobile,iOS已经禁止app去检测更新example_plat

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  returnCodeNumber0
  versionString7.1.68.xxxx
  downloadUrlString"{$server}/{$path}/{$rs['version']}/{$plat}-{$rs['version']}.zip"http://download.i2yun.com/upgrade/7.1.68.xxxx/example_plat-7.1.68.xxxx.zip

获取版本提交记录

SDK方法名:listVersionHistory;

URL

/version_history

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  version_historyArray2
    timeString2020-03-03
    versionString版本号
    contentArray包含版本详细改动的数组

初始化(升级)DB-migrate

SDK方法名:updateDatabase

URL

/migrate

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber@mock=200200
dataObject
  codeNumber@mock=00
  messageString@mock=success update to latest versionsuccess update to latest version
msgString

连接测试

SDK方法名:nodeConnectTest;

URL

/node/connect_test

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
ipString
portString
typeStringnode - 节点;
vp - vp平台
node
node_uuidsArraynode类型下发

Response

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

Dashboard-整体状态统计

SDK方法名:overall;

首页Dashboard 整体状态统计图表

URL

/dashboard/overall

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] success
  node_numNumber13
  rep_numNumber20
  ha_numNumber30
  nodeObject
    ONLINENumber4
    OFFLINENumber6
    UNKNOWNString数据库中为空(未曾送过状态到控制机)3
  repObject
    UNKNOWNNumber2
    STOPNumber3
    REPLICATIONNumber5
    MIRRORNumber6
    EXCEPTIONNumber1
    STALENumber3
    SWITCHNumber3
  haObject
    master_roleObject
      HA_UNKNOWNNumber2
      HA_UNJOINNumber2
      HA_MASTERNumber2
      HA_SLAVENumber3
      HA_SWITCHNumber2
    master_statusObject
      HA_UNKNOWNNumber2
      HA_STOPNumber3
      HA_STARTNumber3
      HA_RUNNumber3
      HA_MIRRORNumber3
      HA_READYNumber3
      HA_WARNNumber4
      HA_FAILNumber4

Dashboard-平台监控(整体状态+VP)

SDK方法名:upMonitorOverall

URL

/dashboard/up_monitor_overall

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  overallObject
    codeNumber0
    messageString[0] success
    node_numNumber21
    rep_numNumber12
    ha_numNumber2
    nodeObject
      UNKNOWNNumber17
      OFFLINENumber0
      ONLINENumber4
    repObject
      UNKNOWNNumber4
      FINISHNumber0
      STOPNumber3
      REPLICATIONNumber4
      MIRRORNumber0
      EXCEPTIONNumber0
      STALENumber1
      SWITCHNumber0
      WAITNumber0
      EXECUTINGNumber0
      IDLENumber0
      DEADNumber0
    haObject
      master_statusObject
        HA_UNKNOWNNumber0
        HA_STOPNumber0
        HA_STARTNumber0
        HA_RUNNumber2
        HA_MIRRORNumber0
        HA_READYNumber0
        HA_WARNNumber0
        HA_FAILNumber0
      master_roleObject
        HA_UNKNOWNNumber0
        HA_UNJOINNumber0
        HA_MASTERNumber2
        HA_SLAVENumber0
        HA_PREOVERNumber0
        HA_POSTOVERNumber0
        HA_PREBACKNumber0
        HA_POSTBACKNumber0
        HA_SWITCHNumber0
  vp_vmObject
    codeNumber0
    messageString[0] success
    vm_protectedNumber0
    vm_totalNumber0
  vp_ruleObject
    codeNumber0
    messageString[0] success
    all_total_numNumber167
    all_trans_data_numString45.31 GB
    all_success_numNumber32
    all_unread_err_numNumber135
    total_numNumber94
    trans_data_numString35.76 GB
    success_numNumber25
    unread_err_numNumber69
  upObject
    ONLINENumber1
    OFFLINENumber0

Dashboard-sysadmin

用户概要

SDK方法名:sysadmin;

URL

/dashboard/user_summary

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] success
  users_numNumber8
  roles_numNumber6
  role_usersArray可能存在新建的角色,不完全枚举3
    labelString审计员auditor
    valueString3
  login_timesObject最近一周的登录次数; 返回周几的顺序,会依据今天是周几做相应的变化
    MonNumberMon33
    TuesNumberTues6
    WedNumberWed7
    ThursNumberThur11
    FriNumberFri88
    SatNumberSat23
    SunNumberSun32

概览 - 总览

SDK方法名:statusOverall;

URL

/dashboard/status_overall

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] success
  info_listObject
    sys_uptimeObject
      time_startNumber0
      time_nowNumber1611720608
    db_node_statusObject
      onlineNumber0
      warnNumber0
      excptNumber0
      unknownNumber0
    node_statusObject
      onlineNumber0
      maintainNumber1
      idleNumber0
      excptNumber2
      unknownNumber0
    real_time_rule_statusArray5
      nameArray["replication","maintain","mirror","stop","unknown"]+1
      sumNumber0+1
      descriptionObject
        repNumber0+1
    db_rule_statusArray5
      nameArray["error","unknown","track","dump","stop"]+1
      sumNumber0
      descriptionObject
        oracleNumber0
        mysqlNumber0
        kafkaNumber0
        gaussNumber0
        sqlserverNumber0
        postgresNumber0
        db2Number0
        qianbaseNumber0
    ha_rule_statusArray5
      nameArray["run","maintain","switch","stop","unknown"]+1
      sumNumber0
      descriptionObject
        haNumber0
    copy_management_statusArray6
      nameArray["wait","maintain","replication","finish","stop","unknown"]+1
      sumNumber0
      descriptionObject
        compl_repNumber0
        snapshot_taskNumber0
    scheduled_rule_statusArray6
      nameArray["replication","maintain","wait","finish","stop","unknown"]+1
      sumNumber0+1
      descriptionObject
        ffoNumber0
        vp_backupNumber0
        vp_moveNumber0
        vp_repNumber0
        backupNumber0+1
    scheduled_rule_stateObject
      successArray[0,0,0,0,0,0,0]
      failArray[0,0,0,0,0,0,0]
      jumpArray[0,0,0,0,0,0,0]
      cancelArray[0,0,0,0,0,0,0]
      timeArray["01-27","01-26","01-25","01-24","01-23","01-22","01-21"]

概览 - 总览 日志

SDK方法名:listOverallLogs;

URL

/dashboard/overall_logs

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
get_allNumber是否获取全部未读消息:
0:否;
1:是;

(默认获取10条)
0

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] success
  abnormal_logsArray异常日志10
    log_typeString信息类型:节点 规则node
    nameString信息内容: 节点或规则名称@name
    addressString信息内容:节点IP192.168.122.100
    statusString该条信息的异常状态OFFLINE
    timeNumber异常状态发生的时间1605506910
    uuidString用于操作,
点击该行,会跳转到对应的规则/节点 日志页面;同时用于标记已读该条信息。
BF202540-A60C-C25D-FA14-7F5AB400AE4D

概览 - 资源管理

SDK方法名:listOverallResourceSta;

URL

/dashboard/overall_resource

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] success
  info_listObject
    nodeObject
      totalNumber3
      onlineNumber0
      maintainNumber1
      unknownNumber0
      offlineNumber2
      windowsNumber1
      linuxNumber2
    dbObject
      totalNumber0
      onlineNumber0
      warnNumber0
      excptNumber0
      unknownNumber0
      oracleNumber0
      mysqlNumber0
      sqlserverNumber0
      kafkaNumber0
    active_nodeObject
      totalNumber0
      onlineNumber0
      maintainNumber0
      idleNumber0
      unknownNumber0
      windowsNumber0
      linuxNumber0
      offlineNumber0
    vir_platObject
      totalNumber0
      onlineNumber0
      maintainNumber0
      unknownNumber0
      hypervNumber0
      vmwareNumber0
      drpNumber容灾平台0
      casNumber0
    cloud_platObject
      totalNumber0
      onlineNumber0
      maintainNumber0
      unknownNumber0
      huaweiNumber0
      awsNumber0
      openstackNumber0
      hwcstackNumber0
    clusterObject
      totalNumber0
      onlineNumber0
      maintainNumber0
      unknownNumber0
      msclusterNumber0
    dto_hostObject
      totalNumber0
      onlineNumber0
      maintainNumber维护0
      unknownNumber0
      windowsNumber0
      linuxNumber0
    storage_poolObject
      offlineNumber离线1
      onlineNumber在线1
      totalNumber2
    copy_volumeObject
      mount_failedNumber挂载失败1
      mountedNumber已挂载1
      onlineNumber在线
      offlineNumber离线
      totalNumber2
    dedupe_poolObject
      offlineNumber离线1
      onlineNumber在线1
      totalNumber2

概览 - 实时数据复制

SDK方法名:listOverallRealTimeCopy;

URL

/dashboard/overall_real_time_copy

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] success
  info_listObject
    repArray5
      nameString@name
      statusStringMIRROR
      wk_node_nameString68.211
      bk_node_nameString68.212
      usernameStringadmin
      band_widthString012345600:00-23:592k
    nasArray6
      nameString@name
      statusStringERROR
      sync_nameString67.111
      wk_node_nameString68.211
      bk_node_nameString68.212
      usernameStringadmin
      band_widthString
    blockArray7
      nameString@name
      statusStringFINISH
      wk_node_nameString68.211
      bk_node_nameString68.212
      usernameStringadmin
      band_widthString

概览 - 应用高可用

SDK方法名:listOverallHa;

URL

/dashboard/overall_ha

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] success
  info_listArray10
    nameString规则名称@name
    rep_nameString复制规则名称test111
    rep_uuidString复制规则ID@uuid
    rep_statusString复制规则状态 正常状态:MIRROR REPLICATION RUN EXECUTING四种,其他未异常MIRROR
    master_nameString主节点名称192.168.28.255
    slave_nameString从节点名称192.168.28.254
    heartbeatNumber心跳线1

概览 - 副本管理

SDK方法名:listOverallCdm;

URL

/dashboard/overall_cdm

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] success
  info_listObject
    fspObject
      takeover_drillObject
        runNumber运行0
        shut_offNumber关机0
        abnormalNumber异常0
      ffo_mountObject
        connectedNumber4
        mounted_sessNumber3
        create_failedNumber2
        unknownNumber0
      compl_repArray6
        nameArray["finish","wait","replication","stop","failed","unknown"]+1
        sumNumber0
    storageObject
      copy_volumeObject
        mountedNumber0
        onlineNumber0
        mount_failedNumber0
      mount_taskObject
        mountedNumber0
        onlineNumber0
        mount_failedNumber0
        unmountedNumber0
      snapshot_taskArray6
        nameArray["finish","wait","snap","stop","stale","unknown"]+1
        sumNumber0

概览 - 系统迁移

SDK方法名:listOverallFspMv;

URL

/dashboard/overall_fsp_mv

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] success
  info_listArray5
    wk_node_nameString0.112
    bk_node_nameString12312qwdasdasd123
    statusStringFFO_MOVING
    progressNumber90

概览 - 节点/复制规则 兼容6.1

SDK方法名:nodeRepSummary;

URL

/dashboard/node_rep_summary

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
summaryString0:不返回复制规则的概要信息; 1:返回复制规则的概要信息;
默认值:1
cacheString0:不返回节点的缓存信息; 1:返回节点的缓存信息; 默认值:0
rep_ruleString0:不返回节点的复制规则信息; 1:返回节点的复制规则信息;
默认值:0
filterString0:不对节点和复制规则做过滤; 1:对节点和复制规则做过滤,如果节点开启 维护模式,返回的结果不包括该节点以及作 为工作机的规则; 默认值:1

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] success
  returnCodeNumber0
  returnMsgString
  timeNumber1617093240
  dateString2021-03-30 16:34:00
  cacheArray
    node_nameString68.212
    data_addrString172.20.68.212
    mem_configNumber1778384896
    mem_usedNumber62914560
    disk_configNumber51036291072
    disk_usedNumber0
    statusStringONLINE
  summaryObject
    REPLICATIONNumber2
    MIRRORNumber0
    STOPNumber0
    STALENumber0
    EXCPTNumber0
    UNKNOWNNumber0
    WAITNumber0
    rep_totalNumber2
  rep_ruleArray2
    rule_nameArray["22","21"]+1
    srcString68.212
    targetString68.212
    statusStringREPLICATION
    latencyObject
      start_timeString2021-03-30 16:33:57
      intervalString10
      rep_uuidArray["7C8F8AF4-F171-A5E0-7BA5-F539C786A200","C9DBA051-9862-AE7F-2B4C-F8A38353B3BB"]+1
      latencyString0
      late_statusStringNODATA

概览 - 虚机概览,获取任务成功率

SDK方法名:listVpRuleStat;

URL

/dashboard/vp_rule

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
typeString规则类型VP_PT
wk_uuidString源平台uuidAC7A5A1F-5BB1-41D6-E075-1648ADC5C60B
modeString模式month yearmonth

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  all_total_numNumber总数49327
  all_success_numNumber总成功数20429
  all_failed_numNumber总失败数15173
  all_cancel_numNumber总取消数0
  all_skip_numNumber总跳过数0
  all_trans_data_numString总传输量208.68 TB
  all_trans_data_num_rawNumber229441978639236
  all_unread_err_numNumber总未读数15173
  total_numNumber当前平台总数0
  success_numNumber当前平台成功数0
  failed_numNumber当前平台失败数0
  cancel_numNumber当前平台取消数0
  skip_numNumber当前平台跳过数0
  trans_data_numString当前平台传输量0 Bytes
  trans_data_num_rawNumber0
  unread_err_numNumber当前平台未读数0
  info_listArray30
    success_numNumber0
    failed_numNumber0
    cancel_numNumber0
    skip_numNumber0
    total_numNumber0
    trans_data_numString0 Bytes
    unread_err_numNumber0
    timeArray["09-19","09-20","09-21","09-22","09-23","09-24","09-25","09-26","09-27","09-28","09-29","09-30","10-01","10-02","10-03","10-04","10-05","10-06","10-07","10-08","10-09","10-10","10-11","10-12","10-13","10-14","10-15","10-16","10-17","10-18"]+1
    trans_data_num_rawNumber0
  all_vp_success_numNumber总虚机成功19789
  all_vp_failed_numNumber总虚机失败15016
  all_vp_other_numNumber总虚机其他数量13116
  all_ffo_success_numNumber总整机成功640
  all_ffo_failed_numNumber总整机失败157
  all_ffo_other_numNumber总整机其他数量609
  all_ffo_trans_data_numString总整机数据量
  all_vp_trans_data_numString总虚机数据量
  all_ffo_unread_err_numString总整机未读错误数
  all_vp_unread_err_numString总虚机未读错误数

概览 - 周期性定时数据复制规则概览

SDK方法名:listSchedule;

URL

/dashboard/schedule_list

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
msgString
retNumber200
dataObject
  messageString
  codeNumber0
  info_listArray2-10
    nameString规则名称@first
    uuidString规则uuid
    wk_nameString虚机/工作机/数据类型@cname
    typeString规则类型(同biz_res_view视图)
    subtypeString规则具体类型(同biz_res_view视图)
    user_uuidString用户uuid
    create_timeString创建时间
    bkup_policyNumber备份策略:
固定为1,表示周期性
    bkup_scheduleArray1-3
      sched_everyNumber备份策略:
0:每天;
1:每周:
2:每月;
3:每隔
@integer(0, 3)
      sched_dayArray哪些天['3','6']
      sched_timeArray哪些时间['13:15', '25:61']
      backup_typeString备份类型:
o:全备;
i:增量;
d:差异;
m:合成;
c:CBT;
@pick('o', 'i', 'd', 'm', 'c')
      sched_gap_minString间隔时间
      sched_time_startString开始时间
  totalNumber总数

展示列 - 新建|修改

SDK方法名:createColumnExt;

URL

/column_list

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
typeString复制规则-普通:rep
复制规则-集群:cls_rep
复制规则-ASM:asm_rep
块复制:dtrack_backup
块复制组:dtrack_group
虚机备份:vp_backup
虚机迁移:vp_move
虚机复制:vp_rep
虚机恢复:vp_rc
虚机演练:vp_or
list_colObject
  nameObject默认展示列:类型不同有所不同,具体字段参考展示列-单个接口的返回
    displayNumber1
    widthNumber80
  wk_ipObject
    displayString1
    widthString100
  bk_ipObject
    displayString1
  cdp_switchObject
    displayString1

Response

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

展示列 - 单个

SDK方法名:describeColumnext;

URL

/column_list

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
typeString参考新建

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject如果没有设置过则返回默认+可自定义列
  codeNumber0
  messageString
  user_uuidString1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
  typeStringrep
  list_col_defaultArray默认展示列,用户无法取消勾选
    nameStringwk_ip
    displayString1
    widthString80
  list_col_extArray用户可设置列
    nameStringbk_node_name
    displayString0
    widthString空字符串表示界面使用默认定义宽度''
  list_colObject
    bk_node_nameString默认展示列11
    wk_ipString0

导出规则

SDK方法名:exportRules;

URL

/export_rules

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
suffixStringcsv, xlsx
typeString数据库同步模块:
Oracle同步:oracle
Mysql:mysql
Sqlserver:sqlserver
postgresql:postgres
DB2:db2
DM:dm
Kafka:kafka
qianbase:qianbase
oceanbase:oceanbase
tidb:tidb
informix:informix
mongodb;mongo
Oracle对象比较:oracle_obj_cmp
Oracle对象修复:oracle_obj_fix
Oracle表比较:oracle_tb_cmp
数据检查:datacheck

复制规则:rep_backup;
恢复恢复:rep_recovery;

NAS:nas;
比较与同步:compare;
块复制:dtrack_backup;
块复制组:dtrack_group;
高可用:availability;
高可用组:ha_group;

整机备份、CDM复制、业务迁移:fsp;
整机恢复、CDM恢复:fsp_recovery;

定时备份:timing_backup;
定时还原:timing_recovery;

虚机备份:vp_backup;
虚机复制:vp_rep;
虚机迁移:vp_move;
虚机恢复:vp_recovery;

dto对象存储/比较与同步:dto_rule;

大数据备份:bigdata_backup;
大数据还原:bigdata_recovery;

整机CDM - 接管、演练: cdm_rule;

// 以下为资源
节点:node;
sub_typeString文件复制:
普通复制规则:0;
集群复制规则:1;
ASM复制规则:2;

文件恢复:
即时恢复:0;
cdp恢复:1;
快照恢复:2;

整机保护、CDM(备份):
整机备份:3;
CDM复制:8;
业务迁移:1;

整机保护、CDM(恢复):
整机恢复:不传,默认为整机恢复;
CDM恢复:9;

dto对象存储:0;
dto比较同步:2;

// 以下为资源
uuidsArray选中的规则uuid,默认为[]导出所有[]
where_argsArray
  timing_typeString普通定时任务:0;
集群定时任务:1;
  raw_uuidString比较与同步主任务uuid
for_importNumber0:统计导出;(默认值)
1:全字段导出(为了导入的)
0

Response

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

导入规则

SDK方法名:importRules;

URL

/import_rules

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
typeString参考导出规则
fileString

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] success
Last update: 11/18/2022, 3:56:21 PM
Contributors: ganl