大屏展示

February 26, 2024About 19 min

大屏展示

SDK类名:/common/BigScreen;

大屏展示 - 新建

SDK方法名:createBigScreen;

URL

/big_screen

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
rule_nameString规则名称
rule_typeNumber规则类型:
0-大数据大屏
1-容灾大屏
2-备份大屏
0
configObject设计模块的配置信息,预留字段
commentString说明
logo_nameString默认:I2Infomation2,如果用户上传logo则为logo名称
注:上传接口上传的logo名称跟该处的不一致会上传失败
I2Infomation2

Response

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

大屏展示 - 修改

SDK方法名:modifyBigScreen;

URL

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

Method

PUT

Request

名称类型必选简介Mock初始值Mock规则
rule_nameString
commentString
logo_nameString
random_strString

Response

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

大屏展示 - 单个

SDK方法名:describeBigScreen;

URL

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

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  messageString
  codeNumber0
  big_screenObject
    rule_nameString@cname
    rule_typeNumber@pick([0, 1, 2, 3])
    rule_uuidString@uuid
    configObject
    random_strString
    commentString@cparagraph
    logo_nameString@name

大屏展示 - 列表

SDK方法名:listBigScreen;

URL

/big_screen

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
dataObject
  info_listArray
    rule_uuidString@pick(["0DD4E727-70AB-62C6-BEB5-D012DFAE46E3", "0DD4E727-70AB-62C6-BEB5-D012DFAE46E4"])
    rule_nameString@pick(["kevin", "Jane", "Grey"])
    rule_typeNumber@pick([0, 1, 2, 3])
    commentString@cparagraph()
    usernameString@pick(["admin", "user", "super"])
    can_opNumber1
    can_delNumber1
    can_upNumber1
  totalNumber100
  countNumber10
  codeNumber0
  messageString
retNumber200
msgString

大屏展示 - 删除

SDK方法名:deleteBigScreen;

URL

/big_screen

Method

DELETE

Request

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

Response

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

大屏展示 - logo上传

SDK方法名:uploadBigScreenLogo;

URL

/big_screen/logo

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
logo_fileStringlogo文件,base64加密
logo_nameStringlogo文件名

Response

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

大屏展示 - logo删除

SDK方法名:deleteBigScreenLogo;

URL

/big_screen/logo

Method

DELETE

Request

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

Response

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

大屏展示-logo列表

SDK方法名:listBigScreenLogo;

URL

/big_screen/logo_list

Method

GET

Request

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

Response

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

大屏展示 - 更新配置

SDK方法名:configBigScreen;

URL

/big_screen/config

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
typeNumber0-保存到临时配置,用于大屏预览
1-保存到config,用于大屏展示
rule_uuidString大屏规则uuid
configArray大屏规则配置信息2
  mod_typeString【通用设置】模块类型:

【通用】
data_stat:置顶数据流量统计
【大数据】【容灾】
rule_graph:(实时)规则拓扑图
【大数据备份】
traffic_delay:实时流量/事物延时
【大数据】【容灾】【备份】
node_status:节点状态
【大数据】
db_status: 数据库状态
【大数据】
rule_status: 规则状态
【大数据备份】
cpu_mem:CPU/内存消耗
【大数据备份】
sync_table_obj:已同步的表/对象
【大数据备份】
daily_sync_op:今日同步操作
【容灾】【备份】
node_group_stat: 节点分组统计
daily_warn: 今日告警数
【容灾】【大数据】
daily_warn: 今日告警数
sys_runtime: 系统正常运行时间
【容灾】
node_group_stat: 节点分组统计
ha_status: HA规则状态统计
rep_status: 实时复制规则状态统计
traffic_ranking: 24小时流量排名
【容灾可选】
ha_graph: 高可用规则拓扑图
rep_delay_traffic: 24小时复制延时和流量图
【备份】
backup_status: 备份状态统计
backup_result_stat: 备份结果统计
vm_protect_rate: 虚机保护率统计
bk_resource_usage: 灾备机资源使用情况
backup_data_growth_trend_monthly: 备份数据量月增长趋势
backup_data_growth_trend_daily: 备份数据量日增长趋势
backup_node_resource_useage_top10:灾备节点资源占用Top10
data_stat
  titleArray【通用设置】标题:界面自定义
  locationNumber【通用设置】位置:界面自定义,用于模块排序
  graph_numNumber【大数据-规则拓扑图】
【容灾-实时规则拓扑图】
拓扑图数量:1/2/4

【容灾-高可用规则拓扑图】
拓扑图数量:1/2
4
  scroll_limitNumber【滚屏】间隔
