节点管理

November 23, 2021About 28 min

节点管理

0 准备-节点认证

SDK方法名:authNode

URL

/node/auth

Method

POST

Request

名称类型必选初始值简介Mock规则
proxy_switchNumber0认证类型,0,普通;1,云版(用认证码添加)
config_addrString192.168.72.76可选,普通节点时,节点ip(管理)
config_portNumber26821可选,普通节点时,节点rpc端口,默认值为26821
node_uuidString可选,云版节点,云版节点修改时传当前修改的节点uuid
os_userStringchenky不使用凭据时:os账号(明文)
os_pwdString123qwe不使用凭据时:RSA加密后的系统密码;
i2idString可选,云版节点,i2cloud认证码;
use_credentialNumber0是否使用凭据:
0:不使用
1:使用
cred_uuidString使用凭据时:凭据的uuid

Response

名称类型必选初始值简介Mock规则
dataObject
  os_typeNumber@pick([0,1])系统:0:linux, 1:windows
  rootStringC:\Program Files (x86)\info2soft-i2node\节点安装路径,默认日志和缓存路径为dataRoot.”cache\”、dataRoot.”log\”
  messageString
  codeNumber0
  data_addrString认证码认证时,返回data_addr默认值供前端填在页面上
msgString
retNumber200

0 准备-获取节点安装包列表

SDK方法名:listNodePackageList

URL

/node/package_list

Method

GET

Request

名称类型必选初始值简介Mock规则
for_downloadNumber可选,是则用于下载此版本控制机节点安装包,否则用于批量新建(安装)节点时获取列表,0否1是;

Response

名称类型必选初始值简介Mock规则
os_typeNumber@pick([0,1])系统:0:linux, 1:windows
rootStringC:\Program Files (x86)\info2soft-i2node\节点安装路径,默认日志和缓存路径为dataRoot.”cache\”、dataRoot.”log\”
messageString
codeNumber0@mock=0
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  listArray["info2soft-i2node-7.1.2.28618"]
  down_listArray2
    file_nameArray["info2soft-i2node-7.1.31.32340-debian.7.1.x86_64.deb","info2soft-i2node-7.1.31.32340-el7.x86_64.deb","info2soft-i2node-7.1.31.32340-el6.x86_65.deb"]文件名+1
    labelArray['Linux debian.7.1', 'Linux i2node.7.1']列表中显示的名称+1
    bitStringx64可能出现x86和x64,为空则为二合一安装包
    down_pathArray['E:\ctrlcenter\wwwroot\default\application\data/download/info2soft-i2node-7.1.31.32340-debian.7.1.x86_64.deb', 'E:\ctrlcenter\wwwroot\default\application\data/download/info2soft-i2node-7.1.31.32340-el7.x86_64.deb']带路径的文件名+1

0 准备-获取节点容量

SDK类名:/resource/Node

SDK方法名:checkCapacity

URL

/node/check_capacity

Method

GET

Request

名称类型必选初始值简介Mock规则
cache_pathStringC:\Program Files (x86)\info2soft\node\cache\*缓存目录
proxy_switchNumber0
i2idString
config_addrString192.168.72.76
config_portString26821

Response

名称类型必选初始值简介Mock规则
msgString@mock=
retNumber200@mock=200
dataObject
  hd_freeString34292@mock=34292, 磁盘剩余
  hd_totalString60026@mock=60026, 磁盘总量
  mem_freeString2503@mock=2503, 内存剩余
  mem_totalString4095@mock=4095, 内存总量
  messageStringSUCCESS@mock=SUCCESS
  codeNumber0@mock=0

0 准备-获取节点卷组列表

SDK方法名:listVg

URL

/node/vg

Method

GET

Request

名称类型必选初始值简介Mock规则
proxy_switchNumber0是否是代理模式,0否1是
i2idString代理模式必传,识别码
config_addrString192.168.72.76非代理模式必传,ip
config_portString26821非代理模式必传,端口

Response

名称类型必选初始值简介Mock规则
hd_freeString34292@mock=34292, 磁盘剩余
hd_totalString60026@mock=60026, 磁盘总量
mem_freeString2503@mock=2503, 内存剩余
mem_totalString4095@mock=4095, 内存总量
messageStringSUCCESS@mock=SUCCESS
codeNumber0@mock=0
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  listArray
    nameString1卷组名称
    totalString1
    usedString1
    freeString1

节点- 扫描集群IP获取节点信息

SDK方法名:listHostInfo;

URL

/node/host_info

