Skip to main content
Skip table of contents

GetNodes. Clustеr. Mediaserver

Getting information about the nodes associated with the current node (secondary nodes) and their status

GET /api/cluster/backups/
Body
tokenrequired
string
Authorization token for API requests. See Mediaserver/Web API/Authorization/CreateApiToken
Response
200
Returns a JSON array of objects with information about the nodes
JSON
{
    "nodes": {
        "host-name-2": {
            "id": 102,
            "ltime": 0,
            "status": "pending",
            "host": "host-name-2"
        },
        "host-name-1": {
            "ltime": 1676801307,
            "id": 101,
            "status": "active",
            "ip": "127.0.0.1",
            "host": "host-name-1"
        }
    },
    "node_id": 101,
    "cluster_id": 6
}
int
node_idCurrent node ID
int
cluster_idCurrent cluster ID
string
nodes.hostNode host name
IP4
nodes.ipNode IP address
enum
nodes.statusNode status

undefined - The status is undefined. No message about the node status has been received yet.
unavailable - The node is unavailable. Possible reasons: wrong node host name or address, see Mediaserver/Configuration/Server (mediaserver.ini)
warming - The status is not received. The waiting time for starting the node after server restart has not yet expired.
active - The node is active.
invalid - The node status is invalid.
down - The node is no longer available. The number of attempts to determine its status has been exhausted.

timestamp
nodes.ltimeTime of the last node status check
int
nodes.idNode ID
403
Authorization error. Incorrect or missing API access token. See Mediaserver/Web API/Authorization/CreateApiToken
Example
JSON
curl -k --location --request GET 'https://localhost:8080/api/cluster/backups/?token=string'
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.