文档

DescribeKubernetesVersionMetadata - 查询Kubernetes版本的详细详情

更新时间:

您可以调用DescribeKubernetesVersionMetadata接口查询Kubernetes版本的详细信息,包括Kubernetes版本信息、版本的发布日期和过期时间、兼容的操作系统,使用的运行时等。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cs:DescribeKubernetesVersionMetadataRead
  • 全部资源
    *

请求语法

GET /api/v1/metadata/versions

请求参数

名称类型必填描述示例值
Regionstring

集群所在地域 ID。

cn-beijing
ClusterTypestring

集群类型,取值:

  • Kubernetes: ACK 专有版集群。
  • ManagedKubernetes:ACK 托管版集群,包括 ACK Pro 版集群、ACK 基础版集群、ACK Serverless Pro 版集群、ACK Serverless 基础版集群、ACK Edge Pro 版集群、ACK Edge 基础版。
  • ExternalKubernetes:ACK 注册集群。
Kubernetes
KubernetesVersionstring

集群版本,与 Kubernetes 社区基线版本保持一致。建议选择最新版本,若不指定,默认使用最新版本。

目前在 ACK 控制台您可以创建两种最新版本的集群。您可以通过 API 创建其他 Kubernetes 版本集群。ACK 支持的 Kubernetes 版本,请参见 Kubernetes 版本发布概览

1.26.3-aliyun.1
Profilestring

面向场景时的集群类型,取值:

  • Default:非边缘场景集群。
  • Edge:边缘场景集群。
  • Serverless:ASK 集群。

默认值:Default

Default
runtimestring

运行时类型,可以通过指定运行时类型,过滤出运行时所支持的系统镜像,取值:

  • docker:docker 运行时。
  • containerd:containerd 运行时。
  • Sandboxed-Container.runv:安全沙箱。

若指定运行时类型,将返回指定运行时支持的镜像版本。

若不指定运行时类型,默认返回全部镜像。

containerd
Modestring

查询模式,取值:

  • supported:查询受支持版本
  • creatable:查询可创建版本

若指定KubernetesVersion,将忽略查询模式。

若不指定查询模式,默认返回可创建版本。

supported
QueryUpgradableVersionboolean

是否查询该集群版本的可升级版本,仅在指定 KubernetesVersion 参数时生效。

返回参数

名称类型描述示例值
object []

集群版本详情列表。

capabilitiesobject

Kubernetes 版本功能特性。

imagesobject []

系统镜像列表。

image_idstring

镜像 ID。

centos_7_9_x64_20G_alibase_20221129.vhd
image_namestring

镜像名称。

CentOS 7.9
platformstring

操作系统平台。取值:

  • AliyunLinux
  • CentOS
  • Windows
  • WindowsCore
CentOS
os_versionstring

镜像版本。

7.9
image_typestring

操作系统发行版类型,推荐使用该字段指定节点操作系统。取值:

  • CentOS
  • AliyunLinux
  • AliyunLinux Qboot
  • AliyunLinuxUEFI
  • AliyunLinux3
  • Windows
  • WindowsCore
  • AliyunLinux3Arm64
  • ContainerOS
CentOS
os_typestring

操作系统类型,例如:

  • Windows
  • Linux
Linux
image_categorystring

镜像分类,部分取值:

  • system:公共镜像。
  • self:您的自定义镜像。
  • others:其他用户的公开镜像。
  • marketplace:镜像市场镜像。
system
architecturestring

镜像架构。

x86_64
meta_dataobject

Kubernetes 版本元数据信息。

runtimesarray

容器运行时配置。

runtime

容器运行时配置。

versionstring

ACK 发布的 Kubernetes 版本。更多版本信息,请参见 Kubernetes 版本发布概览

1.26.3-aliyun.1
release_datestring

Kubernetes 版本发布时间。

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

Kubernetes 版本过期时间。

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

Kubernetes 版本是否可创建。

true
upgradable_versionsarray

可升级的版本列表。

string

可升级的版本。

示例

正常返回示例

JSON格式

[
  {
    "capabilities": {
      "test": "test",
      "test2": 1
    },
    "images": [
      {
        "image_id": "centos_7_9_x64_20G_alibase_20221129.vhd",
        "image_name": "CentOS 7.9",
        "platform": "CentOS",
        "os_version": "7.9",
        "image_type": "CentOS",
        "os_type": "Linux",
        "image_category": "system",
        "architecture": "x86_64"
      }
    ],
    "meta_data": {
      "test": "test",
      "test2": 1
    },
    "runtimes": [
      {
        "name": "containerd",
        "version": "1.6.20"
      }
    ],
    "version": "1.26.3-aliyun.1",
    "release_date": "2023-04-30T00:00:00Z",
    "expiration_date": "2025-04-30T00:00:00Z",
    "creatable": true,
    "upgradable_versions": [
      ""
    ]
  }
]

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-07-18OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Mode
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)