【大数据-规则拓扑图】
【大数据-实时流量/事物延时】
【容灾-实时规则拓扑图】
【容灾-24小时复制延时和流量图】
【容灾-高可用规则拓扑图】
默认20
【大数据-CPU/内存消耗】
【大数据-已同步的表/对象】
【容灾-节点分组统计】
【备份-容灾节点分组统计】
默认15
20
  rule_uuidsArray【大数据-规则拓扑图】
【大数据-实时流量/事物延时】
【大数据-节点状态/数据库状态/规则状态】
【大数据-已同步的表/对象】
【大数据-今日同步操作】
【容灾-实时规则拓扑图】
【容灾-24小时复制延时和流量图】
【容灾-高可用规则拓扑图】
【容灾-HA规则状态统计】
【容灾-实时复制规则状态统计】
【容灾-实时复制规则24小时流量排名】
选定规则uuid
  node_uuidsArray【大数据-节点状态/数据库状态/规则状态】
【大数据-CPU/内存消耗】
【容灾-节点状态统计】
【备份-灾备节点资源占用Top10】
【备份-容灾节点状态统计】
【备份-灾备机资源使用情况】
选定的节点uuid
  db_uuidsArray【大数据-节点状态/数据库状态/规则状态】
选定的数据库uuid
  warn_limitNumber【大数据-CPU/内存消耗】
告警阈值
  node_group_uuidsArray【容灾-节点分组统计】
【备份-容灾节点分组统计】
选定的节点组uuid
  stat_daysNumber【备份-备份数据量日增长趋势】
配置统计的时间范围,30天/60天/90天/180天
【备份-备份数据量月增长趋势】
选择统计近180/360/720天的备份数据量,即6/12/24个月的数据量
【备份-备份结果统计】
配置统计的时间范围,1天/2天/3天/1周/1月
  warn_modulesArray【容灾-今日告警数】
res: 资源管理
rule: 文件复制
nas: NAS文件复制
ha: 应用高可用
【备份-今日告警数】
res: 资源管理
rule: 文件复制
fsp: 整机保护
cdm: 副本管理
vp: 虚拟化支持
timing:应用保护
storage:存储监控
  stat_modulesArray【备份-备份数据量日增长趋势】
【备份-备份数据量月增长趋势】
实时数据复制→复制规则-rep_backup
整机保护→整机备份-fsp_backup
虚拟化支持→虚机备份-vp_backup
应用保护→备份-timing_backup
副本管理→整机CDM→整机复制-cdm_rep
【备份-备份状态统计】
应用保护-backup
整机保护-ffo
云容灾-cloud_backup
虚拟化支持-vp
整机复制-compl_rep
【备份-备份结果统计】
定时备份-bak_bk
定时还原-bak_rc
整机保护-ffo
整机CDM-sys_cdm
虚拟化支持-vp
DTO管理-dto
云容灾-sys_cloud
大数据-bb
  vp_uuidsArray【备份-虚机保护率统计】
选择统计保护率的虚机(默认为统计全部平台,用户自行选择统计的虚拟平台)
  displayString【通用】
0-隐藏
1-显示

Response

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

大屏展示 - 获取配置

SDK方法名:describeBigScreenConfig;

URL

/big_screen/config

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
typeNumber0-大屏预览
1-大屏展示
rule_uuidString大屏规则uuid

Response

名称类型必选简介Mock初始值Mock规则
msgString
retNumber200
dataObject
  messageString
  codeNumber0
  logo_fileStringlogo名称
  logo_nameStringlogo图片(base64加密后字符串)
  configArray
    mod_typeStringdata_stat
    titleString
    locationNumber1
    clear_dataNumber1
    graph_numNumber4
    scroll_limitNumber20
    rule_uuidsArray
    node_uuidsArray
    db_uuidsArray
    warn_limitNumber1
    page_limitNumber1
    warn_runtimeNumber1
    node_group_uuidsArray
    warn_modulesArray
    stat_daysNumber1
    stat_modulesArray
    vp_uuidsArray

大屏展示 - 清零

SDK方法名:clearBigScreenStatData;

URL

/big_screen/clear_data

Method

POST

Request

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

Response

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

大屏展示 - 获取规则

SDK方法名:listBigScreenStatRules;

URL

/big_screen/rules

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
rule_uuidString大屏展示规则uuid
mod_typeString大屏展示模块名
typeString节点-node
规则-rule
数据库-db
虚拟平台-vp
节点组-node_group
DTO节点-dto_host

Response

名称类型必选简介Mock初始值Mock规则
msgString
retNumber200
dataObject
  codeNumber0
  messageString
  info_listArray
    uuidString节点/数据库/规则 的 uuid@pick(["0DD4E727-70AB-62C6-BEB5-D012DFAE46E3", "0DD4E727-70AB-62C6-BEB5-D012DFAE46E4"])
    nameString节点/数据库/规则 的 名称@pick(["kevin", "Jane", "Grey"])
  totalNumber100

