/api/system/status

获取系统状态。

接口原型

协议 HTTP/HTTPS GET
URL ip[:port]/api/system/status
数据格式 响应消息:Content-Type: application/json

请求Cookies

名称 描述
mwcloud-sid 用于标识当前登录的字符串
mwcloud-uid 当前登录用户名

请求URL参数

参数 描述
global-config 设置为非零将在返回信息中提供全局默认配置信息

请求示例

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

响应参数

Response Header
参数 描述
Content-Type 取值为:'application/json; charset=UTF-8'
Response Body
参数 描述
result 返回码
status 服务器状态,参考服务器状态
服务器状态
参数 描述
system 状态统计信息,参考状态统计信息
license-reg 授权状态,参考授权状态
cur-license 当前授权信息,参考授权信息
pwd-rule 密码相关配置
global-config 当参数global-config不为0时提供, 其中字段device参考设备连接全局配置信息
状态统计信息
参数 描述
channel 通道全局统计信息,参考通道全局统计信息
client 客户端全局统计信息,参考客户端全局统计信息
device 设备全局统计信息,参考设备全局统计信息
info 系统信息,参考系统信息
output 输出节点全局统计信息,参考输出节点全局统计信息
status 系统状态统计信息,参考系统状态统计信息
系统信息
参数 描述
date-time 服务器当前系统时间,单位秒
cloud-version ControlHub版本号
hardware-ver ControlHub硬件版本,如果没有则代表为软件版
expired-time 用户登录会话超时时间,单位分钟
系统状态统计信息
参数 描述
cpu 当前cpu使用率
disk-info 存储空间信息,参考存储空间信息
mem 当前内存使用比例
net-tx 当前网络发送流量,单位Mbps
net-rx 当前网络接收流量,单位Mbps
status-code 运行状态掩码,参考运行状态码
运行状态码
描述
0 空闲
0x1000 存在可更新的版本
0x2000 系统正在重启
0x4000 srt服务启动失败
0x8000 系统正在升级
0x10000 系统正在重置中
0x20000 系统正在导入配置中

运行状态码会包含叠加更新服务状态码

存储空间信息
参数 描述
total 存储空间总大小,单位MB
free 存储空间剩余大小,单位MB
设备全局统计信息
参数 描述
num-all 总设备数量
num-online 在线设备数量
num-pending 等待批准的设备数量
num-warn 当前存在警告的设备数量
通道全局统计信息
参数 描述
num-all 当前通道数量
num-enable 当前启用的通道数量
输出节点全局统计信息
参数 描述
num-enable 当前使用的输出节点总数
客户端全局统计信息
参数 描述
num-all 当前客户端总数
授权状态
参数 描述
status 授权证书的状态码
user-name 证书标题。
sn 证书序列号。
license 已授权证书的权限信息,参考 授权信息
授权证书状态码
描述
0 授权状态正常
-10 授权无效
-14 授权不存在
-20 没有授权
-107 授权过期
-109 授权错误
-110 授权被终止
-111 授权被其它设备占用
授权信息
参数 描述
limited-date 授权到期时间,单位:秒
max-dev-count 最多允许管理的设备个数
max-channel-count 同时可创建的最大通道数量
max-stream-count 可加入通道的最大输出流总数(输出节点)

除了license限制之外,还有以下固定限制:

  • 可创建的通道数量限制:参考值100
  • 全局可启用的输出节点数量限制:参考值50
  • 可创建的输入节点数量限制:最多100个
  • 可创建的输出节点数量限制:最多100个

响应示例

{
    "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
                }
            }
        },
        "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
            }
        }
    }
}

与“”相关结果约

    找不到与“”相关的结果

    与“”相关结果约

      找不到与“”相关的结果