DescribeKubernetesVersionMetadata - Container Service for Kubernetes

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cs:DescribeKubernetesVersionMetadata	get	All Resources *	none	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 set this parameter, the latest Kubernetes version is used. You can create ACK clusters of the latest two Kubernetes versions in the ACK console. You can call the specific ACK API operation to create clusters of other Kubernetes versions. For more information about the Kubernetes versions supported by ACK, see Release notes for Kubernetes versions.	1.16.9-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.	docker
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	Specify whether to query the Kubernetes versions available for updates. This parameter takes effect only when the KubernetesVersion parameter is specified.	1.30.1-aliyun.1

Response parameters

Parameter	Type	Description	Example
	array<object>	Details of the queried Kubernetes version.
	object	The Kubernetes version.
capabilities	object	Features of the queried Kubernetes version.
images	array<object>	The OS images that are returned.
	object	Image details.
image_id	string	The image ID.	centos_7_7_x64_20G_alibase_20200426.vhd
image_name	string	The image name.	CentOS 7.7
platform	string	The OS platform. Valid values: `AliyunLinux` `CentOS` `Windows` `WindowsCore`	CentOS
os_version	string	The version of the image.	7.7
image_type	string	The type of OS distribution that you want to use. To specify the node OS, we recommend that you use this parameter. Valid values: `CentOS` `AliyunLinux` `AliyunLinux Qboot` `AliyunLinuxUEFI` `AliyunLinux3` `Windows` `WindowsCore` `AliyunLinux3Arm64` `ContainerOS`	centos_7_7_20
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.
runtimes	array	Details of the supported container runtimes.
	runtime	Details of the supported container runtimes.
version	string	The Kubernetes version supported by ACK. For more information, see Release notes for Kubernetes versions.	1.16.9-aliyun.1
release_date	string	The release date of the Kubernetes version.	2023-04-30T00:00:00Z
expiration_date	string	The expiration date of the Kubernetes version.	2025-04-30T00:00:00Z
creatable	boolean	Indicates whether you can create clusters that run the Kubernetes version.	true
upgradable_versions	array	The list of available versions for updates.
upgradable_versions	string	The version that can be updated.	1.30.1-aliyun.1

Examples

Sample success responses

JSONformat

[
  {
    "capabilities": {
      "test": "test",
      "test2": 1
    },
    "images": [
      {
        "image_id": "centos_7_7_x64_20G_alibase_20200426.vhd",
        "image_name": "CentOS 7.7",
        "platform": "CentOS",
        "os_version": "7.7",
        "image_type": "centos_7_7_20",
        "os_type": "Linux",
        "image_category": "system",
        "architecture": "x86_64"
      }
    ],
    "meta_data": {
      "test": "test",
      "test2": 1
    },
    "runtimes": [
      {
        "name": "docker",
        "version": "19.03.5"
      }
    ],
    "version": "1.16.9-aliyun.1",
    "release_date": "2023-04-30T00:00:00Z",
    "expiration_date": "2025-04-30T00:00:00Z",
    "creatable": true,
    "upgradable_versions": [
      "1.30.1-aliyun.1"
    ]
  }
]

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-05-14	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2023-07-18	The request parameters of the API has changed. The response structure of the API has changed	View Change Details