大屏展示-统计数据

SDK方法名:describeBigScreenStat;

URL

/big_screen/stat

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
rule_uuidString【必选】大屏规则uuid
mod_typeString【通用设置】模块类型:

【通用】
data_stat:置顶数据流量统计
【大数据】【容灾】
rule_graph:(实时)规则拓扑图
【大数据】
traffic_delay:实时流量/事物延时
【大数据】【容灾】【备份】
node_status:节点状态
【大数据】
db_status: 数据库状态
【大数据】
rule_status: 规则状态
【大数据】
cpu_mem:CPU/内存消耗
【大数据】
sync_table_obj:已同步的表/对象
【大数据】
daily_sync_op:今日同步操作
【容灾】【备份】
node_group_stat: 节点分组统计
daily_warn: 今日告警数
【容灾】【大数据】
daily_warn: 今日告警数
sys_runtime: 系统正常运行时间
【容灾】
node_group_stat: 节点分组统计
ha_status: HA规则状态统计
rep_status: 实时复制规则状态统计
traffic_ranking: 24小时流量排名
【容灾可选】
ha_graph: 高可用规则拓扑图
rep_delay_traffic: 24小时复制延时和流量图
【备份】
backup_status: 备份状态统计
backup_result_stat: 备份结果统计
vm_protect_rate: 虚机保护率统计
bk_resource_usage: 灾备机资源使用情况
backup_data_growth_trend_monthly: 备份数据量月增长趋势
backup_data_growth_trend_daily: 备份数据量日增长趋势
backup_node_resource_useage_top10:灾备节点资源占用Top10

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  statObject
    statusObject【节点/节点组/数据库/规则】
状态统计
      dbsObject数据库
        normalNumber在线12
        warnNumber警告12
        abnormalNumber异常12
        unknownNumber未知12
      nodesObject节点
        onlineNumber在线【大数据】【容灾】12
        offlineNumber离线【大数据】【容灾】12
        inactiveNumber闲置【大数据】12
        unknownNumber未知【大数据】12
        maintainString维护【容灾 】12
      node_groupsArray节点组
        group_nameString节点组名称
        onlineNumber在线
        offlineNumber离线
        maintainNumber维护
      rulesObject规则
        errorNumber错误【大数据】12
        unknownNumber未知【大数据】【备份状态统计】【HA规则】【实时复制规则状态统计】12
        trackNumber增量【大数据】12
        dumpNumber全量【大数据】12
        stopNumber停止【大数据】【实时复制规则状态统计】【备份状态统计】12
        replicationNumber复制【实时复制规则状态统计】【备份状态统计-备份中】12
        maintainNumber维护【实时复制规则】【HA规则】【备份状态统计】12
        mirrorNumber镜像【实时复制规则状态统计】12
        runNumber运行【HA规则】12
        switchNumber切换【HA规则】12
        warnNumber警告【HA规则】12
        finishNumber完成【备份状态统计】12
        waitNumber等待【备份状态统计-排队中】12
        successNumber成功【备份结果统计】12
        failNumber失败【备份结果统计】12
        cancelNumber取消【备份结果统计】12
        jumpNumber跳过【备份结果统计】12
      dto_hostObjectDTO主机
        onlineNumber在线
        offlineNumber离线
        maintainNumber维护
      dto_rulesObjectDTO规则
        idleNumber空闲
        replicationNumber同步
        finishNumber完成
        excptNumber异常
        unknownNumber未知
        stopNumber停止
    total_syncNumber【置顶数据量统计模块】今日同步数据量123321
    daily_syncNumber【置顶数据量统计模块】已同步数据总量1233
    daily_warnNumber【今日告警数】12
    cpu_memArray【CPU/内存消耗】
      cpu_usedNumbercpu消耗 界面显示85%12
      mem_usedNumber内存消耗 界面显示63%12
      node_nameString节点名称nn
      node_uuidString节点uuid
    sys_uptimeObject【系统正常运行时间】参考总览
      time_nowNumber当前时间1655254743
      time_startNumber开始时间430422.721970411
    daily_sync_opObject【今日同步操作】
      irpNumberIRP-插入单行123
      urpNumberURP-更新行123
      drpNumberDRP-删除单行123
      ddlNumberDDL123
    sync_table_objArray【已同步的表/对象】
      sync_tableNumber已同步表199
      sync_objNumber已同步对象10
      rule_nameString规则名称规则1
    traffic_rankingArray【24小时流量排名】
      rule_nameString规则名称
      trafficNumber数据量 单位-byte
    backup_data_growth_trend_dailyObject【备份数据量日增长趋势】
      dateArray日期:年月日["2022-06-15", "2022-06-16"]
      backup_timeArray备份时长[30, 30]
      dataArray备份数据量[1212, 121212]
    vm_protect_rateObject【虚机保护率统计】
      vm_protectedNumber已保护
      vm_totalNumber总数
    backup_data_growth_trend_monthlyArray【备份数据量月增长趋势】
      dateArray日期:年月["2022-06", "2022-07"]
      dataArray备份数据量[1212, 121212]
    bk_resource_usageArray【灾备节点资源占用Top10】
      node_nameString节点名称1
      statusString状态online
      config_addrString节点地址(管理地址)172.20.68.213
      totalString总容量85304799232
      freeString剩余空间57359777792
    bk_resource_totalNumber【灾备机资源使用情况】管理灾备机总量
    bk_resource_freeNumber【灾备机资源使用情况】管理灾备机剩余

