Modifying Managed Nodes
Function
Modifies nodes based on the specified node IDs. Currently, only the node name and node description can be modified.
Syntax
Operation type: PATCH
URL: https://{ip}:{port}/edgemanager/v1/node
Request message body:
{
"nodeID": NodeId,
"nodeName": NodeName,
"description": NodeDescription
}
Request Parameters
Parameter |
Mandatory/Optional |
Description |
Value |
|---|---|---|---|
nodeID |
Mandatory |
Node ID |
32-bit unsigned number. The minimum value is 1 and the maximum value is 2^32-1. |
nodeName |
Mandatory |
Node name |
The value is a string of 1 to 64 characters, including uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). It cannot start or end with an underscore (_) or hyphen (-). |
description |
Optional |
Node description |
The value is a string of 0 to 512 characters, including non-whitespace characters and spaces. |
Usage Example
Request:
PATCH https://10.10.10.10:30035/edgemanager/v1/node
Request message body:
{
"nodeID": 1,
"nodeName": "node-1",
"description": "node_1_description"
}
Response:
{
"status": "00000000",
"msg": "success"
}
Response status code: 200
Output Description
Parameter |
Type |
Description |
|---|---|---|
status |
String |
Error code |
msg |
String |
Description |