Scaling Out a Cluster

Function

This API is used to scale out an MRS cluster.

URI

POST /v2/{project_id}/clusters/{cluster_id}/expand

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. The value can contain a maximum of 64 characters.
cluster_id	Yes	String	Cluster ID. The value can contain a maximum of 64 characters.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
node_group_name	Yes	String	Node group name. Minimum: 1 character Maximum: 64 characters
count	Yes	Integer	Number of nodes to added
skip_bootstrap_scripts	No	Boolean	Whether to skip the specified bootstrap action during cluster creation on the new node during scale-out. The default value is true, indicating that the bootstrap action is skipped by default.
scale_without_start	No	Boolean	Whether the components remain stopped on the added nodes after cluster scale-out. The default value is false, indicating that the components will be started. true: Do not start components after scale-out. false: Start components after scale-out.

Response Parameters

Status code: 200

**Table 3** Response body parameter
Parameter	Type	Description
result	String	Result of the request. Value succeeded indicates that the operation is successful, and value failed indicates that the operation fails. Value success is returned if the request for scaling out a non-yearly/monthly node group is successfully issued.
order_id	String	Order ID. When you scale out a yearly/monthly node group, the order ID generated during the scale-out is returned. You need to pay for the order to trigger the scale-out.

Example Request

Add a node to the node group node_group_1. Skip the bootstrap action and start the components by default.

/v2/ff8080828997cb24018a1b2db3440b80/clusters/f7f45c04-4303-411c-9b71-d2cb730dd162/expand 

 { 
   "node_group_name" : "node_group_1", 
   "count" : "1" 
 }

Add a node to the node group node_group_1. Do not skip the bootstrap action or start the components.

/v2/ff8080828997cb24018a1b2db3440b80/clusters/f7f45c04-4303-411c-9b71-d2cb730dd162/expand 
  
 { 
   "node_group_name" : "node_group_1", 
   "count" : "1", 
   "skip_bootstrap_scripts" : false, 
   "scale_without_start" : true 
 }

Example Response

Status code: 200

The response body varies depending on the billing mode of node groups. The order ID is returned for you to settle payment for scaling out a yearly/monthly node group.

A pay-per-use node group is scaled out successfully.
```
{
  "result" : "succeeded"
}
```
A yearly/monthly node group is scaled out successfully. The ID of the order you need to pay is CS231XXXXXXXXXXX.
```
{
  "order_id" : "CS231XXXXXXXXXXX"
}
```