Documentation
Table of Contents
hanode.get
Description
integer/array hanode.get(param¨¨tres d'objet)
La m¨¦thode permet de r¨¦cup¨¦rer une liste de n?uds du cluster en Haute disponibilit¨¦ en fonction des param¨¨tres donn¨¦s.
Cette m¨¦thode n'est disponible pour tous les utilisateurs de type Super admin. Voir R?les utilisateur pour plus d'informations.
±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ
(object) ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ d¨¦finissant la sortie souhait¨¦e.
La m¨¦thode prend en charge les param¨¨tres suivants.
| ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð | Type | Description |
|---|---|---|
| ha_nodeids | string/array | Renvoyer uniquement les n?uds avec les ID de n?ud donn¨¦s. |
| filter | object | Renvoyer uniquement les r¨¦sultats qui correspondent exactement au filtre donn¨¦. Accepte un tableau, o¨´ les cl¨¦s sont des noms de propri¨¦t¨¦ et les valeurs sont soit une valeur unique, soit un tableau de valeurs ¨¤ comparer. Permet le filtrage par les propri¨¦t¨¦s du n?ud : name, address, status. |
| sortfield | string/array | Trier le r¨¦sultat selon les propri¨¦t¨¦s donn¨¦es. Les valeurs possibles sont : name, lastaccess, status. |
| countOutput | flag | Ces param¨¨tres ¨¦tant communs ¨¤ toutes les m¨¦thodes get, ils sont d¨¦crits en d¨¦tail dans le commentaire de r¨¦f¨¦rence. |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| sortorder | string/array |
Valeurs retourn¨¦es
(integer/array) Retourne soit :
- un tableau d'objets ;
- le nombre d'objets r¨¦cup¨¦r¨¦s, si le param¨¨tre
countOutputa ¨¦t¨¦ utilis¨¦.
Exemples
Obtenir une liste de n?uds class¨¦s par statut
Requ¨ºte :
{
"jsonrpc": "2.0",
"method": "hanode.get",
"params": {
"preservekeys": true,
"sortfield": "status",
"sortorder": "DESC"
},
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}R¨¦ponse :
{
"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
}Obtenir une liste de n?uds sp¨¦cifiques par leurs ID
Requ¨ºte :
{
"jsonrpc": "2.0",
"method": "hanode.get",
"params": {
"ha_nodeids": ["ckuo7i1nw000e0sajwfttc1mp", "ckuo7i1nv000c0sajz85xcrtt"]
},
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}R¨¦ponse :
{
"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
}Obtenir une liste des n?uds arr¨ºt¨¦s
Requ¨ºte :
{
"jsonrpc": "2.0",
"method": "hanode.get",
"params": {
"output": ["ha_nodeid", "address", "port"],
"filter": {
"status": 1
}
},
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}R¨¦ponse :
{
"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
}Obtenir le nombre de n?uds standby
Requ¨ºte :
{
"jsonrpc": "2.0",
"method": "hanode.get",
"params": {
"countOutput": true,
"filter": {
"status": 0
}
},
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}R¨¦ponse :
V¨¦rifier l'¨¦tat des n?uds ¨¤ des adresses IP sp¨¦cifiques
Requ¨ºte :
{
"jsonrpc": "2.0",
"method": "hanode.get",
"params": {
"output": ["name", "status"],
"filter": {
"address": ["192.168.1.7", "192.168.1.13"]
}
},
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}R¨¦ponse :
{
"jsonrpc": "2.0",
"result": [
{
"name": "node3",
"status": "0"
},
{
"name": "node-active",
"status": "3"
}
],
"id": 1
}Source
CHaNode::get() dans ui/include/classes/api/services/CHaNode.php.