Method

GET

Request

名称类型必选初始值简介Mock规则
node_typeNumber备份集群-4
config_addrString集群IP地址

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  info_listArray
    node_nameString68.211主机名
    typeString
    statusString14状态

0 准备-检查节点在线

SDK方法名:checkNodeOnline

URL

/node/hello

Method

GET

Request

名称类型必选初始值简介Mock规则
proxy_switchNumber0代理模式开关,0关1开
i2idString66F636FE29656416690A62296580EBD9认证码
config_addrString192.168.72.76*节点ip
config_portString26821*节点端口,默认26821

Response

名称类型必选初始值简介Mock规则
msgString
retNumber200
dataObject
  codeNumber0
  messageString
  config_addrString172.20.68.200节点ip
  hostnameString节点名称

节点 - 获取绑定云主机信息

SDK方法名:listNodeBindEcs;

URL

/node/ecs_info

Method

GET

Request

名称类型必选初始值简介Mock规则
config_addrString192.168.72.76
config_portString26821
platform_uuidString云平台uuid

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  info_listObject
    ecs_nameStringcld_test
    ecs_idStringd0ab36ab-88f2-4be9-8cd5-7b064dddb099
    statusString
    flavoridString4GB
    image_refStringc3.large.2 i2DTO-North
    ecs_uuidStringE28184D8-869B-BF56-A77C-3CC835FAAC34
    random_strString0E807AD3-DD1E-9224-2B9B-E713CF258467
    cloud_uuidString0E807AD3-DD1E-9224-2B9B-E713CF258467
    node_nameString
    wk_node_nameString
    node_uuidString
    bk_node_nameString
  messageString

1 单项-新建节点

SDK方法名:createNode

URL

/node

Method

POST

Request

名称类型必选初始值简介Mock规则
nodeObject节点对象表单
  bak_client_maxString100最大客户端数量
  cloud_typeString0备份主机所在云
  bak_rootString备份根目录
  monitor_switchNumber0打开监控
  node_roleString3节点类型 1工作 2灾备 3混合
  mem_limitString819*内存使用上限
  config_portNumber26821*管理接口端口
  mon_save_dayString5*分析数据保留 天
  vgString*卷组名称
  os_typeNumber1系统:0:linux, 1:windows
  os_pwdString用公钥加密后的系统密码
  log_pathStringC:\Program Files (x86)\info2soft\node\log\*日志目录
  mon_data_pathStringC:\Program Files (x86)\info2soft\node\log\*分析数据目录
  commentString备注
  rep_pathArray*复制路径: (Linux工作机需要)
  bak_user_maxString100最大用户数量
  cache_pathStringC:\Program Files (x86)\info2soft\node\cache\*数据缓存目录
  db_save_dayString3*监控数据保留 天
  proxy_switchNumber0用认证码添加 0否 1是
  data_addrString192.168.72.76*数据接口地址
  node_nameStringN4_72.76*节点名称
  config_addrString192.168.72.76*管理接口地址
  mon_send_intervalString10*监控延迟 秒
  disk_limitString10240*磁盘使用上限
  reboot_sysString0是否重启节点 0否 1是
  bind_lic_listArray*绑定的软件许可列表,实时生成,不入库
  security_checkNumber0安全检查开关,0:关闭;1,打开;开则下发规则或任务时会检查任务签名(目标机/混合节点专用)
  os_userStringKyran*os账号(明文)
  bak_service_typeString灾备机服务类型
  en_snap_switchNumber0快照支持 开关
  rep_excl_pathArray*排除路径: (Linux工作机需要)
  biz_grp_listArray分组关系, 当前资源绑定的组uuid列表;
  i2idStringi2cloud认证码
  dtrack_switchNumber3是否用作Dtrack(块复制)节点,0否1是
  iscsi_as_initiatorNumber是否作为ISCSI发起者,win linux 都可选,0否1是
  iscsi_switchNumber是否用于ISCSI
  iscsi_as_targetNumber是否作为ISCSI目标端,win 固定传 0,linux 可选,0否1是
  iscsi_initiator_nameStringISCSI发起者名称,从xxx接口获取并选择,作为ISCSI发起者时传
  use_credentialNumber0当前是否使用凭据:
0:不使用
1:使用
  cred_uuidString可选,当前使用凭据的uuid
  disk_free_space_limitNumber磁盘剩余空间阈值,单位MB
  platform_uuidString节点所关联平台的uuid(目前只有云平台)
  node_infoObject通过node_info接口获取的节点信息
  cc_ip_uuidString控制机IP对应的UUID
  maintenanceNumber0维护模式:0否;1是
  node_typeNumber[可选]:备份集群必传,值为 4
  cls_nodeString复用集群字段,表示集群节点信息
  fc_as_initiatorNumber作为fc客户端:
0:否;1:是
  wwpn_infoArrayport_wwn数组
  ecs_bindNumber关联平台-绑定云主机云主机开关
  ecs_idString关联平台-绑定云主机云主机id
  keep_log_daysNumber180日志保留天数

Response

名称类型必选初始值简介Mock规则
retNumber200
dataObject
  codeNumber0
  messageString
  uuidString
  wwpn_del_fail_listArraywwpn删除失败的列表
    codeString错误码
    messageStringmessage
    wwpnStringwwpn号
  wwpn_create_fail_listArraywwpn创建失败的列表
    wwpnStringwwpn号
    codeString错误码
    messageStringmessage
msgString

1 单项-修改节点

SDK方法名:modifyNode

URL

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

Method

PUT

Request

名称类型必选初始值简介Mock规则
nodeObject,节点对象表单
  config_addrString192.168.74.25@mock=192.168.74.25, *管理接口地址
  proxy_switchNumber0@mock=0, 用认证码添加 0否 1是
  security_checkNumber1@mock=1, 安全检查开关,0:关闭;1,打开;开则下发规则或任务时会检查任务签名(目标机/混合节点专用)
  rep_excl_pathArray@mock=, *排除路径: (Linux工作机需要)
  log_pathStringC:\Program Files (x86)\info2soft-i2node\log\@mock=C:\Program Files (x86)\info2soft-i2node\log, *日志目录
  node_roleString3@mock=3, 节点类型 1工作 2灾备 3混合
  bak_user_maxString100@mock=100, 最大用户数量
  cloud_typeString0@mock=0, 备份主机所在云
  en_snap_switchNumber0@mock=0, 快照支持 开关
  os_pwdStringEnEyGDJF==@mock=EnEyGDJF==, *用公钥加密后的系统密码/i2cloud认证码;
  vgString@mock=, *卷组名称
  monitor_log_pathStringC:\Program Files (x86)\info2soft-i2node\log\@mock=C:\Program Files (x86)\info2soft-i2node\log, *分析数据目录
  data_addrString192.168.74.25@mock=192.168.74.25, *数据接口地址
  moni_log_keep_nodeString5@mock=5, *分析数据保留 天
  wk_pathArray@mock=, *复制路径: (Linux工作机需要)
  disk_limitString40960@mock=40960, *磁盘使用上限
  bak_service_typeString@mock=, 灾备机服务类型
  mem_limitString13041@mock=13041, *内存使用上限
  os_typeNumber2@mock=2, 系统:0:linux, 1:windows
  os_userStringKyran@mock=Kyran, *os账号(明文)
  bind_lic_listArray93AF0C9F-14C8-41A2-31CB-AAA0F65193FA@mock=93AF0C9F-14C8-41A2-31CB-AAA0F65193FA, *绑定的软件许可列表,实时生成,不入库
  moni_log_keep_serverString3@mock=3, *监控数据保留 天
  node_nameStringaaaa@mock=aaaa, *节点名称
  monitor_intervalString10@mock=10, *监控延迟 秒
  reboot_sysString0@mock=0, 是否重启节点 0否 1是
  bak_client_maxString100@mock=100, 最大客户端数量
  bak_rootString@mock=, 备份根目录
  monitor_switchNumber0@mock=0, 打开监控
  cache_pathStringC:\Program Files (x86)\info2soft-i2node\cache\@mock=C:\Program Files (x86)\info2soft-i2node\cache, *数据缓存目录
  config_portNumber26821@mock=26821, *管理接口端口
  group_uuidStringF5844651-DB5B-937D-73B1-A2378810F00A@mock=F5844651-DB5B-937D-73B1-A2378810F00A, 节点组
  commentString@mock=, 备注
  biz_grp_listArray分组关系, 当前资源绑定的组uuid列表;
  i2idStringi2cloud认证码
  use_credentialNumber0当前是否使用凭据:
0:不使用 1:使用
  cred_uuidString可选,当前使用凭据的uuid
  disk_free_space_limitNumber磁盘剩余空间阈值
  platform_uuidString节点所关联平台的uuid(目前只有云平台)
  maintenanceNumber0
  ecs_bindNumber00-不绑定 1-绑定
  ecs_idString云主机id
  fc_as_initiatorNumber0
  wwpn_infoArray
  keep_log_daysNumber180

