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

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 the API for Adding Instances and Expanding Instance Storage Capacity.

Debugging

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

URI

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

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 out.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

grow

Yes

ExtendClusterGrowReq object

Detailed description about the cluster scale-out request.

isAutoPay

No

Integer

Whether to enable automatic payment from your Huawei Cloud account. This parameter takes effect only for yearly/monthly clusters.

  • 1: Yes. (Discounts and coupons are automatically selected. The fee will be automatically deducted from your Huawei Cloud account.) If the automatic payment fails, an unpaid order will be generated, and you need to manually complete the payment. (During manual payment, you can still modify the discounts and coupons that were automatically selected.)

  • 0: No. (The customer needs to manually pay for the bill. Discounts and coupons can be used.) The default value is 0.

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

Change the number of instances in the current cluster.

POST /v1.0/6204a5bd270343b5885144cf9c8c158d/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.