Querying Node Group Details

Function

Queries node group details. This API is used to return details about a node group and all nodes in the node group based on the specified node group ID.

Syntax

Operation type: GET

URL: https://{ip}:{port}/edgemanager/v1/nodegroup?id={id}

URL Parameters

**Table 1** URL parameter
Parameter	Mandatory/Optional	Description	Value
id	Mandatory	Node group ID	32-bit unsigned number. The minimum value is 1 and the maximum value is 2^32-1.

Usage Example

Request:

GET https://10.10.10.10:30035/edgemanager/v1/nodegroup?id=1

Response:

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

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 details

**Table 3** data field description
Parameter	Type	Description
createdAt	String	Time when a node group is created
updatedAt	String	Time when a node group is modified
description	String	Node group description
groupName	String	Node group name
id	Number	Node group ID
nodes	Array	Node details in a node group

**Table 4** nodes field description
Parameter	Type	Description
createdAt	String	Time when a node is created
description	String	Node description
nodeName	String	Node name
id	Number	Node ID
ip	String	Node IP address
isManaged	Boolean	Whether a node is managed
nodeType	String	Node type
status	String	Node status ready notReady unknown offline abnormal
uniqueName	String	Host name of a node
updatedAt	String	Time when a node is modified
serialNumber	String	Node SN
softwareInfo	String	Node software information

Parent topic: Node Group Management