Help Center/ Cloud Search Service/ API Reference/ APIs/ Cluster Management/ Adding Instances and Expanding Instance Storage Capacity

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

View PDF

Adding Instances and Expanding Instance Storage Capacity

Function

This API is used to add instances of different types and expand instance storage capacity in a cluster. This API is available for clusters with master, client, or cold data nodes.

Debugging

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

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/role_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	Array of RoleExtendGrowReq objects	Detailed description about the cluster scale-out request.
isAutoPay	No	Integer	Indicates 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** RoleExtendGrowReq
Parameter	Mandatory	Type	Description
type	Yes	String	Type of the instance to be scaled out. Select at least one from ess, ess-master, and ess-client. A type can be selected once only. You can only add instances, rather than increase storage capacity, on nodes of the ess-master and ess-client types.
nodesize	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.
disksize	Yes	Integer	Storage capacity of the instance you want to add. The sum of the original instance storage capacity plus the expanded instance storage capacity cannot exceed the default upper limit of storage capacity set during cluster creation. If scale-out is not required, set this parameter to 0. With a yearly/monthly cluster, you cannot change the number of nodes and disk capacity at the same time. Unit: GB. The scale-out step of ESS and ESS-cold nodes is 20. Storage capacity of ess-master and ess-client nodes cannot be expanded.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
id	String	Cluster ID.

Example Requests

Change the number of instances and storage capacity of the current cluster.

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

{
  "grow" : [ {
    "type" : "ess-master",
    "nodesize" : 2,
    "disksize" : 0
  }, {
    "type" : "ess",
    "nodesize" : 0,
    "disksize" : 40
  }, {
    "type" : "ess-client",
    "nodesize" : 1,
    "disksize" : 0
  } ],
  "isAutoPay" : 1
}

Example Responses

Status code: 200

Request succeeded.

{
  "id" : "4f3deec3-efa8-4598-bf91-560aad1377a3"
}

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.