大屏展示-拓扑图

SDK方法名:listBigScreenGraph;

URL

/big_screen/graph

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
rule_uuidString大屏规则uuid
rule_uuidsArray拓扑图规则uuid数组
mod_typeString

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  infoObject
    active|rulehadtoArrayactive-数据库拓扑图
rule-实时复制拓扑图
ha-高可用拓扑图
dto-dto规则拓扑图
每种规则的流量图含义不同,具体的流量图含义参考对应规则的流量图,如大数据大屏的流量图可参考数据库复制概览界面
      dstObject【active-数据库拓扑图】
        dbObject
          nameString222
          statusStringdb_normal
          stateNumber0
        nodeArray
          nameString172.20.73.222
          stateStringok
          statusStringnode_online
      srcObject【active-数据库拓扑图】
        dbObject
          nameString221
          statusStringdb_normal
        nodeArray
          nameString172.20.73.221
          stateStringok
          statusStringnode_online
      summaryObject【active-数据库拓扑图】
        rule_typeStringoracle
        nameString4563
        extractString2022-06-15 08:40:56
        loadString2022-06-15 08:40:56
        delayString771ms
        stateNumber0
        stageStringtrack
        tarDbNameString222
        srcDbNameString221
        bytesString33.5KB
        uuidStringCF94EBCE-8796-17A3-47E9-7A4120609E43
        wStageStringtrack
        tStageStringtrack
        rStageStringtrack
        peakString771ms
        compressString100.00%
        bStageStringtrack
        maxNodeCntNumber1
        statusStringrect_normal
      wk_nodeObject【rule-实时复制拓扑图】
【ha-高可用规则拓扑图】
        node_nameString节点名称
        config_addrString管理地址
        statusString状态
        arbitrate_statusString仲裁状态
        heartbeat_statusString心跳线状态
      bk_nodeObject【rule-实时复制拓扑图】
【ha-高可用规则拓扑图】
        node_nameString
        config_addrString
        statusString
        arbitrate_statusString
        heartbeat_statusString
      ruleObject【rule-实时复制拓扑图】
        rule_nameString规则名称
        statusString状态
        trafficNumber流量
        latencyNumber延时
      haObject【ha-高可用规则拓扑图】
        nameString规则名称
        rulesObject关联的复制规则
          rule_nameString规则名称
          statusString状态
          trafficString流量
          latencyString延时
        arbitrationObject仲裁设置
          nodeArray仲裁节点信息-支持多个
            arbit_addrString仲裁节点地址
            arbit_portString仲裁节点端口
            arbit_protocolString仲裁节点使用协议
          radioNumber仲裁设置:
0-不设置
1-节点仲裁
2-磁盘仲裁
        heartbeatArray心跳线
          ifconfigArray
            ipString172.20.68.211
            labelStringEthernet0
            netifString{44FB5E10-DF89-433D-BADD-A136F8206C6F}
            uuidString989AB32B-43A2-BA4B-616D-45E103CE10A7
          intervalString2
          ipListString172.20.68.211_172.20.68.212
          maxfailString172.20.68.211_172.20.68.212
          paramsString检测间隔(/秒):2;最大失败次数:5
          portString26850
          protocolStringtcp
        statusString高可用规则状态
      dtoObject【dto-DTO规则拓扑图】
        rule_nameString规则名称
        statusString规则状态
    rep_delay_trafficArray
      rule_nameString规则名称
      rule_uuidString规则uuid
      trafficNumber当前速率
      latencyNumber当前延时
      trafficsArray流量数据,响应数据同复制规则流量图接口的traffics字段一致:https://apiref.info2soft.com/organization/repository/editor?id=18&mod=64&itf=206
Last update: 2/26/2024, 5:49:44 PM
Contributors: ganl