Help Center/ Cloud Container Engine/ API Reference/ APIs/ Cluster Management/ Modifying Cluster Specifications
Updated on 2024-03-22 GMT+08:00
View PDF

Modifying Cluster Specifications

Function

This API is used to modify the specifications of a specified cluster.

  • The URL for cluster management is in the format of https://Endpoint/uri, where uri indicates the resource path for API access.

URI

POST /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/resize

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

cluster_id

Yes

String

Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format).

X-Auth-Token

Yes

String

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

flavorResize

Yes

String

Target specifications:

  • cce.s1.small: a small-scale CCE cluster with one master node and a maximum of 50 worker nodes

  • cce.s1.medium: a medium-scale CCE cluster with one master node and a maximum of 200 worker nodes

  • cce.s2.small: a small-scale CCE cluster with multiple master nodes and a maximum of 50 worker nodes

  • cce.s2.medium: a medium-scale CCE cluster with multiple master nodes and a maximum of 200 nodes

  • cce.s2.large: a large-scale CCE cluster with multiple master nodes and a maximum of 1,000 worker nodes

  • cce.s2.xlarge: an ultra-large-scale CCE cluster with multiple master nodes and a maximum of 2,000 nodes

NOTE:

  • s1: indicates a CCE cluster with one master node.

  • s2: indicates a CCE cluster with multiple master nodes.

  • dec: indicates a dedicated CCE cluster. For example, cce.dec.s1.small indicates a small-scale dedicated CCE cluster with one master node and a maximum of 50 worker nodes.

  • Maximum number of nodes: indicates the maximum number of worker nodes that can be managed by the cluster. Select a node scale based on your requirements.

  • A cluster with one master node: If the master node is faulty, the cluster will become unavailable, but the running workloads will not be affected.

  • A cluster with multiple master nodes: This is an HA cluster. If a master node is faulty, the cluster can still be functionally available.

extendParam

No

extendParam object
Table 4 extendParam

Parameter

Mandatory

Type

Description

decMasterFlavor

No

String

Specifications of the master node in the dedicated hybrid cluster

isAutoPay

No

String

Whether auto payment is enabled.

  • true: Auto payment is enabled.

  • false: Auto payment is not enabled.

NOTE:

This field is valid for yearly/monthly clusters. If not specified, auto payment is not enabled.

Response Parameters

Status code: 201

Table 5 Response body parameters

Parameter

Type

Description

jobID

String

ID of the job

orderID

String

ID of the order for modifying the specifications of a yearly/monthly billed cluster

Example Requests

  • Modifying the specifications of the yearly/monthly cluster (automatic payment)

    POST /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/resize

{
  "flavorResize" : "cce.s1.medium",
  "extendParam" : {
    "isAutoPay" : "true"
  }
}

  • Modifying the specifications of the pay-per-use cluster

    POST /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/resize

{
  "flavorResize" : "cce.s1.medium"
}

Example Responses

Status code: 201

The job for modifying the specifications of the pay-per-use cluster is delivered.

{
  "jobID" : "13b8d958-8fcf-11ed-aef3-0255ac1001bd"
}

Status Codes

Status Code

Description

201

The job for modifying the specifications of the pay-per-use cluster is delivered.

Error Codes

See Error Codes.

Parent topic: Cluster Management