Help Center/ Cloud Container Engine/ API Reference/ APIs/ Cluster Management/ Modifying Cluster Specifications

Updated on 2025-11-05 GMT+08:00

Online Debugging

CLI Examples

View PDF

Modifying Cluster Specifications

Function

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

The URL for cluster management is in the format of https://Endpoint/uri, in which uri indicates the resource path, that is, the path for API access.
For details about constraints, see Changing Cluster Scale.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Details: Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. Constraints: None Options: Project IDs of the account Default value: N/A
cluster_id	Yes	String	Details: Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. Constraints: None Options: Cluster IDs Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Details: The request body type or format Constraints: The GET method is not verified. Options: application/json application/json;charset=utf-8 application/x-pem-file multipart/form-data (used when the FormData parameter is present) Default value: N/A
X-Auth-Token	Yes	String	Details: 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. Constraints: None Options: N/A Default value: N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
flavorResize	Yes	String	Definition Target flavor of the change. You can only adjust the maximum number of worker nodes in a cluster. The number of control plane nodes is fixed and cannot be altered, and the cluster flavor cannot be downgraded. Suppose the original cluster flavor is cce.s2.medium. In that case, you can upgrade it to cce.s2.large or higher, but you cannot downgrade it to cce.s2.small or cce.s1.medium. Constraints You are advised to select this option for the cluster that has 1,000 nodes or fewer. The cluster scale is limited by the VPC route table. If you upgrade the cluster flavor to cce.s2.xlarge, the actual number of nodes may be less than the target number. Range cce.s1.small: a small-scale CCE cluster with one control plane node and a maximum of 50 worker nodes cce.s1.medium: a medium-scale CCE cluster with one control plane node and a maximum of 200 worker nodes cce.s2.small: a small-scale CCE cluster with three control plane nodes and a maximum of 50 worker nodes cce.s2.medium: a medium-scale CCE cluster with three control plane nodes and a maximum of 200 worker nodes cce.s2.large: a large-scale CCE cluster with three control plane nodes and a maximum of 1,000 worker nodes cce.s2.xlarge: an ultra-large-scale CCE cluster with three control plane nodes and a maximum of 2,000 worker nodes Default Value N/A NOTE: The fields in the parameters are described as follows: s1: specifies a cluster with one control plane node. If the control plane node becomes faulty, the cluster will become unavailable, but running workloads in the cluster are not affected. s2: specifies an HA cluster with three control plane nodes. If one of the control plane nodes becomes faulty, the cluster is still available. dec: specifies a Dec CCE cluster. For example, cce.dec.s1.small specifies a small-scale, DeC CCE cluster with one control plane node and a maximum of 50 worker nodes. small: specifies that a cluster can manage a maximum of 50 worker nodes. medium: specifies that a cluster can manage a maximum of 200 worker nodes. large: specifies that a cluster can manage a maximum of 1,000 worker nodes. xlarge: specifies that a cluster can manage a maximum of 2,000 worker nodes.
skippedTasks	No	Array of strings	Definition Whether to skip some tasks during a cluster flavor change Constraints N/A Range IngressChecker: The check of configuration consistency between the ingress and ELB is skipped during the cluster flavor change. NOTE: Skipping this consistency check may interrupt services. If the cluster is unavailable or overloaded, this consistency check must be skipped. If it is not skipped, the cluster flavor change will fail. Before changing the cluster flavor, ensure that the consistency problem has been resolved by referring to What Should I Do If the LoadBalancer Ingress Configuration Is Inconsistent with the Load Balancer Configuration During a CCE Cluster Upgrade? Default Value An unavailable cluster includes IngressChecker by default.
extendParam	No	extendParam object	Definition Extended field for changing cluster flavors Constraints N/A

**Table 4** extendParam
Parameter	Mandatory	Type	Description
decMasterFlavor	No	String	Definition The flavors of the control plane nodes can be specified for a DeC CCE cluster. Constraints N/A Range N/A Default Value N/A
isAutoPay	No	String	Definition Whether to enable auto payment Constraints N/A Range true: Auto payment is enabled. false: Auto payment is not enabled. NOTE: This parameter is valid only for clusters billed on a yearly/monthly basis. If this parameter is not set, auto payment is disabled by default. Default Value N/A

Response Parameters

Status code: 201

**Table 5** Response body parameters
Parameter	Type	Description
jobID	String	Definition Job ID Constraints N/A Range N/A Default Value N/A
orderID	String	Definition ID of the order for modifying the flavor of a yearly/monthly cluster. Constraints APIs v2 do not allow you to change the flavor of a yearly/monthly cluster. Range N/A Default Value N/A

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

Previous topic: Revoking a Cluster Certificate of a User

Next topic: Querying a Job

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot