All Products
Search

This Product

    Container Service for Kubernetes:UpgradeClusterAddons

    Document Center

    Container Service for Kubernetes:UpgradeClusterAddons

    Last Updated:Sep 21, 2026

    Upgrades the versions of cluster component instances so that you can benefit from the feature optimizations in the new versions.

    Operation description

    • Upgrading cluster component instance versions may affect your business. Assess the impact before performing the upgrade during off-peak hours, and back up relevant data in advance.

    • Before upgrading a component, refer to Component release notes to learn about the changes and their impact for the specified component.

    • Upgrade components one at a time. Confirm that one component has been successfully upgraded before upgrading the next.

    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:UpgradeK8sComponents

    update

    *Cluster

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

    		 None None

    Request syntax

    POST /clusters/{ClusterId}/components/upgrade HTTP/1.1

    Path Parameters

    Parameter

    Type

    Required

    Description

    Example
    ClusterId

    string

    Yes

    The cluster ID.

    cf4299b79b3e34226abfdc80a4bda****

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    body

    array<object>

    No

    The request parameters.

    object

    No

    The component information.

    component_name

    string

    Yes

    The component name.

    coredns
    config

    string

    No

    The custom component parameters, encoded as a JSON string.

    {"CpuRequest":"800m"}
    next_version

    string

    Yes

    The target version to upgrade to. You can call the DescribeAddon operation to query the upgradable versions of a component.

    v1.11.3.5-5321daf49-aliyun
    policy

    string

    No

    The component upgrade policy. Valid values:

    • overwrite: overwrite upgrade.

    • canary: canary upgrade.

    canary
    version

    string

    No

    The current component version.

    v1.11.3.2-f57ea7ed6-aliyun

    Response elements

    Element

    Type

    Description

    Example

    object

    cluster_id

    string

    The cluster ID.

    cf4299b79b3e34226abfdc80a4bda****
    request_id

    string

    The request ID.

    bfd12953-31cb-42f1-8a36-7b80ec34****
    task_id

    string

    The task ID.

    T-62a944794ee141074400****

    Examples

    Success response

    JSON format

    {
  "cluster_id": "cf4299b79b3e34226abfdc80a4bda****",
  "request_id": "bfd12953-31cb-42f1-8a36-7b80ec34****",
  "task_id": "T-62a944794ee141074400****"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 AddonPreviewUnsupported upgrade preview is not supported for component

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.