Documentation
Table of Contents
获取
描述
integer/array hanode.get(object parameters)
该方法允许根据给定的参数检索一个高可用集群节点的列表。
这个方法只适用于 超级管理员 的用户类型。 前往用户角色以了解更多信息。
参数
(object) 参数定义所期望的输出。
该方法支持以下参数。
| 参数 | 类型 | 描述 |
|---|---|---|
| ha_nodeids | ID/array | 仅返回指定节点ID的节点。 |
| filter | object | 仅返回那些与给定过滤器完全匹配的结果。 接受一个数组，其中键是属性名称，而值是一个单一的值或一个数组的值来匹配。 允许通过节点属性进行过滤: name、address 和 status。 |
| sortfield | string/array | 按指定的属性对结果进行排序。 可能的值: name, lastaccess, status。 |
| countOutput | flag | 这些参数是所有 get 方法的共同参数，在参考说明中详细描述。 |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| sortorder | string/array |
返回值
返回 (integer/array) 其中之一:
- 一个对象的数组;
- 如果使用了
countOutput参数，则为检索到的对象的数量。
示例
获取一个按状态排序的节点列表
请求:
{
"jsonrpc": "2.0",
"method": "hanode.get",
"params": {
"preservekeys": true,
"sortfield": "status",
"sortorder": "DESC"
},
"id": 1
}响应:
{
"jsonrpc": "2.0",
"result": {
"ckuo7i1nw000h0sajj3l3hh8u": {
"ha_nodeid": "ckuo7i1nw000h0sajj3l3hh8u",
"name": "node-active",
"address": "192.168.1.13",
"port": "10051",
"lastaccess": "1635335704",
"status": "3"
},
"ckuo7i1nw000e0sajwfttc1mp": {
"ha_nodeid": "ckuo7i1nw000e0sajwfttc1mp",
"name": "node6",
"address": "192.168.1.10",
"port": "10053",
"lastaccess": "1635332902",
"status": "2"
},
"ckuo7i1nv000c0sajz85xcrtt": {
"ha_nodeid": "ckuo7i1nv000c0sajz85xcrtt",
"name": "node4",
"address": "192.168.1.8",
"port": "10052",
"lastaccess": "1635334214",
"status": "1"
},
"ckuo7i1nv000a0saj1fcdkeu4": {
"ha_nodeid": "ckuo7i1nv000a0saj1fcdkeu4",
"name": "node2",
"address": "192.168.1.6",
"port": "10051",
"lastaccess": "1635335705",
"status": "0"
}
},
"id": 1
}通过节点ID获取特定节点的列表
请求:
{
"jsonrpc": "2.0",
"method": "hanode.get",
"params": {
"ha_nodeids": ["ckuo7i1nw000e0sajwfttc1mp", "ckuo7i1nv000c0sajz85xcrtt"]
},
"id": 1
}响应:
{
"jsonrpc": "2.0",
"result": [
{
"ha_nodeid": "ckuo7i1nv000c0sajz85xcrtt",
"name": "node4",
"address": "192.168.1.8",
"port": "10052",
"lastaccess": "1635334214",
"status": "1"
},
{
"ha_nodeid": "ckuo7i1nw000e0sajwfttc1mp",
"name": "node6",
"address": "192.168.1.10",
"port": "10053",
"lastaccess": "1635332902",
"status": "2"
}
],
"id": 1
}获取停用节点的列表
请求:
{
"jsonrpc": "2.0",
"method": "hanode.get",
"params": {
"output": ["ha_nodeid", "address", "port"],
"filter": {
"status": 1
}
},
"id": 1
}响应:
{
"jsonrpc": "2.0",
"result": [
{
"ha_nodeid": "ckuo7i1nw000g0sajjsjre7e3",
"address": "192.168.1.12",
"port": "10051"
},
{
"ha_nodeid": "ckuo7i1nv000c0sajz85xcrtt",
"address": "192.168.1.8",
"port": "10052"
},
{
"ha_nodeid": "ckuo7i1nv000d0sajd95y1b6x",
"address": "192.168.1.9",
"port": "10053"
}
],
"id": 1
}获取备用节点的数量
请求:
{
"jsonrpc": "2.0",
"method": "hanode.get",
"params": {
"countOutput": true,
"filter": {
"status": 0
}
},
"id": 1
}响应:
检查指定IP地址的节点的状态
请求:
{
"jsonrpc": "2.0",
"method": "hanode.get",
"params": {
"output": ["name", "status"],
"filter": {
"address": ["192.168.1.7", "192.168.1.13"]
}
},
"id": 1
}响应:
{
"jsonrpc": "2.0",
"result": [
{
"name": "node3",
"status": "0"
},
{
"name": "node-active",
"status": "3"
}
],
"id": 1
}源码
CHaNode::get() in ui/include/classes/api/services/CHaNode.php.