Documentation
Table of Contents
hanode.get
Descripció
integer/array hanode.get(object parameters)
El mètode permet recuperar una llista de nodes de clusters d'alta disponibilitat segons els paràmetres proveïts.
Aquest mètode és disponible només per a usuaris de tipus Super admin. Per a més informació, veieu Rols d'usuari.
Paràmetres
(object) Paràmetres que defineixen la sortida esperada.
El mètode admet els paràmetres següents.
| Paràmetre | Tipus | Descripció |
|---|---|---|
| ha_nodeids | ID/array | Retorna només nodes amb identificadors de nodes donats. |
| filter | object | Retorna només resultats que coincideixen exactament amb el filtre donat. Admet un objecte, on les claus són noms de propietat i els valors són un valor únic o una matriu de valors per comparar. Admet les propietats: name, address, status. |
| sortfield | string/array | Ordena el resultat segons les propietats donades. Valors possibles: name, lastaccess, status. |
| countOutput | flag | Aquests paràmetres es descriuen detalladament a comentari de referència. |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| sortorder | string/array |
Valors de retorn
(integer/array) Retorna un d'entre:
- una taula d'objectes;
- el recompte d'objectes recuperats, si s'empra el paràmetre
countOutput.
Exemples
Recuperar una llista de nodes ordenat per estat
{ "jsonrpc": "2.0", "method": "hanode.get", "params": { "preservekeys": true, "sortfield": "status", "sortorder": "DESC" }, "id": 1 }Resposta:
{ "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 }Obtindre una llista de nodes específics pels seus IDs
{ "jsonrpc": "2.0", "method": "hanode.get", "params": { "ha_nodeids": ["ckuo7i1nw000e0sajwfttc1mp", "ckuo7i1nv000c0sajz85xcrtt"] }, "id": 1 }Resposta:
{ "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 }Obtindre una llista dels nodes aturats
{ "jsonrpc": "2.0", "method": "hanode.get", "params": { "output": ["ha_nodeid", "address", "port"], "filter": { "status": 1 } }, "id": 1 }Resposta:
{ "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 }Obtindre el nombre de nodes en espera
{ "jsonrpc": "2.0", "method": "hanode.get", "params": { "countOutput": true, "filter": { "status": 0 } }, "id": 1 }Resposta:
Verificar l'estat dels nodes d'adreces IP específiques
{ "jsonrpc": "2.0", "method": "hanode.get", "params": { "output": ["name", "status"], "filter": { "address": ["192.168.1.7", "192.168.1.13"] } }, "id": 1 }Resposta:
{ "jsonrpc": "2.0", "result": [ { "name": "node3", "status": "0" }, { "name": "node-active", "status": "3" } ], "id": 1 }Font
CHaNode::get() in ui/include/classes/api/services/CHaNode.php.