查询节点详情
此接口用于查询节点的详细信息。
接口描述
通信协议:HTTP
URL:GET /api/v1/overview/node
传参方式:query
请求参数
字段名 | 类型 | 是否必填 | 说明 |
---|
nodeId | string | 是 | 节点 ID |
instant | boolean | 是 | 是否获取实时数据 |
startTime | string | 否 | 查询开始时间,格式为 yyyy-MM-dd HH:mm:ss |
endTime | string | 否 | 查询结束时间,格式为 yyyy-MM-dd HH:mm:ss |
step | number | 否 | 步⻓,单位:秒 |
响应参数
字段名 | 类型 | 说明 |
---|
data | Node[ ] | 节点数据 |
Node
字段名 | 类型 | 说明 |
---|
timestamp | number | 时间戳 |
type | string | 节点类型,如 Linux、SylixOS 等 |
cpu | CPU | 节点 CPU 使⽤信息 |
rom | ROM | 节点磁盘使⽤情况 |
ram | RAM | 节点内存使⽤情况 |
processCount | number | 进程数 |
process | Process[ ] | 容器资源使用情况 |
upNet | Net[ ] | 上⾏流量(即网络流出) |
downNet | Net[ ] | 下⾏流量(即网络流⼊) |
upTime | number | 运⾏时⻓,当 instant 为 true 时返回该参数 |
running | number | 运⾏的容器数量,当 instant 为 true 时返回该参数 |
stop | number | 未运⾏的容器数量,当 instant 为 true 时返回该参数 |
CPU
字段名 | 类型 | 说明 |
---|
percent | number | CPU 使⽤百分⽐ |
ROM
字段名 | 类型 | 说明 |
---|
percent | number | 磁盘使⽤占⽐ |
size | number | 磁盘使⽤大小 |
RAM
字段名 | 类型 | 说明 |
---|
percent | number | 内存使⽤占⽐ |
size | number | 内存使⽤大小 |
Process
字段名 | 类型 | 说明 |
---|
name | string | 容器名称 |
cpu | CPU | 容器 CPU 使⽤信息 |
rom | ROM | 容器磁盘使⽤情况 |
ram | RAM | 容器内存使⽤情况 |
Net
字段名 | 类型 | 说明 |
---|
networkName | string | 网卡名称 |
value | number | 流量值 |
请求示例
curl --location --request GET 'http://localhost:3001/api/v1/overview/node?instant=true&nodeId=aa2123c8-2cef-4cdc-9ccf-df094584145b'
响应示例
{
"status": 200,
"message": "success",
"fieldErrors": null,
"data": [
{
"timestamp": 1672923016549,
"type": "service",
"cpu": {
"percent": "5.02"
},
"rom": {
"percent": "14.36",
"size": 5436.69921875
},
"ram": {
"percent": "63.30",
"size": 1219907584
},
"processCount": 114,
"process": [
{
"name": "auto-QelTs-",
"cpu": {
"percent": "0.01"
},
"ram": {
"percent": 0,
"size": 0
}
}
],
"upTime": 2003832.45,
"running": 1,
"stop": 0,
"upNet": [
{
"networkName": "lo",
"value": 0
},
{
"networkName": "ens3",
"value": 10123.3330078125
},
{
"networkName": "docker0",
"value": 0
},
{
"networkName": "veth7e1674b",
"value": 0
},
{
"networkName": "vethaad28df",
"value": 0
}
],
"downNet": [
{
"networkName": "lo",
"value": 0
},
{
"networkName": "ens3",
"value": 370
},
{
"networkName": "docker0",
"value": 0
},
{
"networkName": "veth7e1674b",
"value": 0
},
{
"networkName": "vethaad28df",
"value": 0
}
]
}
]
}
错误码
具体请参见 错误码说明。