Querying Node Details

Function

Queries node details. In addition to the node information in the database, this API also contains the CPU, NPU, and memory resource data of a node.

Syntax

Operation type: GET

URL: https:// {ip}:{port}/edgemanager/v1/node?id={id} or https://{ip}:{port}/edgemanager/v1/node?sn={sn}

URL Parameters

**Table 1** URL parameters
Parameter	Mandatory/Optional	Description	Value
id	Mandatory. One of these two parameters must be selected.	Node ID	32-bit unsigned number. The minimum value is 1 and the maximum value is 2^32-1.
sn	Mandatory. One of these two parameters must be selected.	Node SN	The value can contain lowercase letters, uppercase letters, digits, underscores (_), and hyphens (-). It cannot start or end with an underscore (_) or hyphen (-). The maximum length is 64 bytes.

Usage Example

Request:

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

Response:

{
    "status": "00000000",
    "msg": "success",
    "data": {
                 "cpu": 24,
                 "createdAt": "2022-12-27 03:29:33",
                 "description": "node_1_description",
                 "id": 1,
                 "ip": "xx.xx.xx.xx",
                 "isManaged": true,
                 "memory": 33408877724,
                 "nodeGroup": "node_group_1",
                 "nodeName": "node-1",
                 "nodeType": "",
                 "npu": 0,
                 "serialNumber": "xxxxxxxxxxxxxx",
                 "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	Query result

**Table 3** data field description
Field	Type	Description
cpu	Number	Number of CPUs
createdAt	String	Creation time
description	String	Node description
id	Number	Node ID
ip	String	Node IP address
isManaged	Boolean	Whether a node is managed
memory	Number	Node memory, in byte
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
npu	Number	Number of NPUs
serialNumber	String	Node SN
softwareInfo	String	Node software information
status	String	Node status ready notReady unknown abnormal offline
uniqueName	String	Host name of a node
updatedAt	String	Modification time

Parent topic: Node Management