DescribeAddon - 查詢指定組件的資訊 - Container Service for Kubernetes

您可以調用DescribeAddon介面，根據指定地區、叢集類型、叢集子類型（profile）、叢集版本、組件名稱等參數查詢目標組件的資訊，包括組件託管與否、組件分類、支援的自訂參數Schema、相容的作業系統架構、該版本要求的最低叢集版本等。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cs:DescribeAddon

get

*全部資源

*

無

請求文法

GET /addons/{addon_name} HTTP/1.1

路徑參數

名稱	類型	必填	描述	樣本值
addon_name	string	否	組件名稱。	coredns

請求參數

名稱	類型	必填	描述	樣本值
region_id	string	否	地區。如果傳入了 cluster_id，該參數將被忽略。 region_id、cluster_type、profile、cluster_spec、cluster_version 五個參數需要同時傳入。	cn-hangzhou
cluster_type	string	否	叢集類型。如果傳入了 cluster_id，該參數將被忽略。 region_id、cluster_type、profile、cluster_spec、cluster_version 五個參數需要同時傳入。	ManagedKubernetes
profile	string	否	叢集子類型。如果傳入了 cluster_id，該參數將被忽略。 region_id、cluster_type、profile、cluster_spec、cluster_version 五個參數需要同時傳入。	Default
cluster_spec	string	否	叢集規格。如果傳入了 cluster_id，該參數將被忽略。 region_id、cluster_type、profile、cluster_spec、cluster_version 五個參數需要同時傳入。	ack.pro.small
cluster_version	string	否	叢集版本。如果傳入了 cluster_id，該參數將被忽略。 region_id、cluster_type、profile、cluster_spec、cluster_version 五個參數需要同時傳入。	1.26.3-aliyun.1
cluster_id	string	否	叢集 ID。指定叢集 ID 時，查詢該叢集可用的組件列表，此時其他參數將會被忽略。	c02b3e03be10643e8a644a843ffcb****
version	string	否	組件版本。不指定時，查詢該組件可用的最新版本。	v1.9.3.10-7dfca203-aliyun

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
name	string	組件名稱。	coredns
version	string	組件版本。	v1.9.3.6-32932850-aliyun
category	string	組件分類。	network
managed	boolean	是否為託管組件。	false
install_by_default	boolean	是否預設安裝。	true
config_schema	string	組件自訂參數 schema。	{}
supported_actions	array	組件支援的操作。
	string	組件支援的操作。 Install：安裝組件。 Upgrade：升級組件。 Modify：修改組件。 Uninstall：卸載組件。	Install
architecture	array	組件支援的 CPU 架構。
	string	組件支援的 CPU 架構，可能的值： amd64。 arm64。	amd64
newer_versions	array<object>	組件的最新版本資訊。
	object	新版本資訊。
version	string	組件的最新版本號碼。	v1.9.3.10-7dfca203-aliyun
upgradable	boolean	是否可升級到該版本。 true：支援升級。 false：不支援升級。	true
minimum_cluster_version	string	該組件版本要求的最低叢集版本。	1.20.4

樣本

正常返回樣本

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。