i2UP接口文档

# 平台监控

SDK类名：/upmonitor/UpMonitor;

  1. 产品名称：英方统一监控管理平台
  2. 总控制机：监控管理平台
  3. 子控制机：数据管理平台

# 子平台 - 认证

SDK方法名：authUpMonitor

# URL

//up_monitor/auth

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
ip String 否 172.20.2.70 子平台接口ip
port String 否 58086 子平台接口port
access_key String 否 oishvmn5YPHJcEDaIjtwd0R9Ug7BN1fk 能绑定子平台用户的一个密钥
secret_key String 否 fkLiyqsG3P1AzB5jWtYbZa7TU8RN9wSVhe6EldOo 签名key

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] success
  up_uuid String 否 子平台cc_uuid

# 子平台 - 获取子平台token

SDK方法名：describeUpMonitorToken

# URL

//up_monitor/token

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
up_uuid String 否 CE753C48-96F9-6C38-C3DE-A25E7405D03F uuid

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否
  token String 否 aa95663edea9f799049a50d706250767a0a5d06b
  sso_token String 否 c145aa4873972b19gWmhnGvfGbprR3xF1j1NJoDHKCFrYyMuzuE2vH8QMvIRa4kivVvNjbyEYtBUfBs0zdAKaJSAP6Mf8YJa8cbFA5L0NJcO45O51kbdBuVhImL_PLBPg9myD9TEvHNdCIQEtG1LSTjbktW_hngowTei7w
  refresh_token String 否 5f77393082397d90v5z_Qp7ArjrZCA_E6mrZnHNaQay3-TWnNyEsd1o41jDbxYEp45EPkrp_OlivpeoHYqiihmLjuGvk9CPk3sZRyU7_kj5AAsVu199paV-yWi8k-Q6qoMK7lU9i_VRh5Zxl6lB45eTESnXWeGBjMDWxnw

# 子平台 - 新建

SDK方法名：createUpMonitor

# URL

//up_monitor

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
up_name String 否 就这个控制机 名称
up_uuid String 否 CE753C48-96F9-6C38-C3DE-A25E7405D03F 子平台cc_uuid
ip String 否 172.20.2.70 子平台接口ip
port String 否 58086 子平台接口port
access_key String 否 oishvmn5YPHJcEDaIjtwd0R9Ug7BN1fk 能绑定子平台用户的一个密钥
secret_key String 否 fkLiyqsG3P1AzB5jWtYbZa7TU8RN9wSVhe6EldOo 签名key
comment String 否 备注xxx 备注
biz_grp_list Array 否 业务分组

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] success

# 子平台 - 修改

SDK方法名：modifyUpMonitor

# URL

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

# Method

PUT

# Request

名称 类型 必选 初始值 简介 Mock规则
up_name String 否 就这个控制机
access_key String 否 oishvmn5YPHJcEDaIjtwd0R9Ug7BN1fk
secret_key String 否 fkLiyqsG3P1AzB5jWtYbZa7TU8RN9wSVhe6EldOo
ip String 否 172.20.2.70
port String 否 58086
comment String 否 备注xxx
biz_grp_list Array 否
random_str String 否 11111111-1111-1111-1111-111111111111

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] success

# 子平台 - 获取单个

SDK方法名：describeUpMonitor

# URL

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

# Method

GET

# Request

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

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] success
  up_monitor Object 否
    up_name String 否 test
    up_uuid String 否 93AF0C9F-14C8-41A2-31CB-AAA0F65193FA
    up_type Number 否 0
    ip String 否 192.168.72.70
    port String 否 58086
    access_key String 否 123123 假值
    secret_key String 否 123123 假值
    comment String 否 test
    biz_grp_list Array 否 ['93AF0C9F-14C8-41A2-31CB-AAA0F65193FA']
    random_str String 否 93AF0C9F-14C8-41A2-31CB-AAA0F65193FA
    create_time Number 否 0
    update_time Number 否 0
    user_uuid String 否
    username String 否
    status String 否 ONLINE / OFFLINE
    node_info Object 否
      drivers_info Object 否 内容为 监控 - 磁盘信息 的data（URL为/monitor/drivers_info/:uuid）
      phy_info Object 否 内容为 监控 - 当前硬件信息 的data（URL为/monitor/phy_info/:uuid）
      chart_data Object 否 内容为 监控 - 图表数据 的data（URL为/monitor/chart_data/:uuid）
    dashboard Object 否
      overall Object 否 内容为 Dashboard 接口返回的data（URL为 /dashboard/overall）
      vp_vm Object 否 内容为 Dashboard 接口返回的data（URL为 /dashboard/vp_vm）除了info_list图表数据
      vp_rule Object 否 内容为 Dashboard 接口返回的data（URL为 /dashboard/vp_rule）除了info_list图表数据

