调用DescribeClusterDetail,根据集群ID查看集群的详细信息。

调试

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

请求语法

GET /clusters/ClusterId HTTP/1.1 
Content-Type:application/json

请求参数

表 1. 请求Path参数
参数名称 类型 是否必选 示例 说明
ClusterId String cdde1f21ae22e483ebcb068a6eb7f****

集群ID。

响应体语法

HTTP/1.1 200
Content-Type:application/json
{
  "cluster_id" : "String",
  "cluster_type" : "String",
  "created" : "String",
  "init_version" : "String",
  "current_version" : "String",
  "next_version" : "String",
  "deletion_protection" : Boolean,
  "docker_version" : "String",
  "external_loadbalancer_id" : "String",
  "meta_data" : "String",
  "name" : "String",
  "network_mode" : "String",
  "region_id" : "String",
  "resource_group_id" : "String",
  "security_group_id" : "String",
  "size" : Long,
  "state" : "String",
  "tags" : [ {
    "key" : "String",
    "value" : "String"
  } ],
  "updated" : "String",
  "vpc_id" : "String",
  "vswitch_id" : "String",
  "subnet_cidr" : "String",
  "zone_id" : "String",
  "master_url" : "String",
  "private_zone" : Boolean,
  "profile" : "String",
  "cluster_spec" : "String",
  "worker_ram_role_name" : "String",
  "maintenance_window" : {
    "enable" : Boolean,
    "maintenance_time" : "String",
    "duration" : "String",
    "weekly_period" : "String"
  }
}

响应参数

表 2. 响应Body参数
参数名称 类型 示例 说明
cluster_id String c82e6987e2961451182edacd74faf****

集群ID。

cluster_type String Kubernetes

集群类型,取值:

  • Kubernetes: 专有版集群。
  • ManagedKubernetes:托管版集群。
  • Ask:Serverless集群。
  • ExternalKubernetes:注册集群。
created String 2019-11-25T15:50:20+08:00

集群创建时间。

init_version String 1.16.6-aliyun.1

集群初始化版本。

current_version String 1.16.6-aliyun.1

集群当前版本。ACK支持的Kubernetes版本,请参见Kubernetes版本发布概览

next_version String 1.18.8-aliyun.1

集群可升级版本。

deletion_protection Boolean true

集群删除保护,防止通过控制台或API误删除集群。取值:

  • true:启用集群删除保护,将不能通过控制台或API删除集群。
  • false:不启用集群删除保护,则能通过控制台或API删除集群。
docker_version String 19.03.5

集群中的Docker版本。

external_loadbalancer_id String lb-2ze3buguz3gx9920z****

集群Ingress SLB实例ID。

meta_data String \"Addons\":***

集群元数据信息。

name String cluster-demo

集群名称。

命名规则:由数字、汉字、英文字符或短划线(-)组成,长度范围1~63个字符,且不能以短划线(-)开头。

network_mode String vpc

集群网络模式,取值:

  • classic:经典网络。
  • vpc:专有网络。
  • overlay:叠加网络。
  • calico:Calico网络。

默认值:vpc

region_id String cn-beijing

集群所在地域ID。

resource_group_id String rg-acfmyvw3wjm****

集群资源组ID。

security_group_id String sg-25yq****

集群安全组ID。

size Long 5

集群节点数,包含Master节点及Worker节点。

state String running

集群运行状态,取值:

  • initial:集群创建中。
  • failed:集群创建失败。
  • running:集群运行中。
  • updating:集群升级中。
  • updating_failed:集群升级失败。
  • scaling:集群伸缩中。
  • stopped:集群已经停止运行。
  • deleting:集群删除中。
  • deleted:集群已经被删除。
  • delete_failed:集群删除失败。
tags Array of tag

集群资源标签。

updated String 2020-01-13T23:01:03+08:00

集群更新时间。

vpc_id String vpc-2zecuu62b9zw7a7qn****

集群专有网络ID,创建集群时的必填参数。

vswitch_id String vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****

虚拟交换机ID,创建集群时可选择1~3个虚拟交换机。为保证集群高可用,建议选择不同可用区的虚拟交换机。

subnet_cidr String 172.20.0.0/16

Pod网络地址段,必须是有效的私有网段,即以下网段及其子网:

  • 10.0.0.0/8
  • 172.16-31.0.0/12-16
  • 192.168.0.0/16

不能与VPC及VPC内已有Kubernetes集群使用的网段重复,创建成功后不能被修改。

关于集群网络规划,请参见VPC下Kubernetes的网络地址段规划

