All Products
Search
Document Center

Container Service for Kubernetes:DescribeKubernetesVersionMetadata

Last Updated:Feb 29, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
cs:DescribeKubernetesVersionMetadataRead
  • All Resources
    *
    none
none

Request syntax

GET /api/v1/metadata/versions

Request parameters

ParameterTypeRequiredDescriptionExample
RegionstringYes

The region ID of the cluster.

cn-beijing
ClusterTypestringYes

The cluster type that you want to use. Valid values:

  • Kubernetes: ACK dedicated cluster
  • ManagedKubernetes: ACK managed cluster
  • ExternalKubernetes: registered cluster
Kubernetes
KubernetesVersionstringNo

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
ProfilestringNo

The scenario where clusters are used. Valid values:

  • Default: non-edge computing scenarios
  • Edge: edge computing scenarios
  • Serverless: serverless scenarios.

Default value: Default.

Default
runtimestringNo

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
ModestringNo

The query mode. Valid values:

  • supported: queries all supported versions.
  • creatable: queries only versions that allow you to create clusters.

If you specify KubernetesVersion, this parameter does not take effect.

Default value: creatable.

supported

Response parameters

ParameterTypeDescriptionExample
object []

Details of the queried Kubernetes version.

capabilitiesobject

Features of the queried Kubernetes version.

imagesobject []

The OS images that are returned.

image_idstring

The image ID.

centos_7_7_x64_20G_alibase_20200426.vhd
image_namestring

The image name.

CentOS 7.7
platformstring

The OS platform. Valid values:

  • AliyunLinux
  • CentOS
  • Windows
  • WindowsCore
CentOS
os_versionstring

The version of the image.

7.7
image_typestring

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_typestring

The type of operating system. Examples:

  • Windows
  • Linux
Linux
image_categorystring

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
architecturestring

The architecture of the image.

x86_64
meta_dataobject

The metadata of the Kubernetes version.

runtimesarray

Details of the supported container runtimes.

runtime

Details of the supported container runtimes.

versionstring

The Kubernetes version that is supported by ACK. For more information, see Release notes for Kubernetes versions.

1.16.9-aliyun.1
release_datestring

The release date of the Kubernetes version.

2023-04-30T00:00:00Z
expiration_datestring

The expiration date of the Kubernetes version.

2025-04-30T00:00:00Z
creatableboolean

Indicates whether you can create clusters that run the Kubernetes version.

true

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": "containerd",
        "version": "1.6.20"
      }
    ],
    "version": "1.16.9-aliyun.1",
    "release_date": "2023-04-30T00:00:00Z",
    "expiration_date": "2025-04-30T00:00:00Z",
    "creatable": true
  }
]

Error codes

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

Change history

Change timeSummary of changesOperation
2023-07-18The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Mode
Output ParametersThe response structure of the API has changed.