Response

名称类型必选初始值简介Mock规则
retNumber200
dataObject
  codeNumber0
  messageString
  uuidString
  wwpn_del_fail_listArray
    codeString
    messageString
    wwpnString
  wwpn_create_fail_listArray
    wwpnString
    codeString
    messageString
msgString

1 单项-获取单个节点

SDK方法名:describeNode

URL

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

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
retNumber200@mock=200
msgString@mock=
dataObject
  messageString
  nodeObject,节点对象表单
    reboot_sysString0@mock=0, 是否重启节点 0否 1是
    rep_excl_pathArray@mock=, *排除路径: (Linux工作机需要)
    allow_modify_cache_pathNumber1@mock=1, 是否允许修改缓存地址
    moni_log_keep_serverString3@mock=3, *监控数据保留 天
    phy_typeNumber1@mock=1, 机器类型 , 1:物理机; 2:虚拟机;
    cloud_typeString0@mock=0, 备份主机所在云
    mem_limitString13041@mock=13041, *内存使用上限
    moni_log_keep_nodeString5@mock=5, *分析数据保留 天
    commentString@mock=, 备注
    node_nameStringaaaa@mock=aaaa, *节点名称
    cache_pathStringC:\Program Files (x86)\info2soft-i2node\cache\@mock=C:\Program Files (x86)\info2soft-i2node\cache, *数据缓存目录
    log_pathStringC:\Program Files (x86)\info2soft-i2node\log\@mock=C:\Program Files (x86)\info2soft-i2node\log, *日志目录
    bind_lic_listArray93AF0C9F-14C8-41A2-31CB-AAA0F65193FA@mock=93AF0C9F-14C8-41A2-31CB-AAA0F65193FA, *绑定的软件许可列表,实时生成,不入库
    bak_client_maxString100@mock=100, 最大客户端数量
    config_portNumber26821@mock=26821, *管理接口端口
    data_addrString192.168.74.25@mock=192.168.74.25, *数据接口地址
    group_uuidStringF5844651-DB5B-937D-73B1-A2378810F00A@mock=F5844651-DB5B-937D-73B1-A2378810F00A, 节点组
    os_userStringKyran@mock=Kyran, *os账号(明文)
    monitor_switchNumberfalse@mock=false, 打开监控
    vgString@mock=, *卷组名称
    disk_limitString40960@mock=40960, *磁盘使用上限
    node_roleString3@mock=3, 节点类型 1工作 2灾备 3混合
    wk_pathArray@mock=, *复制路径: (Linux工作机需要)
    monitor_intervalString10@mock=10, *监控延迟 秒
    bak_user_maxString100@mock=100, 最大用户数量
    monitor_log_pathStringC:\Program Files (x86)\info2soft-i2node\log\@mock=C:\Program Files (x86)\info2soft-i2node\log, *分析数据目录
    os_typeNumber2@mock=2, 系统:0:linux, 1:windows
    en_snap_switchNumber0@mock=0, 快照支持 开关
    proxy_switchNumber0@mock=0, 用认证码添加 0否 1是
    bak_service_typeString@mock=, 灾备机服务类型
    config_addrString192.168.74.25@mock=192.168.74.25, *管理接口地址
    security_checkNumber1@mock=1, 安全检查开关,0:关闭;1,打开;开则下发规则或任务时会检查任务签名(目标机/混合节点专用)
    bak_rootString@mock=, 备份根目录
    node_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 节点uuid
    biz_grp_listArray分组关系, 当前资源绑定的组uuid列表;
    i2idString
    cred_uuidString上次添加/编辑,使用凭据的uuid
    disk_free_space_limitNumber磁盘剩余空间阈值
    maintenanceNumber0
    fc_as_initiatorNumber0
    wwpn_infoArray
    keep_log_daysNumber180
  codeNumber0@mock=0

1 单项-新建节点 - 批量

SDK方法名:createBatchNode

URL

/node/batch

Method

POST

Request

名称类型必选初始值简介Mock规则
base_info_listArray
  os_pwdString123qwe*对应账户密码(RSA加密)
  os_userStringchenky*os账号(明文)
  config_portNumber26821*管理接口端口
  config_addrString192.168.72.76*节点管理地址
  node_nameStringN4_72.76*节点名
  need_installNumber0是否自动安装节点软件,0:no; 1:yes
  install_typeNumber1windows安装方式:
