Skip to content

List All Nodes Statistics

Supported Versions Last Updated
1.27.12 & higher 2022/09/08
Note: This API function returns statistics for all virtualization nodes. MN is not included.
Parameters "freedisk" and "freememory" are retrieved from virtualization nodes. All other parameters are extracted from SolusVM database.
API function node-statistics can be used to get single node statistics.
Action get-all-nodes-statistics
Method GET, POST
Variables

-

Example Output

JSON

Success:

{
    "status": "success",
    "statusmsg": "",
    "nodes_statistics": [
        {
            "allocatedbandwidth": [network traffic allocated to VPS'es, Kb],
            "allocatedmemory": [memory allocated to VPS'es, Kb],
            "arch": [CPU architecture],
            "city": [city],
            "country": [country],
            "disklimit": [maximum disk space allowed to allocate VPS'es, Kb],
            "freedisk": [free diskspace in the default VG for KVM/Xen, for OpenVZ - in /vz partition],
            "freeips": [number of available IPv4 addresses],
            "freeipv6": [number of available IPv6 addresses],
            "freeipv6subnets": [number of available IPv6 subnets],
            "freememory": [for Xen - available memory not allocated to VPS'es, Kb. 0 for KVM , OpenVZ],
            "hostname": [hostname],
            "ip": [node IP address],
            "id": [node id],
            "memorylimit": [maximum memory space allowed to allocate to client VPS'es, Kb],
            "name": [node name],
            "node_error": [error message if remote call to node returned error],
            "nodegroupid": [node group ID],
            "nodegroupname": [node group name],
            "sshport": [SSH TCP port],
            "virt": [openvz|kvm|xen],
            "virtualservers": [virtual servers number]
        },
        {
            "allocatedbandwidth": 1048576,
            "allocatedmemory": 2097152,
            "arch": "x86_64",
            "city": "",
            "country": "",
            "disklimit": 1024000000,
            "freedisk": 69926912,
            "freeips": 1,
            "freeipv6": 0,
            "freeipv6subnets": 0,
            "freememory": 5146624,
            "hostname": "xen1.tld",
            "ip": "192.168.1.1",
            "id": 45,
            "memorylimit": 10240000,
            "name": "snxen1",
            "node_error": "",
            "nodegroupid": 0,
            "nodegroupname": "Default",
            "sshport": 22,
            "virt": "xen",
            "virtualservers": 1
        }
    ]
}

Error:

{
    "status": "error",
    "statusmsg": "ERROR MESSAGE",
    "nodes_statistics": null
}
Back to top