查询节点详情

更新时间:
2025-01-14

查询节点详情

此接口用于查询节点的详细信息。

接口描述

通信协议:HTTP

URL:GET /api/v1/overview/node

传参方式:query

请求参数

字段名 类型 是否必填 说明
nodeIdstring节点 ID
instantboolean是否获取实时数据
startTimestring查询开始时间,格式为 yyyy-MM-dd HH:mm:ss
endTimestring查询结束时间,格式为 yyyy-MM-dd HH:mm:ss
stepnumber步⻓,单位:秒

响应参数

字段名 类型 说明
dataNode[ ]节点数据

Node

字段名 类型 说明
timestampnumber时间戳
typestring节点类型,如 Linux、SylixOS 等
cpuCPU节点 CPU 使⽤信息
romROM节点磁盘使⽤情况
ramRAM节点内存使⽤情况
processCountnumber进程数
processProcess[ ]容器资源使用情况
upNetNet[ ]上⾏流量(即网络流出)
downNetNet[ ]下⾏流量(即网络流⼊)
upTimenumber运⾏时⻓,当 instant 为 true 时返回该参数
runningnumber运⾏的容器数量,当 instant 为 true 时返回该参数
stopnumber未运⾏的容器数量,当 instant 为 true 时返回该参数

CPU

字段名 类型 说明
percentnumberCPU 使⽤百分⽐

ROM

字段名 类型 说明
percentnumber磁盘使⽤占⽐
sizenumber磁盘使⽤大小

RAM

字段名 类型 说明
percentnumber内存使⽤占⽐
sizenumber内存使⽤大小

Process

字段名 类型 说明
namestring容器名称
cpuCPU容器 CPU 使⽤信息
romROM容器磁盘使⽤情况
ramRAM容器内存使⽤情况

Net

字段名 类型 说明
networkNamestring网卡名称
valuenumber流量值

请求示例

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
                }
            ]
        }
    ]
}

错误码

具体请参见 错误码说明

文档内容是否对您有所帮助?
有帮助
没帮助