1:远程管理
2: 文件共享
默认为远程服务
  install_port_linuxNumber22linux 远程安装端口
  install_pathStringwindos 远程安装路径
  os_typeNumber* 系统:0:linux, 1:windows
  rep_pathArraylinux必填:复制路径
nodeObject节点对象表单
  mem_limitString819*内存使用上限
  bind_lic_listArray*绑定的软件许可uuid数组,实时生成,不入库
  disk_limitString10240*磁盘使用上限
  monitor_intervalString10*监控延迟 秒
  node_roleString3节点类型 1工作 2灾备 3混合
  monitor_switchNumber00,关闭监控;1,打开监控
  moni_log_keep_nodeString5*分析数据保留 天
  moni_log_keep_serverString3*监控数据保留 天
  security_checkNumber0安全检查开关,0:关闭;1,打开;开则下发规则或任务时会检查任务签名(目标机/混合节点专用)
  biz_grp_listArray分组关系
  node_versionString仅自动安装节点时必传,节点软件的版本,如“info2soft-i2node-7.0.1.27814”
  proxy_ipString代理机器IP|安装服务器IP
  disk_free_space_limitNumber磁盘剩余空间阈值
  proxy_uuidString代理uuid

Response

名称类型必选初始值简介Mock规则
msgString
dataObject
  fail_listArray
    node_nameString6666节点名
    messageString[11111100]无法连接节点[11111100]无法连接节点, 错误信息
    config_addrString192.168.81.145节点管理地址
    codeNumber11111100
    indexNumber供前端据索引找到用户名密码生成失败列表.csv供用户重新导入+1
  messageString[11111100]无法连接节点
  codeNumber11111100
  success_listArray
    node_nameString55555
    messageString[0] 操作成功
    config_addrString192.168.81.144
    codeNumber0
    indexString供前端据索引找到用户名密码生成失败列表.csv供用户重新导入+1
retNumber200

1 单项-获取节点存储信息

SDK方法名:describeDeviceInfo

URL

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

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
retNumber200
dataObject
  node_uuidString287F1E4B-1CCD-21D9-B9BE-0A72AD62375D
  messageString[0] success
  device_infoArray3
    devEnbcompressStringN开启压缩,Y/N
    devEnbdewightStringY开启去重,Y/N
    devTotalString3.986GB总容量(带单位),如:3.986GB
    devSaverateString0%节省百分比,如:0%
    devFreeString2.918GB空闲容量(带单位),2.918GB
    nodeNameStringNzIuNzM=节点名称,base64过
    nodeTypeString3节点角色
    devNameStringF:\设备名称,win 如 F:\,linux 如 /dev/xxx(非挂载点)
    devTypeStringblock device设备类型
  codeNumber0
msgString

单项 - (Win)节点获取磁盘挂载点

SDK方法名:describeDriverLetter

URL

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

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] success
  usedArray["A:","C:","D:"]
  unusedArray["B:","E:","F:","G:","H:","I:","J:","K:","L:","M:","N:","O:","P:","Q:","R:","S:","T:","U:","V:","W:","X:","Y:","Z:"]

1 单项-添加从类型节点

SDK方法名:addSlaveNode

URL

/node/add_slave_node

Method

POST

Request

名称类型必选初始值简介Mock规则
proxy_switchString0是否使用代理:
0:否
1:是
config_addrString管理地址,proxy_switch为0时必传
config_portNumber管理端口,proxy_switch为0时必传
i2idString认证码,proxy_switch为1时必传
os_pwdStringyAZe2Hx6/dCL8GnjiRaro/mayqD24i3bMwZLtRXrHlRDIijGDcNKTqSK4IL91YIaqAGaOpUbnTr+y6VPgJ4UXJQset0se7bQgVrRjVncNeiVNCNyAzLktWYMMGKOWekw5uD2MOVEHhbknG0ZSuFXyywFEG9JTntNerCae7RSI6u2c3kRBCyqbdPc9osMK8YL9ZRqiIE/4K1+BomG9q1RwNEJhDcm/OaMxJCPHANNTImBWWv+Ir3qt20jjv1Fx7of2Fgb14Sj4TwGb7ESrbMiL/fblrfGl+rc6koNucEIRdT+aje+F47pKu4mknubWZ1wo+W2p/yaKyqfzTfeDFJtFQ==密码,proxy_switch为0且use_credential为0时必传
os_userStringadministrator用户名,proxy_switch为0且use_credential为0时必传
use_credentialNumber是否使用凭据,proxy_switch为0时必传
cred_uuidString凭据uuid,use_credential为1时必传
bind_lic_listArray软件许可
biz_grp_listArray业务组
commentString备注

