Scaling Out a Cluster

Function

This API is used to add instances (Elasticsearch instances only) to a cluster. This API can only scale out clusters that only have common nodes. You cannot use this API to scale out a cluster that has master, client, or cold data nodes. For details about how to configure the number and storage capacity of instances in a cluster, see the API for Adding Instances and Expanding Instance Storage Capacity.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/extend

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID and name, see Obtaining a Project ID and Name.
cluster_id	Yes	String	ID of the cluster to be scaled out.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
grow	Yes	ExtendClusterGrowReq object	Detailed description about the cluster scale-out request.

**Table 3** ExtendClusterGrowReq
Parameter	Mandatory	Type	Description
modifySize	Yes	Integer	Number of instances to be scaled out. The total number of existing instances and newly added instances in a cluster cannot exceed 32.

Response Parameters

None

Example Requests

Change the number of instances in the current cluster.

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

{
  "grow" : {
    "modifySize" : 4
  }

}

Example Responses

None

Status Codes

Status Code	Description
200	Request succeeded.
400	Invalid request. Modify the request before retry.
404	The requested resource could not be found. Modify the request before retry.

Status Code

Description

200

Request succeeded.

400

Invalid request.

Modify the request before retry.

404

The requested resource could not be found.

Modify the request before retry.