ListAddons - Container Service for Kubernetes - Alibaba Cloud ドキュメントセンター

リージョン、クラスタータイプ、クラスタープロファイルで定義されるクラスターサブタイプ、クラスターバージョンなどの特定の条件に基づいて利用可能なコンポーネントをクエリし、コンポーネントの詳細情報を取得します。この情報には、コンポーネントがマネージド型であるか、サポートされているカスタムパラメーターのスキーマ、互換性のあるオペレーティングシステムアーキテクチャーなどが含まれます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cs:ListAddons

list

*All Resource

*

なし

リクエスト構文

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	コンポーネントがフルマネージドであるかどうかを示します。	false
install_by_default	boolean	コンポーネントがデフォルトで自動的にインストールされるかどうかを示します。	false
category	string	コンポーネントのカテゴリです。	monitor
config_schema	string	コンポーネントのカスタムパラメーターのスキーマです。	{}
supported_actions	array	コンポーネントがサポートする操作です。有効な値： Install Upgrade Modify Uninstall
	string	コンポーネントがサポートする操作です。有効な値： Install Upgrade Modify Uninstall	Install
architecture	array	コンポーネントがサポートするアーキテクチャーです。有効な値： amd64 arm64
	string	コンポーネントがサポートする操作です。有効な値： Install Upgrade Modify Uninstall	amd64

例

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。