Response

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

单项 - 获取节点信息

SDK方法名:describeNode

URL

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

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
retNumber200
dataObject
  msgString
  node_uuidString287F1E4B-1CCD-21D9-B9BE-0A72AD62375D
  messageString[0] success
  node_infoObject
    codeNumber0
    os_versionStringMicrosoft Windows Server 2016
    cpu_infoObject
      countNumber1
      coresNumber4核数
      logical_processorsNumber8
      modelStringIntel(R) Core(TM) i7-7700 CPU @ 3.60GHz
      vcountNumber虚拟cpu个数
    mem_infoObject
      countNumber4内存个数
      singleNumber16384MB,单根大小;可能存在单根大小不一样
      totalNumber65536MB 总大小
      modelStringTEAMGROUP-UD4-2400
      speedNumber2400MHz
    disk_infoArray
      indexNumber3
      modelString@pick(['Samsung SSD 970 EVO 500GB', 'ST4000NM0033-9ZM170', 'ST2000VX000-1ES164'])
      totalString@pick([3815447,476940,1907729])MB
      is_bootString11启动盘,0数据盘
      interfaceString0磁盘接口,0 ide , 1 scsi
    bios_typeStringlegacybios类型,"legacy"或者"uefi"
    timezoneString系统时区
    network_infoObject
      networksArray
        macStringmac地址
        typeString0
        nameString名称
        ipStringip
        gatewayString网关
        maskString掩码
        dnsObjectwindows dns配置
          domainString
          serversString
      dnsObjectlinux dns配置
        domainString
        serversString
  codeNumber0

2 列表-节点列表

SDK方法名:listNode

URL

/node

Method

GET

Request

名称类型必选初始值简介Mock规则
search_valueString''可选,搜索字段对应值,如 要搜的节点名(可以模糊),等同like_args
search_fieldString''可选,搜索字段,如 node_name
limitNumber15可选,不传就是全部
pageNumber1可选,不传就是全部
typeNumber可选,该模块下的子类别代号。如节点模块,0:普通节点,3:DTrack节点;
like_args[xxx]String可选,搜索字段对应值(可以模糊),形如 like_args[xxx]:yyy,对象内可以同时加入多个搜索关系,即like_args[xxx][]:yyy
where_args[xxx]String可选,匹配字段对应值形如:
where_args[xxx]:yyy;
对象内可以同时加入多个搜索关系;
yyy 可以为数组,即where_args[xxx][]:yyy,其效果即 where_in 查询;
filter_by_biz_grpNumber可选,1:开启分组过滤模式:其效果为将where_args 内所有以 _uuid 结尾的 key 的元素 value 当作 业务组的 grp_uuid,并替换 value 为业务组中成员uuid列表;此字段只在部分模块生效,详细列表见【业务分组】模块;
order_byString''可选,用哪个字段排序
directionString''可选,排序方向,可选参数 'ASC', 'DESC', 'RANDOM' ,默认 'DESC';
user_filterNumber是否user限定,不传此参按照业务管理员允许看到所有的处理;0否1是;
cloud_uuidString【可选】获取绑定云主机的节点作为备机,云容灾整机复制新建时必传;

Response

名称类型必选简介初始值Mock规则
dataObject
  info_listArray2
    node_nameString*节点名称@pick(["Smith","Will","Dode"])
    data_addrString*数据接口地址@pick(["192.168.24.25","192.168.79.252","192.168.2.15"])
    node_uuidArray节点uuid['0DD4E727-70AB-62C6-BEB5-D012DFAE46E3', '0DD4E727-70AB-62C6-BEB5-D012DFAE46E1']+1
    cache_pathString*数据缓存目录C:\Program Files (x86)\info2soft-i2node\cache\
    group_nameString组名testgroup
    config_addrString*管理接口地址@pick(["192.168.74.25","192.168.71.252","192.168.6.15"])
    log_pathString*日志目录C:\Program Files (x86)\info2soft-i2node\log\
    os_typeNumber系统:0:linux, 1:windows@pick([1, 2])
    usernameString节点所有者@pick(["admin","user"])
    node_roleString节点类型 1工作 2灾备 3混合@pick(["1","2","3"])
    mem_limitString*内存使用上限13041
    group_uuidString组id0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
    disk_limitString*磁盘使用上限40960
    biz_grp_nameArray分组组名列表
    biz_grp_listString分组组id列表
    can_delNumber当前用户是否有权限删除,0否1是1
    can_upNumber当前用户是否有权限修改,0否1是1
    can_opNumber当前用户是否有权限操作,0否1是1
    is_biz_adminString当前用户是否有是业务管理员,0否1是0
    statusString节点状态:
