/api/system/status

Use this interface to get system status.

Prototype

Protocol HTTP/HTTPS GET
URL ip[:port]/api/system/status
Content-Type Response: Content-Type: application/json

Request Cookies

Parameter Description
mwcloud-sid A string that is used to identify current logged-in user.
mwcloud-uid Current logged-in username.

Request URL parameters

Parameter Description
global-config Setting to non-zero will provide global default configuration information in the returned information.

Request Example

GET /api/system/status HTTP/1.1
Accept: application/json, text/plain, */*
Cookie: mwcloud-sid=OCXWUMGEYPGIAWWOETYXPNMVHDZIAZJP; mwcloud-uid=Admin;

Response Parameters

Response Header
Parameter Description
Content-Type Value: 'application/json; charset=UTF-8'
Response Body
Parameter Description
result Result code
status Server status, refer to server status
Server Status
Parameter Description
system Server status, refer to Server status.
license-reg License status, refer to license status.
cur-license Current license, refer to license information
pwd-rule Password settings
global-config When the parameter global-config is not 0, the field device is provided, which refers to the Device Connection Global Configuraions.
Status Statistics Information
Parameter Description
channel Channel global statistics, see channel global statistics
client Client global statistics, see client global statistics
device device global statistics, refer to device global statistics
info system info, refer to system info
output Output node global statistics, refer to Output Node Global Statistics
status System status statistics, refer to System Status Statistics
System Information
Parameter Description
date-time Current server system time, in seconds.
cloud-version ControlHub version number.
hardware-ver ControlHub hardware version. If the field is not included, it represents the software version.
expired-time Session timeout for users, in minutes.
System Status Statistics
Parameter Description
cpu Current CPU usage
disk-info Storage space information, refer to Storage Space Information
mem Current memory usage ratio
net-tx Current network transmission traffic, in Mbps
net-rx Current network reception traffic, in Mbps
status-code Running status mask, refer to Status Codes
Running Status Code
Code Description
0 Idle
0x1000 There is a new version available
0x2000 System is rebooting
0x4000 SRT service startup failed
0x8000 System is updating
0x10000 System is resetting all settings
0x20000 System is importing configurations
0x40000 Insufficient system memory to run properly

The running status code will bitwise OR operator with updating service status code.

Storage space information
Parameter Description
total Total storage space, in MB.
free Free storage space size, in MB
Device Global Statistics
Parameter Description
num-all Total number of devices
num-online Number of online devices
num-pending Number of devices pending approval
num-warn Number of devices with warnings
Channel Global Statistics
Parameter Description
num-all Current channel count
num-enable Current enabled channel count
Output Node Global Statistics
Parameter Description
num-enable Current total number of outputs in use
Clients Global Statistical
Parameter Description
num-all Current total number of clients
License Status
Parameter Description
status License Certificate Status Code
user-name Certificate Title.
sn Certificate Serial Number.
license Licensed certificate permissions, refer to License Information.
License Status
Value Description
0 normal
-10 Invalid
-14 Not exists
-20 No license
-107 expired
-109 error
-110 terminated
-111 occupied by other device
License
Parameter Description
limited-date Expiry time of the license, precision to the second.
max-dev-count Maximum number of devices allowed
max-channel-count Maximum number of channels that can be created
max-stream-count Maximum total number of output streams that can be added to a channel (output nodes)

In addition to the license restrictions, there are the following limitations:

  • Channel creation limit: 100 (reference value)
  • Global output node enabled limit: 50 (reference value)
  • Input node creation limit: 100 maximum
  • Output node creation limit: 100 maximum

Response Example

{
    "result": 0,
    "status": {
        "cur-license": {
            "limited-date": 1842912000,
            "max-channel-count": 1000,
            "max-dev-count": 1000,
            "max-stream-count": 1000
        },
        "global-config": {
            "device": {
                "input": {
                    "protocol": 1,
                    "stream-index": 0
                },
                "output": {
                    "buffer-ms": 120,
                    "protocol": 1
                }
            },
            "channel":{
                "def-ndi-enable":true,
                "ndi-group":"public",
                "ndi-transport-mode":3  
            },
            "ndi-discovery":{
                "addr":"10.10.14.211"
            }
        },
        "license-reg": {
            "license": {
                "limited-date": 1842912000,
                "max-channel-count": 1000,
                "max-dev-count": 1000,
                "max-stream-count": 1000
            },
            "sn": "5222************************1345",
            "status": 0,
            "user-name": "test-ag5"
        },
        "pwd-rule": {
            "chk-name": 0,
            "length": 0,
            "number": 0,
            "special": 0,
            "uppercase": 0
        },
        "system": {
            "channel": {
                "num-all": 54,
                "num-enable": 2
            },
            "client": {
                "num-all": 0
            },
            "device": {
                "num-all": 47,
                "num-online": 20,
                "num-pending": 2,
                "num-warn": 27
            },
            "info": {
                "cloud-version": "2.1.28",
                "date-time": 1694400221,
                "expired-time": 30
            },
            "output": {
                "num-enable": 28
            },
            "status": {
                "cpu": 9,
                "disk-info": {
                    "free": 13298,
                    "total": 31114
                },
                "mem": 65,
                "net-rx": 8.4591809216443,
                "net-tx": 0.10232094887856606,
                "status-code": 0
            }
        }
    }
}

results matching ""

    No results matching ""