Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Instance Management/ Changing Node Names in Batches
Updated on 2024-09-11 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Changing Node Names in Batches

Function

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

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

To obtain the value, call the API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Content-Type

Yes

String

Content type.

Value: application/json

X-Language

No

String

Language.
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

node_list

Yes

Array of SingleNodeInfo objects

Node information.
Table 4 SingleNodeInfo

Parameter

Mandatory

Type

Description

node_id

Yes

String

Node ID.

name

Yes

String

Node name. The value can contain 4 to 128 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed.

Response Parameters

Status code: 200

Table 5 Response body parameter

Parameter

Type

Description

job_id

String

Workflow ID.

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

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Code

For details, see Error Codes.

Parent topic: Instance Management