ListAddons - 查詢可用的組件列表 - Container Service for Kubernetes

您可以調用ListAddons介面，根據指定地區、叢集類型、叢集子類型（profile）、叢集版本等參數擷取可用組件的列表，並查詢組件的詳細資料，包括組件託管與否、支援的自訂參數Schema、相容的作業系統架構等。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

cs:ListAddons

list

*全部資源

*

無

請求文法

GET /addons HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
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.32.1-aliyun.1
cluster_id	string	否	叢集 ID。指定叢集 ID 時，查詢該叢集可用的組件列表，此時其他參數將會被忽略。	c02b3e03be10643e8a644a843ffcb****

返回參數

名稱	類型	描述	樣本值
	object	返回體。
addons	array<object>	可用組件列表。
	object
name	string	組件名稱。	arms-prometheus
version	string	組件版本。	1.1.9
managed	boolean	是否為託管組件。 true：託管組件。 false：非託管組件。	false
install_by_default	boolean	是否預設安裝。 true：建立叢集時預設安裝該組件。 false：否。	false
category	string	組件分類。 core：核心組件。 network：網路類型組件。 security：安全性群組件。 storage：儲存群組件。 monitor：日誌與監控組件。 application：應用組件。返回內容為空白表示組件類型為其他。	monitor
config_schema	string	組件自訂參數的 schema。	{}
supported_actions	array	組件支援的操作。
	string	組件支援的操作，取值： Install：安裝組件。 Upgrade：升級組件。 Modify：更新群組件。 Uninstall：卸載組件。	Install
architecture	array	組件支援的 CPU 架構。
	string	組件支援的 CPU 架構，取值： amd64。 arm64。	amd64

樣本

正常返回樣本

JSON格式

{
  "addons": [
    {
      "name": "arms-prometheus",
      "version": "1.1.9",
      "managed": false,
      "install_by_default": false,
      "category": "monitor",
      "config_schema": "{}",
      "supported_actions": [
        "Install"
      ],
      "architecture": [
        "amd64"
      ]
    }
  ]
}

錯誤碼

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

變更歷史

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