Modifying a Node Group

Function

Modifies the node group information. This API is used to modify node group parameters based on a specified node group ID. Currently, only the node group name and node group description can be modified.

Syntax

Operation type: PATCH

URL: https://{ip}:{port}/edgemanager/v1/nodegroup

Request message body:

{
    "groupID": NodeGroupId,
    "nodeGroupName": NodeGroupName,
    "description": NodeGroupDescription
}

Request Parameters

**Table 1** Description
Parameter	Mandatory/Optional	Description	Value
groupID	Mandatory	Node group ID	32-bit unsigned number. The minimum value is 1 and the maximum value is 2^32-1.
nodeGroupName	Mandatory	Node group name	The value is a string of 1 to 32 characters, including uppercase letters, lowercase letters, digits, and underscores (_). It must start with an uppercase letter or lowercase letter and cannot end with an underscore (_). The name of an edge node group name is unique.
description	Optional	Node group 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/nodegroup

Request message body:

{
    "groupID": 1,
    "nodeGroupName": "node_group_1",
    "description": "node_group_1_descrption"
}

Response:

{
    "status": "00000000",
    "msg": "success"
}

Response status code: 200

Output Description

**Table 2** Operation output description
Parameter	Type	Description
status	String	Error code
msg	String	Description

Parent topic: Node Group Management