Status

Query conference server status

Retrieve a conference server's status.

GEThttp://127.0.0.1:8888/api/conference_servers/{id}/status

Path parameters

id*all of

The unique ID of conference server.

Response

2004XX

OK

Body

application/json

rooms_countinteger

The number of rooms for conference server.

participants_countinteger

The number of participants for conference server.

cpu_usageinteger

CPU usage.

memory_usageinteger

Memory usage.

statusenum

Conference room's status:

• ONLINE: room is online.
• OFFLINE: room is offline.

ONLINEOFFLINE

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/conference_servers/{id}/status', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "rooms_count": 0,
  "participants_count": 0,
  "cpu_usage": 0,
  "memory_usage": 0,
  "status": "ONLINE"
}