Scaling Out a Cluster

Function

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

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
cluster_id	Yes	String	ID of the cluster you want to scale 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 you want to add. The total number of existing instances and newly added instances in a cluster cannot exceed 32.

Response Parameters

None

Example Requests

{
  "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.