DescribeAddon - 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:DescribeAddon

get

*All Resource

*

なし

リクエスト構文

GET /addons/{addon_name} HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
addon_name	string	任意	コンポーネント名。	coredns

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
region_id	string	任意	リージョン ID。`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	レスポンスのスキーマ
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	コンポーネントのカスタムパラメーターのスキーマ。	{}
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

例

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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