i2UP接口文档

# 集群管理

SDK类名：/resource/Cluster;

# 1准备-1 集群认证

SDK方法名：authCls

# URL

//cls/auth

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
cls_is_local Number 否 1 是Cluster本身的地址
os_pwd String 否 info2soft_125 对应账户密码(RSA加密)
os_user String 否 i2test2018.com\administrator 操作系统账户
config_addr String 否 192.168.87.14 I2应用IP地址
config_port Number 否 26821 管理接口端口，默认值为26821

# Response

名称 类型 必选 初始值 简介 Mock规则
msg String 否 @mock=
data Object 否
  cls_node_list Array 否 2
    cls_node_name String 否 cluster-node1 @mock=cluster-node1
    cls_node_status Number 否 0 @mock=0, -1：unknown；0：up；1：down；2：pause；3：joining
  hd_list Array 否 ['C:','E:','F:','G:'] @mock=['C:','E:','F:','G:']
  message String 否 [0] success @mock=[0] success
  work_node_list Array 否 5
    node_name String 否 192.168.81.145 @mock=192.168.81.145
    node_uuid String 否 F3BD4350-B7B2-4EB4-DC0F-DB39AC1CEFC0 @mock=F3BD4350-B7B2-4EB4-DC0F-DB39AC1CEFC0
  cls_name String 否 cluster-2018 @mock=cluster-2018
  code Number 否 0 @mock=0
ret Number 否 200 @mock=200

# 1准备-2 集群节点验证

SDK方法名：verifyClsNode

# URL

//cls/node_verify

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
node_uuid String 否 BD7D3EF7-2F75-E2BB-A2CB-CFE936CF1F6C 节点uuid，不是集群id，是集群所用【普通节点】的id；
cls_name String 否 cluster-2018 集群名
cls_node_name String 否 cluster-node1 节点计算机名

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200 @mock=200
data Object 否
  node_name String 否 117.128 @mock=117.128, 节点名称
  node_uuid String 否 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 节点uuid
  config_addr String 否 @pick(["192.168.74.25", "192.168.71.252", "192.168.6.15"]) @mock=@pick(["192.168.74.25", "192.168.71.252", "192.168.6.15"]), 管理接口地址
  message String 否
  code Number 否 @pick([0,1]) @mock=@pick([0,1])
  version String 否 6.1-17516 @mock=6.1-17516, 节点所安装的版本
msg String 否 @mock=

# 2编辑/新建-1 新建集群

SDK方法名：createCls

# URL

