edit-icon download-icon

Expand a cluster

Last Updated: Jan 11, 2018


Increase the number of nodes in the cluster.

Request information

Request line (RequestLine)

  1. PUT /clusters/{cluster_id} HTTP/1.1

Request line parameter (URI Param)

Name Type Required? Description
cluster_id string Yes Cluster ID

Special request header (RequestHead)

None. See Public request headers.

Request body (RequestBody)

  1. {
  2. "password": "password of the root account to log on to the Elastic Compute Service (ECS) instance",
  3. "instance_type": "ECS instance type",
  4. "size": "number of nodes after expansion",
  5. "data_disk_category": "disk category",
  6. "data_disk_size": "disk size",
  7. "ecs_image_id": "operating system image",
  8. "io_optimized": "whether or not to be I/O optimized",
  9. "release_eip_flag": "whether or not to release Elastic IP (EIP) after configuring the cluster"
  10. }

Request body explanation

NameType Required? Description
passwordstringYesThe password of the ECS instance.
instance_type stringYesCode indicating the ECS instance type. For more information, see Instance generations and type families.
sizeintYesThe total number of nodes, which must be larger than the number of the existing nodes.
data_disk_categorystringNoThe disk category used by ECS. For more information, see Disk category table.
data_disk_sizeNumberNoThe disk size shared by nodes (unit: GB).
ecs_image_idstringYesThe ID of the system image used by ECS.
io_optimizedstringNoDetermined according to the ECS instance rule. Optional values: none or optimized.
release_eip_flagboolNoWhether or not to release EIP after configuring the cluster. The default value is false.

ecs_image_id list

See View image list to obtain the ecs_image_id list. To customize the ECS image ID of the cluster, make sure the ECS image meets the following requirements:

  • Operating system: Ubuntu or CentOS.
  • The Linux Kernel version is equal to or later than 3.18, which is used to support overlayfs and overlay network.
  • The /etc/docker/key.json file is deleted from the image.

Response information

Response line (ResponseLine)

  1. HTTP/1.1 200 OK

Special response header (ResponseHead)

None. See Public response headers.

Response body (ResponseBody)

  1. {
  2. "cluster_id":"string",
  3. "request_id":"string",
  4. "task_id":"string"
  5. }


Request example

  1. PUT /clusters/Cccfd68c474454665ace07efce924f75f HTTP/1.1
  2. <Public request headers>
  3. {
  4. "password": "password",
  5. "instance_type": "ecs.s3.large",
  6. "size": 2,
  7. "data_disk_category": "cloud_ssd",
  8. "data_disk_size": 500,
  9. "ecs_image_id": "centos_7_2_64_40G_base_20170222.vhd",
  10. "io_optimized":"optimized",
  11. "release_eip_flag": false,
  12. }

Return example

  1. HTTP/1.1 202 Accepted
  2. <Public response header>
  3. {
  4. "cluster_id": "cb95aa626a47740afbf6aa099b650d7ce",
  5. "request_id": "687C5BAA-D103-4993-884B-C35E4314A1E1",
  6. "task_id": "T-5a54309c80282e39ea00002f"
  7. }
Thank you! We've received your feedback.