Help Center/ MapReduce Service/ API Reference (Ankara Region)/ API V2/ Cluster Management APIs/ Scaling Out a Cluster
Updated on 2024-11-29 GMT+08:00
View PDF
Share

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

Explanation

Project ID.

Constraints

N/A

Value range

The value must consist of 1 to 64 characters. Only letters and digits are allowed.

Default value

N/A

cluster_id

Yes

String

Explanation

Cluster ID.

Constraints

N/A

Value range

The value can contain 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-).

Default value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

node_group_name

Yes

String

Explanation

Node group name.

Constraints

N/A

Value range

The value can contain 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-).

Default value

N/A

count

Yes

Integer

Explanation

Number of nodes to add

Constraints

N/A

Value range

N/A

Default value

N/A

skip_bootstrap_scripts

No

Boolean

Explanation

Whether to skip the specified bootstrap action during cluster creation on the new node during scale-out.

Constraints

N/A

Value range

  • true: The bootstrap action specified during cluster creation is skipped.
  • false: The bootstrap action specified during cluster creation is not skipped.

Default value

true

scale_without_start

No

Boolean

Explanation

Whether the components remain stopped on the added nodes after cluster scale-out.

Constraints

N/A

Value range

  • true: Do not start components after scale-out.
  • false: Start components after scale-out.

Default value

false

Response Parameters

Status code: 200

Table 3 Response body parameter

Parameter

Type

Description

result

String

Explanation

Result of the request. Value succeeded indicates that the operation is successful, and value failed indicates that the operation fails.

Value range

  • succeeded: The operation is successful.
  • failed: The operation failed.

order_id

String

Explanation

Order ID.

Value range

N/A

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 scale-out is successful.

{
  "result" : "succeeded"
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Cluster Management APIs