Replacing a Node¶

Function¶

This API is used to replace a failed node.

Note

All mission-critical data has been backed up before a node replacement. This is to prevent data loss.

URI¶

PUT /v1.0/{project_id}/clusters/{cluster_id}/instance/{instance_id}/replace

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: The project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Constraints: N/A Options: For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Default value: N/A
cluster_id	Yes	String	Parameter description: ID of the cluster where nodes are to be replaced. Constraints: N/A Options: For details about how to obtain the cluster ID, see Obtaining the Cluster ID. Default value: N/A
instance_id	Yes	String	Parameter description: ID of the node to be replaced. Constraints: N/A Options: Node ID Obtain the ID attribute in instances by referring to Querying Cluster Details. Default value: N/A

**Table 2** Query Parameters¶
Parameter	Mandatory	Type	Description
migrateData	No	String	Parameter description: Whether to migrate data. The default value is true. Constraints: N/A Options: "true": Migrate data. "false": Do not migrate data. Default value: "true"
agency	No	String	Parameter description: Agency name. You can create an agency to allow CSS to call other cloud services. Constraints: This parameter is mandatory when the new IAM plane is connected. This parameter is optional when the old IAM plane is connected. Options: VPC permissions required by the agency: "vpc:subnets:get","vpc:ports:``". Default value*: N/A

Request Parameters¶

None

Response Parameters¶

None

Example Requests¶

PUT /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/instance/43e63449-339c-4280-a6e9-da36b0685995/replace?migrateData=true

Example Responses¶

None

Status Codes¶

Status Code	Description
200	Request succeeded.
400	Invalid request. The client should modify the request instead of re-initiating it.
404	The requested resource could not be found. The client should modify the request instead of re-initiating it.

Status Code

Description

200

Request succeeded.

400

Invalid request.

The client should modify the request instead of re-initiating it.

404

The requested resource could not be found.

The client should modify the request instead of re-initiating it.

Error Codes¶

See Error Codes.

last updated: 2025-06-18 14:34 UTC - commit: 2d2985861d5de200e20afb5eb8b159b4bf768d7b