查询节点状态
此接口用于根据节点 ID 列表查询节点的状态信息。
接口描述
通信协议:HTTP
URL:GET /api/v1/node/status
传参方式:query
请求参数
字段名 | 类型 | 是否必填 | 说明 |
---|---|---|---|
ids | string[ ] | 是 | 节点 ID 列表 |
响应参数
字段名 | 类型 | 说明 |
---|---|---|
id | string | 节点 ID |
status | string | 节点状态。online 表示在线;offline 表示离线 |
memoryTotal | number | 内存总量 |
memoryFree | number | 剩余内存空间 |
diskTotal | number | 磁盘总量 |
diskFree | number | 剩余磁盘容量 |
cpuUsage | CpuUsage | 节点 CPU 使用情况 |
uptime | number | 节点运⾏时⻓,单位为 s |
processCount | number | 进程数量 |
containerTotal | number | 容器总数量 |
containerRunning | number | 上线容器数量 |
containerEcsmTotal | number | ECSM 管理的容器总数 |
containerEcsmRunning | number | ECSM 管理的运行的容器数量 |
net | Net | 网络情况 |
time | Time | 时区信息 |
CpuUsage
字段名 | 类型 | 说明 |
---|---|---|
total | number | CPU 使⽤百分⽐ |
cores | number[ ] | 多核 CPU 使⽤百分⽐ |
Net
字段名 | 类型 | 说明 |
---|---|---|
networkName | string | ⽹卡名称 |
upNet | number | 节点网络流出,单位为 B/S |
downNet | number | 节点网络流⼊,单位为 B/S |
Time
字段名 | 类型 | 说明 |
---|---|---|
current | number | 当前时间,单位为 ms |
uptime | number | 运行时间,单位为 s |
timezone | string | 时区,如 GMT+0000 |
timezoneName | string | 时区名称,如 UTC |
请求示例
curl --location -g --request GET 'http://localhost:3001/api/v1/node/status?ids[]=aa2123c8-2cef-4cdc-9ccf-df094584145b'
响应示例
{
"status": 200,
"message": "success",
"fieldErrors": null,
"data": {
"nodes": [
{
"id": "aa2123c8-2cef-4cdc-9ccf-df094584145b",
"status": "online",
"memoryTotal": 1927311360,
"diskTotal": 37865.50390625,
"memoryFree": 867815424,
"diskFree": 32500.6640625,
"cpuUsage": {
"total": 5.35,
"cores": [
5.35
],
"measureTime": 3000
},
"time": {
"current": 1672921642381,
"uptime": 2002458.28,
"timezone": "GMT+0800",
"timezoneName": "Asia/Shanghai",
"date": "2023-01-05T12:27:22.381Z"
},
"eapTotal": 0,
"eapRunning": 0,
"uptime": 2002458.28,
"processCount": 110,
"containerTotal": 0,
"containerRunning": 0,
"containerEcsmTotal": 0,
"containerEcsmRunning": 0,
"net": [
{
"networkName": "lo",
"upNet": 0,
"downNet": 0
},
{
"networkName": "ens3",
"upNet": 8764,
"downNet": 298
},
{
"networkName": "docker0",
"upNet": 0,
"downNet": 0
},
{
"networkName": "veth7e1674b",
"upNet": 0,
"downNet": 0
}
]
}
]
}
}
错误码
具体请参见 错误码说明。