All Products
Search

This Product

    Container Service for Kubernetes:UpgradeCluster

    Document Center

    Container Service for Kubernetes:UpgradeCluster

    Last Updated:Aug 28, 2026

    Outdated Kubernetes versions may have security and stability issues. We recommend that you update the Kubernetes version of your cluster at the earliest opportunity to enjoy the new features of the new Kubernetes version. You can call the UpgradeCluster operation to manually upgrade a cluster.

    Operation description

    After successfully calling the UpgradeCluster interface, this API returns the task_id of the upgrade task. You can manage this operation task by calling the following task APIs:

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    cs:UpgradeCluster

    update

    *Cluster

    acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

    		 None None

    Request syntax

    POST /api/v2/clusters/{ClusterId}/upgrade HTTP/1.1

    Path Parameters

    Parameter

    Type

    Required

    Description

    Example
    ClusterId

    string

    Yes

    The ID of the cluster that you want to upgrade.

    c82e6987e2961451182edacd74faf****

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    body

    object

    No

    The request body parameters.

    k8s
    component_name deprecated

    string

    No

    This parameter is deprecated. No need to pass values.

    null
    next_version

    string

    No

    The target Kubernetes version for cluster upgrade.

    1.32.1-aliyun.1
    version deprecated

    string

    No

    This parameter is deprecated. Use next_version to specify the upgrade target Kubernetes version.

    null
    master_only

    boolean

    No

    Specifies whether to upgrade only master nodes. Valid values:

    • true: upgrades master nodes only.

    • false: upgrades both master and worker nodes.

    true
    rolling_policy deprecated

    object

    No

    The rolling update configuration.

    max_parallelism deprecated

    integer

    No

    The maximum number of nodes concurrently upgraded per batch.

    3

    Response elements

    Element

    Type

    Description

    Example

    object

    cluster_id

    string

    Cluster ID.

    c82e6987e2961451182edacd74faf****
    task_id

    string

    Task ID.

    T-5faa48fb31b6b8078d00****
    request_id

    string

    Request ID.

    0527ac9a-c899-4341-a21a-****

    Examples

    Success response

    JSON format

    {
  "cluster_id": "c82e6987e2961451182edacd74faf****",
  "task_id": "T-5faa48fb31b6b8078d00****",
  "request_id": "0527ac9a-c899-4341-a21a-****"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.