//cls

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
cls Object 否 节点对象表单
  comment String 否 备注
  cls_disk Array 否 ["E:\"] 集群共享磁盘列表
  config_port String 否 26821 管理接口端口
  cls_node Array 否 ["BD7D3EF7-2F75-E2BB-A2CB-CFE936CF1F6C"] 集群节点列表
  node_type Number 否 1 集群类型，1: win集群
  cls_is_local Number 否 1 是Cluster本身的地址
  os_user String 否 i2test2018.com\administrator 操作系统账户
  config_addr String 否 192.168.74.25 管理接口地址
  node_name String 否 cls 集群名称

# Response

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

# 2编辑/新建-2 获取单个集群

SDK方法名：describeCls

# URL

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

# Method

GET

# Request

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

# Response

名称 类型 必选 初始值 简介 Mock规则
msg String 否 @mock=
data Object 否
  code Number 否 0 @mock=0
  cls Object 否 , 节点对象表单
    cls_is_local Number 否 0 @mock=0, 是Cluster本身的地址
    cls_disk Array 否 , 集群共享磁盘列表
    node_uuid String 否 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 节点uuid
    node_name String 否 aaaa @mock=aaaa, 集群名称
    os_user String 否 , *操作系统账户
    comment String 否 @mock=, 备注
    node_type Number 否 1 @mock=1, 集群类型，1: win集群
    config_port String 否 26821 @mock=26821, 管理接口端口
    cls_node Array 否 , 集群节点列表
    config_addr String 否 192.168.74.25 @mock=192.168.74.25, 管理接口地址
  message String 否
ret Number 否 200 @mock=200

# 2编辑/新建-3 修改集群

SDK方法名：modifyCls

# URL

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

# Method

PUT

# Request

名称 类型 必选 初始值 简介 Mock规则
cls Object 否
  comment String 否
  cls_disk Array 否 ["E:\"]
  config_port String 否 26821
  cls_node Array 否 ["BD7D3EF7-2F75-E2BB-A2CB-CFE936CF1F6C"]
  node_type Number 否 1
  cls_is_local Number 否 1
  os_user String 否 i2test2018.com\administrator
  config_addr String 否 192.168.74.25
  node_name String 否 cls
  random_str String 否 11111111-1111-1111-1111-111111111111

# Response

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

# 3列表-1 获取集群列表（基本信息）

SDK方法名：listCls；

获取列表详细入参说明详见【节点管理-获取节点列表】接口说明；

# URL

//cls

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
limit Number 否 , 可选，不传就是全部
search_value String 否 , 可选，搜索字段对应值（可以模糊）
search_field String 否 , 可选，搜索字段
page Number 否 , 可选，不传就是全部

# Response

名称 类型 必选 初始值 简介 Mock规则
data Object 否
  info_list Array 否 10
    node_name String 否 @pick(["Smith", "Will", "Dode"]) @mock=@pick(["Smith", "Will", "Dode"]), *节点名称
    config_addr String 否 @pick(["192.168.74.25", "192.168.71.252", "192.168.6.15"]) @mock=@pick(["192.168.74.25", "192.168.71.252", "192.168.6.15"]), *管理接口地址
    node_uuid String 否 @pick(["0DD4E727-70AB-62C6-BEB5-D012DFAE46E3", "0DD4E727-70AB-62C6-BEB5-D012DFAE46E6","0DD4E727-70AB-62C6-BEB5-D012DFAE46E1"]) @mock=@pick(["0DD4E727-70AB-62C6-BEB5-D012DFAE46E3", "0DD4E727-70AB-62C6-BEB5-D012DFAE46E6","0DD4E727-70AB-62C6-BEB5-D012DFAE46E1"]), 节点uuid
    node_type Number 否 1 @mock=1, 节点类型，1: win集群
    username String 否 @pick(["admin", "user"]) @mock=@pick(["admin", "user"]), 节点所有者
  code Number 否 0 @mock=0
  message String 否
  total Number 否 100 @mock=100, 总数
  count Number 否 10 @mock=10, 数量
msg String 否 @mock=
ret Number 否 200 @mock=200

# 3列表-4 集群操作

SDK方法名：clsDetail

# URL

//cls/operate

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
operate String 否 detail detail：获取详情
node_uuid String 否 11111111-1111-1111-1111-111111111111 节点uuid

# Response

名称 类型 必选 初始值 简介 Mock规则
data Object 否
  code Number 否 0 @mock=0
  cls_name String 否 cluster_2018 @mock=cluster_2018, 集群名
  message String 否 success @mock=success
  resources Array 否 9
    status Array 否 [2,2,2,2,2,2,2,2,2] @mock=$order(2,2,2,2,2,2,2,2,2), -1 ~ 4, 128 ~ 130, 具体对应这里写不下 +1
    group Array 否 ['cluster-2018Dtc','cluster-2018Dtc','cluster-2018Dtc','cluster-2018Dtc','群集组','cluster-2018Dtc','可用存储','群集组','群集组'] @mock=$order('cluster-2018Dtc','cluster-2018Dtc','cluster-2018Dtc','cluster-2018Dtc','群集组','cluster-2018Dtc','可用存储','群集组','群集组') +1
    type Array 否 ['Network Name','Info2Soft Connection Resource','IP Address','Distributed Transaction Coordinator','IP Address','Physical Disk','Physical Disk','Physical Disk','Network Name'] @mock=$order('Network Name','Info2Soft Connection Resource','IP Address','Distributed Transaction Coordinator','IP Address','Physical Disk','Physical Disk','Physical Disk','Network Name') +1
    node_name Array 否 ['cluster-node1','cluster-node1','cluster-node1','cluster-node1','cluster-node1','cluster-node1','cluster-node1','cluster-node1','cluster-node1'] @mock=$order('cluster-node1','cluster-node1','cluster-node1','cluster-node1','cluster-node1','cluster-node1','cluster-node1','cluster-node1','cluster-node1') +1
    name Array 否 ['cluster-2018Dtc','i2soft','IP 地址 192.168.81.141','MSDTC-cluster-2018Dtc','群集 IP 地址','群集磁盘 1','群集磁盘 2','群集磁盘 3','群集名称'] @mock=$order('cluster-2018Dtc','i2soft','IP 地址 192.168.81.141','MSDTC-cluster-2018Dtc','群集 IP 地址','群集磁盘 1','群集磁盘 2','群集磁盘 3','群集名称') +1
  cls_node_list Array 否 2
    cls_node_status Array 否 [0,2] @mock=$order(0,2), -1：unknown；0：up；1：down；2：pause；3：joining +1
    cls_node_name Array 否 ['cluster-node1','cluster-node2'] @mock=$order('cluster-node1','cluster-node2') +1
    node_name Array 否 ['192.168.81.145','192.168.81.146'] @mock=$order('192.168.81.145','192.168.81.146') +1
    config_addr Array 否 ['192.168.81.145','192.168.81.146'] @mock=$order('192.168.81.145','192.168.81.146') +1
msg String 否 @mock=
ret Number 否 200 @mock=200

# 3列表-2 集群状态

SDK方法名：listClsStatus

# URL

//cls/status

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
node_uuids Array 否 ["11111111-1111-1111-1111-111111111111"] 必传，集群uuid数组，页面加载第一次获取状态一个一个获取，之后是批量获取；

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
data Object 否
  code Number 否 0
  message String 否
  count Number 否 0 数量
  status Array 否 20
    node_uuid String 否 @pick(["0DD4E727-70AB-62C6-BEB5-D012DFAE46E3","0DD4E727-70AB-62C6-BEB5-D012DFAE46E1"])
    cls_name String 否 cluster_2018 集群名
    status String 否 ONLINE 状态文字，ONLINE：在线；WARN：警告；
msg String 否

# 3列表-3 删除集群

SDK方法名：deleteCls

# URL

//cls

# Method

DELETE

# Request

名称 类型 必选 初始值 简介 Mock规则
node_uuids Array 否 ["11111111-1111-1111-1111-111111111111"] *集群uuid

# Response

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