Querying the List of Nodes That Are Not Managed by MindEdge Framework

Function

Queries the list of nodes that are not managed by MindEdge Framework. URL parameters are used to query data by page and return details about unmanaged nodes.

Unmanaged nodes do not contain nodes where the MEF Center software package is installed.

Syntax

Operation type: GET

URL: https://{ip}:{port}/edgemanager/v1/node/list/unmanaged?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/unmanaged?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": false,
                "nodeName": "node-1",
                "nodeType": "",
                "serialNumber": "xxxxxxxxxxxxxxx",
                "softwareInfo": "",
                "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

Details about nodes that are not managed

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 (identifier for node management)

ip

String

Node IP address

isManaged

Boolean

Whether a node is managed

nodeType

String

Node type

nodeName

String

Node name

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