# 子平台 - 获取列表

SDK方法名：listUpMonitor

# URL

//up_monitor

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
limit Number 否 10 可选，不传就是全部
page Number 否 1 可选，不传就是全部

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功。
  info_list Array 否
    username String 否 admin
    up_name String 否 就这个控制机
    up_uuid String 否 CE753C48-96F9-6C38-C3DE-A25E7405D03F
    ip String 否 192.168.72.70
    port String 否 58086
    comment String 否 备注xxx
    update_time Number 否 1553849308
    status String 否 ONLINE
    dashboard Object 否
      overall Object 否
        code Number 否 0
        message String 否 [0] success
        node_num Number 否 21
        rep_num Number 否 12
        ha_num Number 否 2
        node Object 否
          UNKNOWN Number 否 17
          OFFLINE Number 否 0
          ONLINE Number 否 4
        rep Object 否
          UNKNOWN Number 否 4
          FINISH Number 否 0
          STOP Number 否 3
          REPLICATION Number 否 4
          MIRROR Number 否 0
          EXCEPTION Number 否 0
          STALE Number 否 1
          SWITCH Number 否 0
          WAIT Number 否 0
          EXECUTING Number 否 0
          IDLE Number 否 0
          DEAD Number 否 0
        ha Object 否
          master_status Object 否
            HA_UNKNOWN Number 否 0
            HA_STOP Number 否 0
            HA_START Number 否 0
            HA_RUN Number 否 2
            HA_MIRROR Number 否 0
            HA_READY Number 否 0
            HA_WARN Number 否 0
            HA_FAIL Number 否 0
          master_role Object 否
            HA_UNKNOWN Number 否 0
            HA_UNJOIN Number 否 0
            HA_MASTER Number 否 2
            HA_SLAVE Number 否 0
            HA_PREOVER Number 否 0
            HA_POSTOVER Number 否 0
            HA_PREBACK Number 否 0
            HA_POSTBACK Number 否 0
            HA_SWITCH Number 否 0
      vp_vm Object 否
        code Number 否 0
        message String 否 [0] success
        vm_protected Number 否 0
        vm_total Number 否 0
      vp_rule Object 否
        code Number 否 0
        message String 否 [0] success
        all_total_num Number 否 167
        all_trans_data_num String 否 45.31 GB
        all_success_num Number 否 32
        all_unread_err_num Number 否 135
        total_num Number 否 94
        trans_data_num String 否 35.76 GB
        success_num Number 否 25
        unread_err_num Number 否 69
  total Number 否 1

# 子平台 - 操作

SDK方法名：refreshUpMonitor

# URL

//up_monitor/operate

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
up_uuids Array 否 ["CE753C48-96F9-6C38-C3DE-A25E7405D03F"]
operate String 否 refresh refresh

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] success

# 子平台 - 状态

SDK方法名：listUpMonitorStatus；

# URL

//up_monitor/status

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
up_uuids Array 否 ["CE753C48-96F9-6C38-C3DE-A25E7405D03F"]

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功
  status Array 否
    up_uuid String 否 9c420cF9-8EA2-2b5F-cDB4-A5680bC3E9D2
    status String 否 ONLINE
    node_info Object 否 和获取单个/列表的一样
    dashboard Object 否 和获取单个/列表的一样
    update_time Number 否

# 子平台 - 删除

SDK方法名：deleteUpMonitor；

# URL

//up_monitor

# Method

DELETE

# Request

名称 类型 必选 初始值 简介 Mock规则
up_uuids Array 否 ["CE753C48-96F9-6C38-C3DE-A25E7405D03F"]

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功
Last Updated: 12/3/2019, 3:27:53 PM