ONLINE:在线;
OFFLINE:离线;
UNKNOWN:未知;
OFFLINE
    maintenanceNumber0是否开启了维护模式:
0:否;
1:是;
    fc_as_initiatorNumber0是否作为fc客户端:
0:否;
1:是;
    wwpn_infoArray[]开启fc客户端,添加的wwpn数组
  totalNumber100@mock=100, 总数
  codeNumber0@mock=0
  messageString
msgString@mock=
retNumber200@mock=200

2 列表-节点操作

SDK方法名:{operate}Node

URL

/node/operate

Method

POST

Request

名称类型必选初始值简介Mock规则
node_uuidsArray节点数组
operateStringupgradeupgrade:升级节点软件
maintain:开关维护模式
switchNumber0维护模式0关,1开

Response

名称类型必选初始值简介Mock规则
dataObject
  codeNumber0@mock=0
  messageStringsuccess@mock=success
retNumber200@mock=200
msgString@mock=

2 列表-节点状态

SDK方法名:listNodeStatus

URL

/node/status

Method

GET

Request

名称类型必选初始值简介Mock规则
node_uuidsArray['D66246D7-89C4-DC3A-E9A2-D2FCE4A56307','064B23C1-DF92-8846-4BEA-8517789C35A4']必传,uuid数组,页面加载第一次获取状态一个一个获取,之后是批量获取;
force_refreshNumber点击操作栏刷新按钮必传,下发1,表示从rpc获取;其他情况不传

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  statusArray1
    node_uuidArray['0DD4E727-70AB-62C6-BEB5-D012DFAE46E3', '0DD4E727-70AB-62C6-BEB5-D012DFAE46E1']节点uuid+1
    statusStringOFFLINE节点状态:
ONLINE:在线;
OFFLINE:离线;
UNKNOWN:未知;
    versionString7.1.57.19111521节点版本
    detailObject正常返回下面的对象,若节点离线或不支持查询更多信息,返回null
      performanceObject
        disk_limitNumber2085617664磁盘使用上限,单位 bytes
        disk_percentNumber0磁盘使用百分比
        disk_usedNumber0磁盘已使用大小
        mem_limitNumber876609536内存使用上限
        mem_percentNumber5内存使用百分比
        mem_usedNumber50331648内存已使用大小
      processObject进程
        collectorNumber0资源监视
        haNumber1高可用
        ha_detectorNumber1高可用检测
        logdNumber1日志
        rpcNumber1RPC
        sdatadNumber1工作机
        srepdNumber0灾备机

2 列表-删除节点

SDK方法名:deleteNode

URL

/node

Method

DELETE

Request

名称类型必选初始值简介Mock规则
node_uuidsArray["@guid"]*节点数组
delete_quotaNumber是否一并删除节点上的所有配额及ZFS,0否1是;
forceNumber1 - 强制删除 0 - 非强制删除

Response

名称类型必选初始值简介Mock规则
msgString
dataObject
  codeNumber11110001
  messageString
  fail_listArray
    codeNumber11110001
    messageString[-1] 找不到节点
    node_uuidString@uuid
    node_nameString@name
  success_listArray
    codeNumber11110001
    messageString[0] success
    node_uuidString@uuid
    node_nameString@name
retNumber200

3 Dashboard - 获取节点列表

SDK类名:/dashboard/Dashboard; SDK方法名:node; 首页Dashboard 整体状态统计图表

URL

//dashboard/node

Method

GET

Request

名称类型必选初始值简介Mock规则
limitNumber可选,默认 30
pageNumber可选,默认 1
typeNumber可选,默认 0

Response

