DescribeAddon - Container Service for Kubernetes - Alibaba Cloud Documentation Center

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/{addon_name}

Request parameters

Parameter	Type	Required	Description	Example
addon_name	string	No	The name of the component.	coredns
region_id	string	No	The region ID. 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 ID of the cluster. If you specify a cluster ID, only components used in the cluster are queried. Other parameters are ignored.	c02b3e03be10643e8a644a843ffcb****
version	string	No	The version of the component. If you do not specify this parameter, the latest version of the component is queried.	v1.9.3.10-7dfca203-aliyun

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
name	string	The name of the component.	coredns
version	string	The version of the component.	v1.9.3.6-32932850-aliyun
category	string	The category of the component.	network
managed	boolean	Indicates whether the component is fully managed.	false
install_by_default	boolean	Indicates whether the component is automatically installed by default.	true
config_schema	string	The custom parameter schema of the component.	{}
supported_actions	array	Operations supported by the component. Valid values: Install Upgrade Modify Uninstall
	string	The operation.	Install
architecture	array	Architectures supported by the component. Valid values: amd64 arm64
	string	The architecture.	amd64
newer_versions	object []	The latest version of the component.
version	string	The version number.	v1.9.3.10-7dfca203-aliyun
upgradable	boolean	Indicates whether the component can be updated to the version.	true
minimum_cluster_version	string	The minimum cluster version required by the component version.	1.20.4

Examples

Sample success responses

JSONformat

{
  "name": "coredns",
  "version": "v1.9.3.6-32932850-aliyun",
  "category": "network",
  "managed": false,
  "install_by_default": true,
  "config_schema": "{}",
  "supported_actions": [
    "Install"
  ],
  "architecture": [
    "amd64"
  ],
  "newer_versions": [
    {
      "version": "v1.9.3.10-7dfca203-aliyun",
      "upgradable": true,
      "minimum_cluster_version": "1.20.4"
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history