ListAddons - Container Service for Kubernetes - Alibaba Cloud Documentation Center

You can call the ListAddons operation to query all available components in a cluster. You can query all available components in a cluster by specifying the ID of the cluster. You can also specify parameters such as the region, cluster type, cluster subtype (profile), cluster specification, and cluster version to get a list of available components in clusters that meet the conditions.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /addons

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.26.3-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 parameters

Parameter	Type	Description	Example
	object	Schema of Response
addons	object []	The list of available components.
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

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history