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

DescribeAddons 操作を呼び出して、Container Service for Kubernetes (ACK) でサポートされているすべてのコンポーネントの詳細を照会できます。

説明

この API は廃止されました。一時的にアクセス可能ですが、更新やバグ修正対応は一切行われません。代わりに CS(2015-12-15) - ListAddons への移行を推奨します。より強化された機能に加え、サポートも引き続きご利用いただけます。

今すぐお試しください

この 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:DescribeAddons

get

*All Resource

*

なし

リクエスト構文

GET /clusters/components/metadata HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
region	string	必須	クラスターのリージョン ID。	cn-beijing
cluster_type	string	任意	`Kubernetes`：ACK 専用クラスター。 `ManagedKubernetes`：ACK マネージドクラスター。 ACK マネージドクラスターには、ACK Basic クラスター、ACK Pro クラスター、ACK Serverless Basic クラスター、ACK Serverless Pro クラスター、ACK Edge Basic クラスター、ACK Edge Pro クラスター、ACK Lingjun Pro クラスターが含まれます。 `ExternalKubernetes`：登録済みクラスター。	ManagedKubernetes
cluster_profile	string	任意	クラスタータイプ。有効な値： `Default`：ACK マネージドクラスター `Serverless`：ACK Serverless クラスター `Edge`：ACK Edge クラスター	Default
cluster_spec	string	任意	`cluster_type` を `ManagedKubernetes` に設定し、`profile` を指定した場合、クラスターのエディションをさらに指定できます。有効な値： `ack.pro.small`：ACK Pro クラスターを作成します。 `ack.standard`：ACK Basic クラスターを作成します。このパラメーターを空のままにすると、ACK Basic クラスターが作成されます。	ack.pro.small
cluster_version	string	任意	クラスターのバージョン。	1.24.6-aliyun.1

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスボディパラメーター。
ComponentGroups	array<object>	返されたコンポーネントのリスト。
	array<object>
group_name	string	コンポーネントグループの名前。	storage
items	array<object>	コンポーネントグループ内のコンポーネントの名前。
	object
name	string	コンポーネントの名前。	flexvolume
StandardComponents	object	標準コンポーネント。
	object	標準コンポーネントの詳細。
name	string	コンポーネントの名前。	ack-arena
version	string	コンポーネントのバージョン。	0.5.0
description	string	コンポーネントの説明。	***
required	string	コンポーネントが必須コンポーネントであるかどうかを示します。有効な値： `true`：コンポーネントは必須であり、クラスターの作成時にインストールする必要があります。 `false`：コンポーネントはオプションです。クラスターの作成後、「アドオン」ページに移動してコンポーネントをインストールできます。	false
disabled	boolean	コンポーネントの自動インストールが無効になっているかどうかを示します。デフォルトでは、ロギングや Ingress などの一部のオプションコンポーネントは、クラスターの作成時にインストールされます。このパラメーターを設定して、コンポーネントの自動インストールを無効にすることができます。有効な値： `true`：コンポーネントの自動インストールを無効にします。 `false`：コンポーネントの自動インストールを有効にします。	false

例

成功レスポンス

JSONJSON

{
  "ComponentGroups": [
    {
      "group_name": "storage",
      "items": [
        {
          "name": "flexvolume"
        }
      ]
    }
  ],
  "StandardComponents": {
    "key": {
      "name": "ack-arena",
      "version": "0.5.0",
      "description": "***",
      "required": "false",
      "disabled": false
    }
  }
}

エラーコード

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

変更履歴

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