Viewing a media server cluster

GET /api/admin/v1/clusters/{cluster}

Method parameters

int cluster, unique identifier of the media server cluster

200 OK

Successful response

JSON

{
    "id": 1,
    "name": "Cluster 1",
    "type": "main-secondary",
    "internal": null,
    "external": null,
    "m4f": null,
    "rtsp": null,
    "publish": null,
    "streams_limit": null,
    "bitrate_limit": null,
    "created_at": "2021-05-27 17:14:21",
    "updated_at": "2021-12-29 13:11:13",
    "servers": [
        {
            "id": 1,
            "type": "media_server_v2",
            "schema": "https",
            "domain": "labMS3.vms.local",
            "internal": "8080",
            "external": "8443",
            "m4f": "8443",
            "rtsp": "5554",
            "publish": "7554",
            "traffic_in": 30577,
            "traffic_out": 49870,
            "status": 1,
            "is_enabled": 1,
            "is_main": 1,
            "has_cache": 0,
            "proxy": "vms.local",
            "created_at": "2021-05-27 16:07:46",
            "updated_at": "2022-05-26 16:58:02",
            "group_type": "all",
            "can_delete": false,
            "streams_limit": 1000,
            "bitrate_limit": 600000,
            "extra": {
                "io": {
                    "read_rate": 0,
                    "read_bytes": 0,
                    "write_rate": 0,
                    "write_bytes": 0
                },
                "cpu": {
                    "total": 12,
                    "usage": 7,
                    "stime_sec": 167,
                    "utime_sec": 167
                },
                "mem": {
                    "rss": 554659840,
                    "share": 10706944,
                    "usage": 2749591552
                },
                "net": {
                    "in_bitrate": 31310768,
                    "out_bitrate": 51066864
                },
                "drives": {
                    "/": {
                        "fs": "ext4",
                        "mount": "/",
                        "inode_free": 1464407,
                        "inode_total": 1589248,
                        "capacity_free": 15008972800,
                        "capacity_total": 25491165184
                    },
                    "none": {
                        "fs": "swap",
                        "mount": "none",
                        "inode_free": 0,
                        "inode_total": 0,
                        "capacity_free": 0,
                        "capacity_total": 0
                    },
                    "/boot": {
                        "fs": "ext4",
                        "mount": "/boot",
                        "inode_free": 97988,
                        "inode_total": 98304,
                        "capacity_free": 1333460992,
                        "capacity_total": 1551745024
                    },
                    "/storage": {
                        "fs": "ext4",
                        "mount": "/storage",
                        "inode_free": 32749801,
                        "inode_total": 32768000,
                        "capacity_free": 16777216,
                        "capacity_total": 527371075584
                    }
                },
                "server": {
                    "ip4": "192.168.200.15",
                    "name": "MS-21.03-lts",
                    "build": "7c80c1d",
                    "uptime": 5279,
                    "startat": 1653568203,
                    "version": "21.03",
                    "hostname": "labMS3.vms.local",
                    "revision": "lts",
                    "timestamp": "20220524110654"
                },
                "cluster": {
                    "id": "100",
                    "node": "3",
                    "enable": "true",
                    "hostname": "labMS3.vms.local"
                },
                "license": {
                    "own": "Vms",
                    "type": "enterprise",
                    "issued": 1685109482
                },
                "streams": {
                    "total": 54,
                    "active": 17,
                    "clients": 18
                },
                "storages": {
                    "/storage": {
                        "fs": "",
                        "err": 0,
                        "name": "default",
                        "mount": "/storage",
                        "inode_free": 32749801,
                        "inode_total": 32768000,
                        "capacity_free": 16777216,
                        "capacity_total": 527371075584
                    },
                    "/storage2": {
                        "fs": "",
                        "err": -2,
                        "name": "secondary",
                        "mount": "/storage2",
                        "inode_free": 0,
                        "inode_total": 0,
                        "capacity_free": 0,
                        "capacity_total": 0
                    }
                }
            }
        },
        {
            "id": 2,
            "type": "media_server_v2",
            "schema": "https",
            "domain": "labMS4.vms.local",
            "internal": "8080",
            "external": "8443",
            "m4f": "8443",
            "rtsp": "5554",
            "publish": "7554",
            "traffic_in": 22934,
            "traffic_out": 2169,
            "status": 1,
            "is_enabled": 1,
            "is_main": 0,
            "has_cache": 0,
            "proxy": ".vms.local",
            "created_at": "2021-05-27 16:08:57",
            "updated_at": "2022-05-26 16:58:02",
            "group_type": "all",
            "can_delete": false,
            "streams_limit": 1000,
            "bitrate_limit": 60000,
            "extra": {
                "io": {
                    "read_rate": 0,
                    "read_bytes": 0,
                    "write_rate": 0,
                    "write_bytes": 0
                },
                "cpu": {
                    "total": 5,
                    "usage": 7,
                    "stime_sec": 3164,
                    "utime_sec": 3164
                },
                "mem": {
                    "rss": 659566592,
                    "share": 10604544,
                    "usage": 2929971200
                },
                "net": {
                    "in_bitrate": 23484704,
                    "out_bitrate": 2221376
                },
                "drives": {
                    "/": {
                        "fs": "ext4",
                        "mount": "/",
                        "inode_free": 1427983,
                        "inode_total": 1589248,
                        "capacity_free": 14462369792,
                        "capacity_total": 25491165184
                    },
                    "none": {
                        "fs": "swap",
                        "mount": "none",
                        "inode_free": 0,
                        "inode_total": 0,
                        "capacity_free": 0,
                        "capacity_total": 0
                    },
                    "/boot": {
                        "fs": "ext4",
                        "mount": "/boot",
                        "inode_free": 97984,
                        "inode_total": 98304,
                        "capacity_free": 1230381056,
                        "capacity_total": 1551745024
                    },
                    "/storage": {
                        "fs": "ext4",
                        "mount": "/storage",
                        "inode_free": 32743795,
                        "inode_total": 32768000,
                        "capacity_free": 91621679104,
                        "capacity_total": 527371075584
                    }
                },
                "server": {
                    "ip4": "192.168.200.16",
                    "name": "MS-21.03-lts",
                    "build": "7c80c1d",
                    "uptime": 104760,
                    "startat": 1653468722,
                    "version": "21.03",
                    "hostname": "labMS4.vms.local",
                    "revision": "lts",
                    "timestamp": "20220524110654"
                },
                "cluster": {
                    "id": "100",
                    "node": "4",
                    "enable": "true",
                    "hostname": "labMS4.vms.local"
                },
                "license": {
                    "own": "Vms",
                    "type": "enterprise",
                    "issued": 1685109482
                },
                "streams": {
                    "total": 54,
                    "active": 22,
                    "clients": 2
                },
                "storages": {
                    "/storage": {
                        "fs": "",
                        "err": 0,
                        "name": "default",
                        "mount": "/storage",
                        "inode_free": 32743795,
                        "inode_total": 32768000,
                        "capacity_free": 91621679104,
                        "capacity_total": 527371075584
                    },
                    "/storage2": {
                        "fs": "",
                        "err": -2,
                        "name": "secondary",
                        "mount": "/storage2",
                        "inode_free": 0,
                        "inode_total": 0,
                        "capacity_free": 0,
                        "capacity_total": 0
                    }
                }
            }
        }
    ]
}

401 Unauthorized

Authorization token is not provided or is invalid. Obtaining a token

cURL

BASH

curl -k --request POST \
	--url 'https://your-domain/api/admin/v1/clusters/{cluster}' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "cluster": 0
}'

PHP

$data = array (
  'cluster' => 0,
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'GET',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/admin/v1/clusters/{cluster}', false, $context);