Query Kubernetes version metadata with DescribeKubernetesVersionMetadata - Container Service for Kubernetes - Alibaba Cloud - Container Service for Kubernetes

Queries the detailed information about Kubernetes versions, including the version number, release date, expiration date, compatible OSs, and runtime.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cs:DescribeKubernetesVersionMetadata

get

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
Region	string	Yes	The region ID of the cluster.	cn-beijing
ClusterType	string	Yes	The cluster type that you want to use. Valid values: `Kubernetes`: ACK dedicated cluster. `ManagedKubernetes`: ACK managed cluster. ACK managed clusters include ACK Pro clusters, ACK Basic clusters, ACK Serverless Pro clusters, ACK Serverless Basic clusters, ACK Edge Pro clusters, and ACK Edge Basic clusters. `ExternalKubernetes`: registered cluster.	Kubernetes
KubernetesVersion	string	No	The Kubernetes version of the cluster. The Kubernetes versions supported by ACK are the same as the Kubernetes versions supported by open source Kubernetes. We recommend that you specify the latest Kubernetes version. If you do not configure this parameter, the latest Kubernetes version is used. For more information about the Kubernetes versions supported by ACK, see Release notes for Kubernetes versions.	1.32.1-aliyun.1
Profile	string	No	The scenario where clusters are used. Valid values: `Default`: non-edge computing scenarios `Edge`: edge computing scenarios `Serverless`: serverless scenarios. Default value: `Default`.	Default
runtime	string	No	The container runtime type that you want to use. You can specify a runtime type to query only OS images that support the runtime type. Valid values: `docker`: Docker `containerd`: containerd `Sandboxed-Container.runv`: Sandboxed-Container If you specify a runtime type, only the OS images that support the specified runtime type are returned. Otherwise, all OS images are returned.	containerd
Mode	string	No	The query mode. Valid values: `supported`: queries all supported Kubernetes versions. `creatable`: queries only Kubernetes versions of clusters that you can create. If you specify `KubernetesVersion`, this parameter does not take effect. If you do not specify a query mode, Kubernetes versions of clusters that you can create are returned.	supported
QueryUpgradableVersion	boolean	No	Specifies whether to query the Kubernetes versions available for updates. This parameter takes effect only when the KubernetesVersion parameter is specified. true: queries the Kubernetes versions available for updates. false: does not query the Kubernetes versions available for updates.	1.30.1-aliyun.1

Response elements

Element	Type	Description	Example
	array	The details of the queried Kubernetes version.
	array<object>	The Kubernetes version details.
capabilities	object	Features of the queried Kubernetes version.	{ "AnyAZ": true, "ChargeType": "PostPaid" }
images	array<object>	The OS images that are returned.
	object	The details of the image.
image_id	string	The ID of the image.	aliyun_3_x64_20G_alibase_20241218.vhd
image_name	string	The image name.	Alibaba Cloud Linux 3.2104
platform	string	The OS platform. You can obtain the terminal ID by calling one of the following operations: `AliyunLinux` `CentOS` `Windows` `WindowsCore`	AliyunLinux
os_version	string	The version of the image.	3.2104
image_type	string	The type of operating system distribution that you want to use. We recommend that you use this parameter to specify the node operating system. You can obtain the terminal ID by calling one of the following operations: `CentOS` `AliyunLinux` `AliyunLinux Qboot` `AliyunLinuxUEFI` `AliyunLinux3` `Windows` `WindowsCore` `AliyunLinux3Arm64` `ContainerOS`	AliyunLinux3
os_type	string	The type of OS. Examples: `Windows` `Linux`	Linux
image_category	string	The type of image. Valid values: `system`: public image `self`: custom image `others`: shared image from other Alibaba Cloud accounts `marketplace`: image from the marketplace	system
architecture	string	The architecture of the image.	x86_64
meta_data	object	The metadata of the Kubernetes version.	{ "KubernetesVersion": "1.31.1-aliyun.1", "SubClass": "default", "ServiceCIDR": "" }
runtimes	array	The container runtime configurations.
	runtime	The container runtime configurations.
version	string	The Kubernetes version supported by ACK. For more information, see Release notes for Kubernetes versions.	1.31.1-aliyun.1
release_date	string	The release date of the Kubernetes version.	2025-01-30T00:00:00Z
expiration_date	string	The expiration date of the Kubernetes version.	2026-01-30T00:00:00Z
creatable	boolean	Indicates whether you can create clusters that run the Kubernetes version.	true
upgradable_versions	array	The list of available Kubernetes versions for updates.
	string	The Kubernetes version available for updates.	1.32.1-aliyun.1

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.