Help Center/ Cloud Search Service/ API Reference/ API V1/ Modify Configuration/ Scaling Out a Cluster (Discarded)
Updated on 2025-11-28 GMT+08:00
View PDF

Scaling Out a Cluster (Discarded)

Function

This API is used to add data nodes to an Elasticsearch or OpenSearch cluster. You are advised to use 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 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

Constraints:

N/A

Value range:

Project ID of the account.

Default value:

N/A

cluster_id

Yes

String

Definition:

ID of the cluster you want to scale out. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

Constraints:

N/A

Value range:

Cluster ID.

Default value:

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

grow

Yes

ExtendClusterGrowReq object

Definition:

Detailed description about the cluster scale-out request.

Constraints:

N/A

Value range:

N/A

Default value:

N/A
Table 3 ExtendClusterGrowReq

Parameter

Mandatory

Type

Description

modifySize

Yes

Integer

Definition:

Number of instances to be scaled out. The total number of existing instances and newly added instances in a cluster cannot exceed 32.

Constraints:

N/A

Value range:

1-32

Default value:

N/A

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Change the number of instances in the current cluster.

POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/extend

{
  "grow" : {
    "modifySize" : 4
  },
  "isAutoPay" : 1
}

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.

Error Codes

See Error Codes.

Parent topic: Modify Configuration