Adding Instances and Expanding Instance Storage Capacity

Function

This API is used to scale out a cluster with special nodes, such as master, client, and cold data nodes.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/role_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	Array of RoleExtendGrowReq objects	Detailed description about the cluster scale-out request.

**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 ess-master and ess-client nodes, instead of increasing their storage capacity.
nodesize	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. If there is no need to add more instances, set this parameter to 0.
disksize	Yes	Integer	Storage capacity of the instance to be expanded. 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 there is no need to add more storage capacity, 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. The 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
  } ]

}

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.