Querying a Node Group List

Function

Queries a node group list. URL parameters are used to query data by page and return created node groups, including the number of nodes in these node groups.

Syntax

Operation type: GET

URL: https://{ip}:{port}/edgemanager/v1/nodegroup/list?pageSize={pageSize}&pageNum={pageNum}&name={name}

URL Parameters

**Table 1** URL parameters
Parameter	Type	Description	Value
pageSize	Mandatory	Page size.	The value is an integer ranging from 1 to 100.
pageNum	Mandatory	Number of pages, which is an ordinal number.	The minimum value is 1 and the maximum value is 2^31-1.
name	Optional	Keyword for fuzzy search.	The value is a string of 0 to 253 characters and cannot contain whitespace characters.

Usage Example

Request:

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

Response:

{
   "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
   }
}

Response status code: 200

Output Description

**Table 2** Operation output description
Parameter	Type	Description
status	String	Error code
msg	String	Description
data	Object	Node group information

**Table 3** data field description
Parameter	Type	Description
groups	Array	Node group details
createdAt	String	Time when a node group is created
description	String	Node group description
groupName	String	Node group name
id	Number	Node group ID
nodeCount	Number	Total number of nodes in a node group
updatedAt	String	Time when a node group is modified
total	Number	Total number of node groups that meet the search criteria

Parent topic: Node Group Management