Query available add-ons with ListAddons - Container Service for Kubernetes - Alibaba Cloud - Container Service for Kubernetes

Queries the available components based on specific conditions such as the region, cluster type, cluster subtype defined by cluster profile, and cluster version and queries the detailed information about a component. The information includes whether the component is managed, the supported custom parameter schema, and compatible operating system architecture.

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

list

*All Resource

*

None

Request syntax

GET /addons HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
region_id	string	No	The region of the cluster. If cluster_id is specified, this parameter is ignored. You must specify the region_id, cluster_type, profile, cluster_spec, and cluster_version parameters at the same time.	cn-hangzhou
cluster_type	string	No	The type of the cluster. If cluster_id is specified, this parameter is ignored. You must specify the region_id, cluster_type, profile, cluster_spec, and cluster_version parameters at the same time.	ManagedKubernetes
profile	string	No	The subtype of the cluster. If cluster_id is specified, this parameter is ignored. You must specify the region_id, cluster_type, profile, cluster_spec, and cluster_version parameters at the same time.	Default
cluster_spec	string	No	The specifications of the cluster. If cluster_id is specified, this parameter is ignored. You must specify the region_id, cluster_type, profile, cluster_spec, and cluster_version parameters at the same time.	ack.pro.small
cluster_version	string	No	The version of the cluster. If cluster_id is specified, this parameter is ignored. You must specify the region_id, cluster_type, profile, cluster_spec, and cluster_version parameters at the same time.	1.32.1-aliyun.1
cluster_id	string	No	The cluster ID. If you specify a cluster ID, only components used in the specified cluster are queried. Other parameters are ignored.	c02b3e03be10643e8a644a843ffcb****

Response elements

Element	Type	Description	Example
	object	Schema of Response
addons	array<object>	The list of available components.
	object
name	string	The component name.	arms-prometheus
version	string	The version number.	1.1.9
managed	boolean	Indicates whether the component is fully managed.	false
install_by_default	boolean	Indicates whether the component is automatically installed by default.	false
category	string	The category of the component.	monitor
config_schema	string	The schema of the custom parameters of the component.	{}
supported_actions	array	Operations supported by the component. Valid values: Install Upgrade Modify Uninstall
	string	Operations supported by the component. Valid values: Install Upgrade Modify Uninstall	Install
architecture	array	Architectures supported by the component. Valid values: amd64 arm64
	string	Operations supported by the component. Valid values: Install Upgrade Modify Uninstall	amd64

Examples

Success response

JSON format

{
  "addons": [
    {
      "name": "arms-prometheus",
      "version": "1.1.9",
      "managed": false,
      "install_by_default": false,
      "category": "monitor",
      "config_schema": "{}",
      "supported_actions": [
        "Install"
      ],
      "architecture": [
        "amd64"
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.