hanode.get

    The method allows to retrieve a list of High availability cluster nodes according to the given parameters.

    This method is only available to Super admin user types. See for more information.

    (object) Parameters defining the desired output.

    The method supports the following parameters.

    • an array of objects;
    • the count of retrieved objects, if the countOutput parameter has been used.

    Get a list of nodes ordered by status

    Request:

    Response:

    1. {
    2.          "jsonrpc": "2.0",
    3.          "result": {
    4.            "ckuo7i1nw000h0sajj3l3hh8u": {
    5.              "ha_nodeid": "ckuo7i1nw000h0sajj3l3hh8u",
    6.              "name": "node-active",
    7.              "address": "192.168.1.13",
    8.              "port": "10051",
    9.              "lastaccess": "1635335704",
    10.              "status": "3"
    11.            },
    12.            "ckuo7i1nw000e0sajwfttc1mp": {
    13.              "ha_nodeid": "ckuo7i1nw000e0sajwfttc1mp",
    14.              "name": "node6",
    15.              "address": "192.168.1.10",
    16.              "port": "10053",
    17.              "lastaccess": "1635332902",
    18.              "status": "2"
    19.            },
    20.            "ckuo7i1nv000c0sajz85xcrtt": {
    21.              "ha_nodeid": "ckuo7i1nv000c0sajz85xcrtt",
    22.              "name": "node4",
    23.              "port": "10052",
    25.              "status": "1"
    26.            },
    27.            "ckuo7i1nv000a0saj1fcdkeu4": {
    28.              "ha_nodeid": "ckuo7i1nv000a0saj1fcdkeu4",
    29.              "name": "node2",
    30.              "address": "192.168.1.6",
    31.              "port": "10051",
    32.              "lastaccess": "1635335705",
    33.              "status": "0"
    34.            }
    35.          },
    36.          "id": 1
    37.        }

    Get a list of specific nodes by their IDs

    Request:

    1. {
    2.            "jsonrpc": "2.0",
    3.            "method": "hanode.get",
    4.            "params": {
    5.                "ha_nodeids": ["ckuo7i1nw000e0sajwfttc1mp", "ckuo7i1nv000c0sajz85xcrtt"]
    6.            },
    7.            "id": 1
    8.        }

    Response:

    Get a list of stopped nodes

    1. {
    2.            "jsonrpc": "2.0",
    3.            "method": "hanode.get",
    4.            "params": {
    5.                "output": ["ha_nodeid", "address", "port"],
    6.                "filter": {
    7.                    "status": 1
    8.                }
    9.            },
    10.            "id": 1
    11.        }

    Response:

    1.            "jsonrpc": "2.0",
    3.                {
    4.                    "ha_nodeid": "ckuo7i1nw000g0sajjsjre7e3",
    5.                    "address": "192.168.1.12",
    6.                    "port": "10051"
    7.                },
    8.                {
    9.                    "ha_nodeid": "ckuo7i1nv000c0sajz85xcrtt",
    10.                    "address": "192.168.1.8",
    11.                    "port": "10052"
    12.                },
    13.                {
    14.                    "ha_nodeid": "ckuo7i1nv000d0sajd95y1b6x",
    15.                    "address": "192.168.1.9",
    16.                    "port": "10053"
    17.                }
    18.            ],
    19.            "id": 1
    20.        }

    Get a count of standby nodes

    :

    Response:

    1. {
    2.            "jsonrpc": "2.0",
    3.            "result": "3",
    4.            "id": 1
    5.        }

    Check status of nodes at specific IP addresses

    :

    1. {
    2.            "jsonrpc": "2.0",
    3.            "method": "hanode.get",
    4.            "params": {
    5.                "output": ["name", "status"],
    6.                "filter": {
    7.                    "address": ["192.168.1.7", "192.168.1.13"]
    8.                }
    9.            },
    10.        }

    CHaNode::get() in ui/include/classes/api/services/CHaNode.php.