zone_id String cn-beijing-a

集群所在可用区ID。

master_url String {\"intranet_api_server_endpoint\":\"https://192.168.0.251:6443\"***}

集群访问地址,包含内网访问地址及公网访问地址。

private_zone Boolean false

集群Private Zone配置。

  • true:启用Private Zone。
  • false:不启用Private Zone。
profile String Default

面向场景时的集群类型:

  • Default:非边缘场景集群。
  • Edge:边缘场景集群。
cluster_spec String ack.pro.small

托管版集群类型,面向托管集群:

  • ack.pro.small:专业托管集群。
  • ack.standard :标准托管集群。
worker_ram_role_name String KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****

Worker RAM角色名称,授权ECS实例为集群Woker节点。

maintenance_window maintenance_window

集群维护窗口配置,只在专业托管版本(即:ACK Pro版集群)中生效。

查询ACK集群信息示例

请求示例

GET /clusters/cdde1f21ae22e483ebcb068a6eb7f**** HTTP/1.1 
Content-Type:application/json

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<cluster_id>c82e6987e2961451182edacd74faf****</cluster_id>
<cluster_type>Kubernetes</cluster_type>
<created>2019-11-25T15:50:20+08:00</created>
<init_version>1.16.6-aliyun.1</init_version>
<current_version>1.16.6-aliyun.1</current_version>
<next_version>1.18.8-aliyun.1</next_version>
<deletion_protection>true</deletion_protection>
<docker_version>19.03.5</docker_version>
<external_loadbalancer_id>lb-2ze3buguz3gx9920z****</external_loadbalancer_id>
<meta_data>\"Addons\":***</meta_data>
<name>cluster-demo</name>
<network_mode>vpc</network_mode>
<region_id>cn-beijing</region_id>
<resource_group_id>rg-acfmyvw3wjm****</resource_group_id>
<security_group_id>sg-25yq****</security_group_id>
<size>5</size>
<state>running</state>
<tags>
    <key>env</key>
    <value>prod</value>
</tags>
<updated>2020-01-13T23:01:03+08:00</updated>
<vpc_id>vpc-2zecuu62b9zw7a7qn****</vpc_id>
<vswitch_id>vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****</vswitch_id>
<subnet_cidr>172.20.0.0/16</subnet_cidr>
<zone_id>cn-beijing-a</zone_id>
<master_url>{\"intranet_api_server_endpoint\":\"https://192.168.0.251:6443\"***}</master_url>
<private_zone>false</private_zone>
<profile>Default</profile>
<cluster_spec>ack.pro.small</cluster_spec>
<worker_ram_role_name>KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****</worker_ram_role_name>
<maintenance_window>
    <enable>false</enable>
    <maintenance_time>03:00:00Z</maintenance_time>
    <duration>3h</duration>
    <weekly_period>Monday,Thursday</weekly_period>
</maintenance_window>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "cluster_id" : "c82e6987e2961451182edacd74faf****",
  "cluster_type" : "Kubernetes",
  "created" : "2019-11-25T15:50:20+08:00",
  "init_version" : "1.16.6-aliyun.1",
  "current_version" : "1.16.6-aliyun.1",
  "next_version" : "1.18.8-aliyun.1",
  "deletion_protection" : true,
  "docker_version" : "19.03.5",
  "external_loadbalancer_id" : "lb-2ze3buguz3gx9920z****",
  "meta_data" : "\\\"Addons\\\":***",
  "name" : "cluster-demo",
  "network_mode" : "vpc",
  "region_id" : "cn-beijing",
  "resource_group_id" : "rg-acfmyvw3wjm****",
  "security_group_id" : "sg-25yq****",
  "size" : 5,
  "state" : "running",
  "tags" : [ {
    "key" : "env",
    "value" : "prod"
  } ],
  "updated" : "2020-01-13T23:01:03+08:00",
  "vpc_id" : "vpc-2zecuu62b9zw7a7qn****",
  "vswitch_id" : "vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****",
  "subnet_cidr" : "172.20.0.0/16",
  "zone_id" : "cn-beijing-a",
  "master_url" : "{\\\"intranet_api_server_endpoint\\\":\\\"https://192.168.0.251:6443\\\"***}",
  "private_zone" : false,
  "profile" : "Default",
  "cluster_spec" : "ack.pro.small",
  "worker_ram_role_name" : "KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****",
  "maintenance_window" : {
    "enable" : false,
    "maintenance_time" : "03:00:00Z",
    "duration" : "3h",
    "weekly_period" : "Monday,Thursday"
  }
}

错误码

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