Help Center/ Cloud Search Service/ API Reference/ APIs/ Cluster Management/ Scaling In a Cluster by Removing a Specific Node

Updated on 2024-10-17 GMT+08:00

View PDF

Scaling In a Cluster by Removing a Specific Node

Function

This API is used to scale in a cluster by removing a specified node.

Debugging

You can debug this API through automatic authentication in API Explorer.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/node/offline

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
cluster_id	Yes	String	ID of the cluster you want to scale in.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
migrate_data	No	String	Indicates whether to migrate data. The default value is true. "true": Migrate data. "false": Do not migrate data.
shrinkNodes	Yes	Array of strings	ID of the node you want to remove from a cluster. Obtain the ID attribute in instances by referring to Querying Cluster Details.

Response Parameters

None

Example Requests

Scale in a cluster by scaling in specified nodes.

POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/node/offline

{
  "shrinkNodes" : [ "2077bdf3-b90d-412e-b460-635b9b159c11" ],
  "migrate_data" : "true"
}

Example Responses

None

Status Codes

Status Code	Description
200	Request succeeded.
400	Invalid request. Modify the request before retry.
409	The request could not be completed due to a conflict with the current state of the resource. The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.
412	The server did not meet one of the preconditions contained in the request.