All Products
Search

This Product

    Container Service for Kubernetes:DescribeClusterAddonsVersion

    Document Center

    Container Service for Kubernetes:DescribeClusterAddonsVersion

    Last Updated:Aug 28, 2026

    You can call the DescribeClusterAddonsVersion operation to query the details about all components in a cluster by cluster ID.

    Note

    This API has been deprecated. We recommend migrating to CS(2015-12-15) - ListClusterAddonInstances for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

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

    get

    *Cluster

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

    		 None None

    Request syntax

    GET /clusters/{ClusterId}/components/version HTTP/1.1

    Path Parameters

    Parameter

    Type

    Required

    Description

    Example
    ClusterId

    string

    Yes

    The cluster ID.

    c82e6987e2961451182edacd74faf****

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    No parameters required.

    Response elements

    Element

    Type

    Description

    Example

    object

    The response body.

    object

    The details of the component.

    component_name

    string

    The component name.

    ack-node-problem-detector
    version

    string

    The current version of the component.

    Note

    If the value of version is not empty, it indicates that the component is installed.

    1.2.1
    next_version

    string

    The version to which the component can be updated.

    1.2.1
    changed

    string

    Indicates whether the component is updated. Valid values:

    • true: The component is updated.

    • false: The component is not updated.

    false
    can_upgrade

    boolean

    Indicates whether the component is updatable. Valid values:

    • true: The component is updatable.

    • false: The component is not updatable.

    false
    policy

    string

    The update policy of the component.

    • overwrite: The component configurations of the later version overwrite those of the current version.

    Default value: overwrite.

    overwrite
    ready_to_upgrade

    string

    Indicates whether the component meets the update conditions. Valid values:

    • true: The component meets the update conditions.

    • false: The component does not meet the update conditions.

    false
    exist

    boolean

    Indicates whether the component can be installed in the specified ACK cluster. Valid values:

    • true: The component can be installed in the cluster.

    • false: The component cannot be installed in the cluster.

    true
    required

    boolean

    Indicates whether the component is required in the cluster. Valid values:

    • true: The component is required in the cluster.

    • false: The component is not required in the cluster.

    false
    message

    string

    Additional information about whether the component is updatable.

    节点故障检测以及上报至事件中心的插件
    value

    string

    The custom parameters. When you install a component, you can customize parameters for the component.

    npd:\n # Custom monitor definitions to add to Node Problem Detector ****

    Examples

    Success response

    JSON format

    {
  "key": {
    "component_name": "ack-node-problem-detector",
    "version": "1.2.1",
    "next_version": "1.2.1",
    "changed": "false",
    "can_upgrade": false,
    "policy": "overwrite",
    "ready_to_upgrade": "false",
    "exist": true,
    "required": false,
    "message": "节点故障检测以及上报至事件中心的插件",
    "value": "npd:\\n  # Custom monitor definitions to add to Node Problem Detector ****"
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.