DescribeAddon API for querying component information - Container Service for Kubernetes - Alibaba Cloud - Container Service for Kubernetes

Invokes the DescribeAddon operation to perform a parameter query for information about a specified component based on parameters such as region, cluster type, cluster child class (profile), cluster version, and component name. The returned information includes whether the component is managed, the component categorization, the schema of supported custom parameters, compatible operating system architectures, and the minimum cluster version required by the component version.

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

get

*All Resource

*

None

Request syntax

GET /addons/{addon_name} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
addon_name	string	No	The name of the component.	coredns

Request parameters

Parameter	Type	Required	Description	Example
region_id	string	No	The region ID. If cluster_id is specified, this parameter is ignored. The region_id, cluster_type, profile, cluster_spec, and cluster_version parameters must be specified together.	cn-hangzhou
cluster_type	string	No	The cluster type. If cluster_id is specified, this parameter is ignored. The region_id, cluster_type, profile, cluster_spec, and cluster_version parameters must be specified together.	ManagedKubernetes
profile	string	No	The cluster subtype. If cluster_id is specified, this parameter is ignored. The region_id, cluster_type, profile, cluster_spec, and cluster_version parameters must be specified together.	Default
cluster_spec	string	No	The cluster specifications. If cluster_id is specified, this parameter is ignored. The region_id, cluster_type, profile, cluster_spec, and cluster_version parameters must be specified together.	ack.pro.small
cluster_version	string	No	The cluster version. If cluster_id is specified, this parameter is ignored. The region_id, cluster_type, profile, cluster_spec, and cluster_version parameters must be specified together.	1.26.3-aliyun.1
cluster_id	string	No	The cluster ID. If you specify a cluster ID, the system queries the list of components available for the cluster, and other parameters are ignored.	c02b3e03be10643e8a644a843ffcb****
version	string	No	The component version. If this parameter is not specified, the latest available version of the component is queried.	v1.9.3.10-7dfca203-aliyun

Response elements

Element	Type	Description	Example
	object	Schema of Response
name	string	The name of the component.	coredns
version	string	The component version.	v1.9.3.6-32932850-aliyun
category	string	The component category.	network
managed	boolean	Indicates whether the component is managed.	false
install_by_default	boolean	Indicates whether the component is installed by default.	true
config_schema	string	The schema of custom parameters for the component.	{}
supported_actions	array	The operations supported by the component.
	string	The operations supported by the component. Valid values: Install: installs the component. Upgrade: upgrades the component. Modify: modifies the component. Uninstall: uninstalls the component.	Install
architecture	array	The CPU architectures supported by the component.
	string	The CPU architectures supported by the component. Valid values: amd64. arm64.	amd64
newer_versions	array<object>	The information about newer versions of the component.
	object	The information about a newer version.
version	string	The latest version number of the component.	v1.9.3.10-7dfca203-aliyun
upgradable	boolean	Indicates whether the component can be upgraded to this version. true: The upgrade is supported. false: The upgrade is not supported.	true
minimum_cluster_version	string	The minimum cluster version required by this component version.	1.20.4

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.