Querying the List of All Nodes

Function

Queries the list of all nodes. URL parameters are used to query data by page and return node details in the database and the node groups to which nodes are added.

Syntax

Operation type: GET

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

Response:

{
   "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.0\",\"InactiveVersion\":\"\"}]",
                "status": "ready",
                "uniqueName": "edge-66.67",
                "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	Query result

**Table 3** data field description
Parameter	Type	Description
nodes	Array	Queried node details
total	Number	Total number of queried nodes

**Table 4** nodes field description
Parameter	Type	Description
createdAt	String	Time when a node is created
description	String	Node description
id	Number	Node ID
ip	String	Node IP address
isManaged	Boolean	Whether a node is managed
nodeGroup	String	Name of the node group to which a node is added. Use commas (,) to separate multiple names.
nodeName	String	Node name
nodeType	String	Node type
serialNumber	String	Node SN
softwareInfo	String	Node software information
status	String	Node status ready notReady unknown offline abnormal
uniqueName	String	Host name of a node
updatedAt	String	Time when a node is modified

Parent topic: Node Management