名称类型必选初始值简介Mock规则
countNumber10@mock=10, 数量
info_listArray2
totalNumber100@mock=100, 总数
codeNumber0@mock=0
messageString
node_nameString@pick(["Smith","Will","Dode"])@mock=@pick(["Smith","Will","Dode"]), *节点名称
data_addrString@pick(["192.168.24.25","192.168.79.252","192.168.2.15"])@mock=@pick(["192.168.24.25","192.168.79.252","192.168.2.15"]), *数据接口地址
node_uuidString@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
cache_pathStringC:\Program Files (x86)\info2soft-i2node\cache\@mock=C:\Program Files (x86)\info2soft-i2node\cache, *数据缓存目录
group_nameStringtestgroup@mock=testgroup, 组名
config_addrString@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"]), *管理接口地址
log_pathStringC:\Program Files (x86)\info2soft-i2node\log\@mock=C:\Program Files (x86)\info2soft-i2node\log, *日志目录
os_typeNumber@pick([1, 2])@mock=@pick([1, 2]), 系统:0:linux, 1:windows
usernameString@pick(["admin","user"])@mock=@pick(["admin","user"]), 节点所有者
node_roleString@pick(["1","2","3"])@mock=@pick(["1","2","3"]), 节点类型 1工作 2灾备 3混合
mem_limitString13041@mock=13041, *内存使用上限
group_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 组id
disk_limitString40960@mock=40960, *磁盘使用上限
biz_grp_nameArray分组组名列表
biz_grp_listString分组组id列表
dataObject
  countNumber10
  info_listArray20
    node_nameString@pick(["Smith","Will","Dode"])
    data_addrString@pick(["192.168.24.25","192.168.79.252","192.168.2.15"])
    node_uuidString@guid
    cache_pathStringC:\Program Files (x86)\info2soft-i2node\cache\
    group_nameStringtestgroup
    config_addrString@pick(["192.168.74.25","192.168.71.252","192.168.6.15"])
    log_pathStringC:\Program Files (x86)\info2soft-i2node\log\
    os_typeString@pick([1, 2])
    usernameString@pick(["admin","user"])
    node_roleString@pick(["1","2","3"])
    mem_limitString13041
    group_uuidString0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
    disk_limitString40960
    biz_grp_nameArray
    biz_grp_listString
    n_statusString@pick(["UNKNOWN","ONLINE"])
  totalNumber100
  codeNumber0
  messageString
msgString
retNumber200

获取Oracle DB信息 - 表空间

SDK方法名:nodeGetOracleInfo

URL

/node/oracle_info

Method

GET

Request

名称类型必选初始值简介Mock规则
usernameString
passwordString
sqlplus_pathString
sidString
timeoutString
portString
bk_uuidString

Response

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

获取MySQL信息 - 数据库名

SDK方法名:nodeGetMysqlInfo

URL

/node/mysql_info

Method

GET

Request

名称类型必选初始值简介Mock规则
usernameString
passwordString
mysql_pathString
timeoutString
portString
bk_uuidString

Response

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

获取数据地址列表

SDK方法名:dataIpList

URL

/node/data_ip_list

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  totalNumber1
  listObject
    C0744ABF-5571-8288-1930-439612B6234AArray节点uuid
      uuidStringA7EC7CF9-FCA2-D467-ECD6-E028AA9C8319数据地址uuid
      data_ipString172.20.2.214数据地址
      has_ruleNumber0是否关联规则,1是,0否
  messageString

修改数据地址

SDK方法名:modifyDataIp

URL

/node/data_ip

Method

POST

Request

名称类型必选初始值简介Mock规则
data_ip_listArray
  uuidStringA7EC7CF9-FCA2-D467-ECD6-E028AA9C8319
数据地址uuid(需要修改的字段下发,新添加的字段为空)
  data_ipString172.20.15.121数据地址
node_uuidStringD6EC7CF9-FCA2-D467-ECD6-E028AA9C8319
节点uuid

Response

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

获取 fc 客户端 hba卡信息

SDK方法名:listHbaInfo;

URL

/node/hba_info

Method

GET

Request

名称类型必选初始值简介Mock规则
config_addrString管理地址
config_portString管理端口
proxy_switchNumber是否开启代理
i2idString开启代理时,认证码

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  hba_infoArray
    manufacturerString
    serial_numberStringtest1hba卡序列号
    modelString
    model_descString
    vec_nodesArray
      node_wwnStringtest2节点wwn
      vec_portsArray
        node_wwnString
        port_wwnStringtest3端口wwn
        port_typeString
        port_stateString
        port_speedString

解绑云主机检查

SDK方法名:checkUnbindEcs;

URL

/node/check_unbind_ecs

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] success
  can_unbindNumber00-禁止解绑 1-可以解绑

节点 - version

SDK方法名:getNodeVersion;

URL

/node/version

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  statusStringOFFLINE
  versionString7.1.57.19111521
  hostnameStringnode1
Last update: 11/23/2023, 10:43:57 AM
Contributors: ganl