Queries the information about a component based on specific conditions such as the region, cluster type, cluster subtype defined by cluster profile, cluster version, and component name. The information includes whether the component is managed, the component type, supported custom parameter schema, compatible operating system architecture, and earliest supported cluster version.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| cs:DescribeAddon | get |
|
| none |
Request syntax
GET /addons/{addon_name} HTTP/1.1
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
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 |
|---|