Updated on 2026-03-16 GMT+08:00

Changing Node Names in Batches

Function

This API is used to change node names in batches. Before calling this API:

Learn how to authenticate it.
Obtain the required region and endpoint.

URI

PUT /v3/{project_id}/instances/{instance_id}/nodes/name

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
Content-Type	Yes	String	Definition Content type. Constraints N/A Range application/json Default Value application/json
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

**Table 3** Request body parameter
Parameter	Mandatory	Type	Description
node_list	Yes	Array of SingleNodeInfo objects	Definition Node information. Constraints N/A

**Table 4** SingleNodeInfo
Parameter	Mandatory	Type	Description
node_id	Yes	String	Definition Node ID. Constraints N/A Range The value contains 36 characters, starting with a UUID and ending with no07. Only letters and digits are allowed. Default Value N/A
name	Yes	String	Definition Node name. Constraints N/A Range The name must start with a letter and consist of 4 to 128 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. Default Value N/A

Response Parameters

Status code: 200

**Table 5** Response body parameter
Parameter	Type	Description
job_id	String	Definition Workflow ID. Range N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Changing node names in batches

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/61a4ea66210545909d74a05c27a7179ein07/nodes/name

{
  "node_list" : [ {
    "node_id" : "799a0f2fa49d4151bf2f7063c1fbba36no07",
    "name" : "gauss-cdf5_node03"
  } ]
}

Example Response

Status code: 200

Success.

{
  "job_id" : "dff1f289-4d23-4942-8d9f-463ea07c010d"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Instance Management