下载
中文
注册

查询所有节点列表

命令功能

查询所有节点列表。URL参数用于对数据的分页查询,返回数据库中的节点详情,以及这些节点加入的节点组。

命令格式

操作类型:GET

URLhttps://{ip}:{port}/edgemanager/v1/node/list?pageNum={pageNum}&pageSize={pageSize}&name={name}

URL参数

表1 URL参数

参数

类型

参数说明

取值要求

pageSize

必选

页面大小

取值为1~100的整数。

pageNum

必选

取值页数,为序数词

取值最小为1,最大值为2^31-1。

name

可选

模糊查找的搜索关键词

字符串,长度为0~253位的字符串,不能包含空白字符。

使用样例

请求样例:

GET https://10.10.10.10:30035/edgemanager/v1/node/list?pageNum=1&pageSize=20&name=node-1

响应样例:

{
   "status": "00000000",
   "msg": "success",
   "data": {
       "nodes": [
            {
                "createdAt": "2022-12-27 03:29:33",
                "description": "node_1_description",
                "id": 1,
                "ip": "xx.xx.xx.xx",
                "isManaged": true,
                "nodeGroup": "node_group_1",
                "nodeName": "node-1",
                "nodeType": "",
                "serialNumber": "xxxxxxxxxxxxx",
                "softwareInfo": "[{\"Name\":\"MEFEdge\",\"Version\":\"6.0.RC3\",\"InactiveVersion\":\"\"}]",
                "status": "ready",
                "uniqueName": "edge-66.67",
                "updatedAt": "2022-12-27 03:29:33"
             }
       ],
       "total": 1
   }
}

响应状态码:200

输出说明

表2 操作输出说明

参数

类型

参数说明

status

字符串

错误码

msg

字符串

描述信息

data

对象

查询结果

表3 data字段说明

参数

类型

参数说明

nodes

数组

查询结果节点详情

total

数字

查询到的节点总数

表4 nodes字段说明

参数

类型

参数说明

createdAt

字符串

节点创建时间

description

字符串

节点描述

id

数字

节点ID

ip

字符串

节点IP

isManaged

布尔值

节点是否被纳管

nodeGroup

字符串

节点加入的节点组名称,用英文逗号进行分割

nodeName

字符串

节点名

nodeType

字符串

节点类型

serialNumber

字符串

节点序列号

softwareInfo

字符串

节点软件信息

status

字符串

节点状态

  • ready:就绪
  • notReady:未就绪
  • unknown:未知
  • offline:掉线
  • abnormal:异常

uniqueName

字符串

节点主机名

updatedAt

字符串

节点修改时间