All Products
Search

This Product

    Container Service for Kubernetes:DescribeAddons

    Document Center

    Container Service for Kubernetes:DescribeAddons

    Last Updated:Aug 27, 2026

    You can call the DescribeAddons operation to query the details about all components that are supported by Container Service for Kubernetes (ACK).

    Note

    This API has been deprecated. We recommend migrating to CS(2015-12-15) - ListAddons 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:DescribeAddons

    get

    *All Resource

    *

    		 None None

    Request syntax

    GET /clusters/components/metadata HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    region

    string

    Yes

    The region ID of the cluster.

    cn-beijing
    cluster_type

    string

    No

    • Kubernetes: ACK dedicated cluster.

    • ManagedKubernetes: ACK managed cluster. ACK managed clusters include ACK Basic clusters, ACK Pro clusters, ACK Serverless Basic clusters, ACK Serverless Pro clusters, ACK Edge Basic clusters, ACK Edge Pro clusters, and ACK Lingjun Pro clusters.

    • ExternalKubernetes: registered cluster.

    ManagedKubernetes
    cluster_profile

    string

    No

    The cluster type. Valid values:

    • Default: ACK managed cluster

    • Serverless: ACK Serverless cluster

    • Edge: ACK Edge cluster

    Default
    cluster_spec

    string

    No

    If you set cluster_type to ManagedKubernetes and specify profile, you can further specify the edition of the cluster. Valid values:

    • ack.pro.small: creates an ACK Pro cluster.

    • ack.standard: creates an ACK Basic cluster. If you leave the parameter empty, an ACK Basic cluster is created.

    ack.pro.small
    cluster_version

    string

    No

    The cluster version.

    1.24.6-aliyun.1

    Response elements

    Element

    Type

    Description

    Example

    object

    The response body parameters.

    ComponentGroups

    array<object>

    The list of the returned components.

    array<object>

    group_name

    string

    The name of the component group.

    storage
    items

    array<object>

    The names of the components in the component group.

    object

    name

    string

    The name of the component.

    flexvolume
    StandardComponents

    object

    Standard components.

    object

    The details of the standard components.

    name

    string

    The name of the component.

    ack-arena
    version

    string

    The version of the component.

    0.5.0
    description

    string

    The description of the component.

    ***
    required

    string

    Indicates whether the component is a required component. Valid values:

    • true: The component is required and must be installed when a cluster is created.

    • false: The component is optional. After a cluster is created, you can go to the Add-ons page to install the component.

    false
    disabled

    boolean

    Indicates whether the automatic installation of the component is disabled. By default, some optional components, such as components for logging and Ingresses, are installed when a cluster is created. You can set this parameter to disable automatic component installation. Valid values:

    • true: disables automatic component installation.

    • false: enables automatic component installation.

    false

    Examples

    Success response

    JSON format

    {
  "ComponentGroups": [
    {
      "group_name": "storage",
      "items": [
        {
          "name": "flexvolume"
        }
      ]
    }
  ],
  "StandardComponents": {
    "key": {
      "name": "ack-arena",
      "version": "0.5.0",
      "description": "***",
      "required": "false",
      "disabled": false
    }
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.