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

バージョン番号、リリース日、有効期限、互換性のある OS、ランタイムなど、Kubernetes バージョンの詳細情報をクエリします。

今すぐお試しください

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

get

*All Resource

*

なし

リクエスト構文

GET /api/v1/metadata/versions HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Region	string	必須	クラスターのリージョン ID です。	cn-beijing
ClusterType	string	必須	使用するクラスタータイプです。有効な値： `Kubernetes`：ACK 専用クラスター。 `ManagedKubernetes`：ACK マネージドクラスター。ACK マネージドクラスターには、ACK Pro マネージドクラスター、ACK Basic クラスター、ACK Serverless Pro クラスター、ACK Serverless Basic クラスター、ACK Edge Pro クラスター、ACK Edge Basic クラスターが含まれます。 `ExternalKubernetes`：登録済みクラスター。	Kubernetes
KubernetesVersion	string	任意	クラスターの Kubernetes バージョンです。Container Service for Kubernetes (ACK) でサポートされている Kubernetes バージョンは、オープンソースの Kubernetes でサポートされているバージョンと同じです。最新の Kubernetes バージョンを指定することを推奨します。このパラメーターを設定しない場合、最新の Kubernetes バージョンが使用されます。 ACK でサポートされている Kubernetes バージョンの詳細については、「Kubernetes バージョンのリリースノート」をご参照ください。	1.32.1-aliyun.1
Profile	string	任意	クラスターが使用されるシナリオです。有効な値： `Default`：非エッジコンピューティングシナリオ `Edge`：エッジコンピューティングシナリオ `Serverless`：サーバーレスシナリオ。デフォルト値：`Default`。	Default
runtime	string	任意	使用するコンテナランタイムのタイプです。ランタイムタイプを指定すると、そのランタイムタイプをサポートする OS イメージのみをクエリできます。有効な値： `docker`：Docker `containerd`：containerd `Sandboxed-Container.runv`：Sandboxed-Container ランタイムタイプを指定した場合、指定したランタイムタイプをサポートする OS イメージのみが返されます。指定しない場合、すべての OS イメージが返されます。	containerd
Mode	string	任意	クエリモードです。有効な値： `supported`：サポートされているすべての Kubernetes バージョンをクエリします。 `creatable`：作成可能なクラスターの Kubernetes バージョンのみをクエリします。 `KubernetesVersion` を指定した場合、このパラメーターは無効になります。クエリモードを指定しない場合、作成可能なクラスターの Kubernetes バージョンが返されます。	supported
QueryUpgradableVersion	boolean	任意	更新に利用可能な Kubernetes バージョンをクエリするかどうかを指定します。このパラメーターは、`KubernetesVersion` パラメーターが指定されている場合にのみ有効です。 true：更新に利用可能な Kubernetes バージョンをクエリします。 false：更新に利用可能な Kubernetes バージョンをクエリしません。	1.30.1-aliyun.1

レスポンスフィールド

フィールド	型	説明	例
	array	クエリされた Kubernetes バージョンの詳細です。
	array<object>	Kubernetes バージョンの詳細です。
capabilities	object	クエリされた Kubernetes バージョンの機能です。	{ "AnyAZ": true, "ChargeType": "PostPaid" }
images	array<object>	返される OS イメージです。
	object	イメージの詳細です。
image_id	string	イメージの ID です。	aliyun_3_x64_20G_alibase_20241218.vhd
image_name	string	イメージ名です。	Alibaba Cloud Linux 3.2104
platform	string	OS プラットフォームです。有効な値： `AliyunLinux` `CentOS` `Windows` `WindowsCore`	AliyunLinux
os_version	string	イメージのバージョンです。	3.2104
image_type	string	使用するオペレーティングシステムのディストリビューションのタイプです。このパラメーターを使用して、ノードのオペレーティングシステムを指定することを推奨します。次のいずれかの操作を呼び出すことで、ターミナル ID を取得できます。 `CentOS` `AliyunLinux` `AliyunLinux Qboot` `AliyunLinuxUEFI` `AliyunLinux3` `Windows` `WindowsCore` `AliyunLinux3Arm64` `ContainerOS`	AliyunLinux3
os_type	string	OS のタイプです。例： `Windows` `Linux`	Linux
image_category	string	イメージのタイプです。有効な値： `system`：パブリックイメージ `self`：カスタムイメージ `others`：他の Alibaba Cloud アカウントから共有されたイメージ `marketplace`：マーケットプレイスからのイメージ	system
architecture	string	イメージのアーキテクチャです。	x86_64
meta_data	object	Kubernetes バージョンのメタデータです。	{ "KubernetesVersion": "1.31.1-aliyun.1", "SubClass": "default", "ServiceCIDR": "" }
runtimes	array	コンテナランタイムの構成です。
	runtime	コンテナランタイムの構成です。
version	string	ACK でサポートされている Kubernetes バージョンです。詳細については、「Kubernetes バージョンのリリースノート」をご参照ください。	1.31.1-aliyun.1
release_date	string	Kubernetes バージョンのリリース日です。	2025-01-30T00:00:00Z
expiration_date	string	Kubernetes バージョンの有効期限です。	2026-01-30T00:00:00Z
creatable	boolean	この Kubernetes バージョンを実行するクラスターを作成できるかどうかを示します。	true
upgradable_versions	array	更新に利用可能な Kubernetes バージョンのリストです。
	string	更新に利用可能な Kubernetes バージョンです。	1.32.1-aliyun.1

例

成功レスポンス

JSONJSON

[
  {
    "capabilities": {
      "AnyAZ": true,
      "ChargeType": "PostPaid"
    },
    "images": [
      {
        "image_id": "aliyun_3_x64_20G_alibase_20241218.vhd",
        "image_name": "Alibaba Cloud Linux 3.2104",
        "platform": "AliyunLinux",
        "os_version": "3.2104",
        "image_type": "AliyunLinux3",
        "os_type": "Linux",
        "image_category": "system",
        "architecture": "x86_64"
      }
    ],
    "meta_data": {
      "KubernetesVersion": "1.31.1-aliyun.1",
      "SubClass": "default",
      "ServiceCIDR": ""
    },
    "runtimes": [
      {
        "name": "containerd",
        "version": "1.6.20"
      }
    ],
    "version": "1.31.1-aliyun.1",
    "release_date": "2025-01-30T00:00:00Z",
    "expiration_date": "2026-01-30T00:00:00Z",
    "creatable": true,
    "upgradable_versions": [
      "1.32.1-aliyun.1"
    ]
  }
]

エラーコード

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

変更履歴

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