获取平台所有服务器的运行状态信息,包括云平台虚拟机、MCU物理机、CRS录播物理机三类服务器的名称、序列号、IP地址、在线状态等关键信息。
默认接口请求频率限制:20次/秒
REST URL
GET /api/rest/external/{version}/ops/server/status/page?enterpriseId=xxx&type=virtual&startTime=xxxx&endTime=xxxx&pageIndex=0&pageSize=20请求参数说明
参数 | 参数类型 | 参数位置 | 是否必须 | 默认值 | 说明 | 初始平台 |
enterpriseId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 | 分区云5.2-20260327 公有云不存在 |
pageIndex | int | Query | 否 | 0 | 页码,默认为0 | 分区云5.2-20260327 公有云不存在 |
pageSize | int | Query | 否 | 20 | 每页大小,默认为20,最大不能超过100 | 分区云5.2-20260327 公有云不存在 |
type | String | Query | 否 | 无 | 服务器类型筛选:virtual(虚拟机)、 physical(物理机)。不传则查询全量。20260327迭代仅支持虚拟机,此参数无效 | 分区云5.2-20260626 公有云不存在 |
返回结果示例:
成功时返回200,失败时返回小鱼RESTAPI错误码
{
"page": 0,
"pageTotal": 1,
"rowsTotal": 3,
"rows": 3,
"list": [
{
"name": "sdk-node-01",
"serialNumber": "-",
"deviceType": "sdk",
"uniqueId": "sdk-node-01",
"internalIp": "192.168.1.10",
"internalIpV6":"2408:864e:c02:206:2000:2000:2000:200",
"externalIp": "203.0.113.1",
"externalIpV6":"2408:864e:c02:206:2000:2000:2000:200",
"status": "ONLINE",
"cpuUsagePercent": 15.8,
"memoryUsage": 256.5,
"memoryUsagePercent":20
},
{
"name": "CRS-Recorder-01",
"serialNumber": "SN987654321",
"deviceType": "crs",
"uniqueId": "987654321",
"internalIp": "192.168.1.30",
"externalIp": "203.0.113.3",
"internalIpV6":"2408:864e:c02:206:2000:2000:2000:200",
"externalIp": "203.0.113.1",
"externalIpV6":"2408:864e:c02:206:2000:2000:2000:200",
"status": "OFFLINE",
"cpuUsagePercent": 15.8,
"memoryUsage": 256.5,
"memoryUsagePercent":20
}
]
}
成功时返回结果数据,失败时返回小鱼RESTAPI错误码
返回参数说明
参数名称 | 说明 |
name | 服务器名称 |
serialNumber | 服务器序列号 |
deviceType | 设备类型 |
uniqueId | 服务器唯一标识ID |
internalIp | 内网IP地址 |
internalIpV6 | 内网IPV6地址 |
externalIp | 外网IP地址 |
externalIpV6 | 外网IPV6地址 |
status | 服务器状态 |
cpuUsagePercent | 当前 cpu使用率(%) |
memoryUsage | 当前内存占用(M) |
memoryUsagePercent | 当前内存使用率(%) |