下载
中文
注册

查询节点组列表

命令功能

查询节点组列表。URL参数用于对数据的分页查询,返回已创建的节点组,以及这些节点组包含的节点总数。

命令格式

操作类型:GET

URL:https://{ip}:{port}/edgemanager/v1/nodegroup/list?pageSize={pageSize}&pageNum={pageNum}&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/nodegroup/list?pageSize=20&pageNum=1&name=group1

响应样例:

{
   "status": "00000000",
   "msg": "success",
   "data": {
       "groups": [
           {
                "createdAt": "2022-12-27 03:29:33",
                "description": "node_group_description",
                "groupName": "node_group_name",
                "id": 1,
                "nodeCount": 1,
                "updatedAt": "2022-12-27 03:29:33"
           }
       ],
       "total": 1
   }
}

响应状态码:200

输出说明

表2 操作输出说明

参数

类型

参数说明

status

字符串

错误码

msg

字符串

描述信息

data

对象

节点组信息

表3 data字段说明

参数

类型

参数说明

groups

数组

节点组详情

createdAt

字符串

节点组创建时间

description

字符串

节点组描述

groupName

字符串

节点组名称

id

数字

节点组ID

nodeCount

数字

该节点组的节点总数

updatedAt

字符串

节点组修改时间

total

数字

符合条件的节点组总数