DescribeClusterDetail - 查询指定集群的信息 - 容器服务 Kubernetes 版 ACK

您可以调用DescribeClusterDetail接口，根据集群ID查询指定集群的详细信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
cs:DescribeClusterDetail	get	Cluster acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}	无	无

请求语法

GET /clusters/{ClusterId} HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
ClusterId	string	是	集群 ID。	cdde1f21ae22e483ebcb068a6eb7f****

返回参数

名称	类型	描述	示例值
	object	返回体参数。
cluster_id	string	集群 ID。	c82e6987e2961451182edacd74faf****
cluster_type	string	`Kubernetes`: ACK 专有集群。 `ManagedKubernetes`：ACK 托管类的集群，包括 ACK 托管集群（ACK 集群 Pro 版、ACK 集群基础版）、ACK Serverless 集群（Pro 版、基础版）、ACK Edge 集群（Pro 版、基础版）、ACK 灵骏集群（Pro 版）。 `ExternalKubernetes`：注册集群。	Kubernetes
created	string	集群创建时间。	2019-11-25T15:50:20+08:00
init_version	string	集群初始化版本。	1.16.6-aliyun.1
current_version	string	集群当前版本。ACK 支持的 Kubernetes 版本，请参见 Kubernetes 版本发布概览。	1.16.6-aliyun.1
next_version	string	集群可升级版本。	1.18.8-aliyun.1
deletion_protection	boolean	集群删除保护，防止通过控制台或 API 误删除集群。取值： `true`：启用集群删除保护，将不能通过控制台或 API 删除集群。 `false`：不启用集群删除保护，则能通过控制台或 API 删除集群。	true
docker_version	string	集群中的 Docker 版本。	19.03.5
external_loadbalancer_id	string	集群 Ingress LB 实例 ID。	lb-2zehc05z3b8dwiifh****
meta_data	string	集群元数据信息。	\"Addons\":***
name	string	集群名称。命名规则：由数字、汉字、英文字符或短划线（-）组成，长度范围 1~63 个字符，且不能以短划线（-）开头。	cluster-demo
network_mode	string	集群采用的网络类型，例如：VPC 网络。	vpc
region_id	string	集群所在地域 ID。	cn-beijing
resource_group_id	string	集群资源组 ID。	rg-acfmyvw3wjm****
security_group_id	string	集群安全组 ID。	sg-25yq****
container_cidr	string	Pod 网络网段，Flannel 网络配置。	172.20.0.0/16
service_cidr	string	服务网络网段。	172.21.0.0/20
proxy_mode	string	kube-proxy 代理模式 `iptables`: 成熟稳定的 kube-proxy 代理模式，Kubernetes Service 的服务发现和负载均衡使用 iptables 规则配置，但是性能一般，受规模影响较大，适用于集群存在少量的 Service。 `ipvs`：高性能的 kube-proxy 代理模式，Kubernetes Service 的服务发现和负载均衡使用 Linux IPVS 模块进行配置，适用于集群存在大量的 Service，对负载均衡有高性能要求的场景。	ipvs
timezone	string	时区。	Asia/Shanghai
node_cidr_mask	string	节点 IP 数量，通过指定网络的 CIDR 来确定 IP 的数量，只对于 Flannel 网络类型集群生效。	26
ip_stack	string	集群的 IP 协议栈，可取值： ipv4：创建仅支持 IPv4 协议栈的集群； dual：创建支持 IPv4/IPv6 双栈的集群。	ipv4
cluster_domain	string	集群本地域名。	cluster.local
size	long	集群节点数，包含 Master 节点及 Worker 节点。	5
state	string	集群运行状态，取值： `initial`：集群创建中。 `failed`：集群创建失败。 `running`：集群运行中。 `updating`：集群升级中。 `updating_failed`：集群升级失败。 `scaling`：集群伸缩中。 `waiting`：等待接入状态。 `disconnected`：断开状态。 `stopped`：集群已经停止运行。 `deleting`：集群删除中。 `deleted`：集群已经被删除。 `delete_failed`：集群删除失败。	running
tags	array	集群资源标签。
集群标签	tag	集群资源标签。
updated	string	集群更新时间。	2020-01-13T23:01:03+08:00
vpc_id	string	集群专有网络 ID，创建集群时的必填参数。	vpc-2zecuu62b9zw7a7qn****
vswitch_id`deprecated`	string	虚拟交换机 ID。该字段已废弃，控制面交换机请使用 vswitch_ids 查询，数据面交换机请通过节点池的 vswitch_ids 查询。	vsw-2zete8s4qocqg0mf6**,vsw-2zete8s4qocqg0mf6**
vswitch_ids	array	集群控制面虚拟交换机。
控制面交换机	string	集群控制面虚拟交换机。	vsw-2zete8s4qocqg0mf6****
subnet_cidr`deprecated`	string	Pod 网络地址段，必须是有效的私有网段，即以下网段及其子网： 10.0.0.0/8 172.16-31.0.0/12-16 192.168.0.0/16 不能与 VPC 及 VPC 内已有 Kubernetes 集群使用的网段重复，创建成功后不能被修改。关于集群网络规划，请参见VPC 下 Kubernetes 的网络地址段规划。	172.20.0.0/16
zone_id	string	集群所在地域内的可用区 ID。	cn-beijing-a
master_url	string	集群访问地址，包含内网访问地址及公网访问地址。	{\"intranet_api_server_endpoint\":\"https://192.168.0.251:6443\"***}
private_zone	boolean	集群是否启用 PrivateZone。 `true`：启用。 `false`：不启用。默认值：false。	false
profile	string	当您选择`cluster_type`为`ManagedKubernetes`时，即 ACK 托管类的集群时，您可以进一步指定集群的子类型。 `Default`：ACK 托管集群，包括 ACK 集群 Pro 版和 ACK 集群基础版。 `Edge`：ACK Edge 集群，包括 ACK Edge 集群 Pro 版和 ACK Edge 集群基础版。 `Serverless`：ACK Serverless 集群，包括 ACK Serverless 集群 Pro 版和 ACK Serverless 集群基础版。 `Lingjun`：ACK 灵骏集群，提供 Pro 版。	Default
cluster_spec	string	当您选择`cluster_type`为`ManagedKubernetes`并配置`profile`后，您可以进一步指定集群的规格。 `ack.pro.small`：集群 Pro 版。 `ack.standard`：集群基础版（取值为空时默认选择）。	ack.pro.small
worker_ram_role_name	string	Worker RAM 角色名称，授权 ECS 实例为集群 Woker 节点。	KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****
maintenance_window	maintenance_window	集群维护窗口配置，只在托管版本（即：ACK Pro 集群）中生效。
parameters	object	集群 ROS 参数集合。
	string	ROS 参数。	WorkerImageId
operation_policy	object	集群自动运维策略。
cluster_auto_upgrade	object	集群自动升级。
enabled	boolean	是否开启集群自动升级。	true
channel	string	集群自动升级频次。更多信息，请参见升级频次。可取值： patch：最新补丁版本。 stable：次新次要版本。 rapid：最新次要版本。	patch

示例

正常返回示例

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-2zehc05z3b8dwiifh****",
  "meta_data": "\\\"Addons\\\":***",
  "name": "cluster-demo",
  "network_mode": "vpc",
  "region_id": "cn-beijing",
  "resource_group_id": "rg-acfmyvw3wjm****",
  "security_group_id": "sg-25yq****",
  "container_cidr": "172.20.0.0/16",
  "service_cidr": "172.21.0.0/20",
  "proxy_mode": "ipvs",
  "timezone": "Asia/Shanghai",
  "node_cidr_mask": "26",
  "ip_stack": "ipv4",
  "cluster_domain": "cluster.local",
  "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****",
  "vswitch_ids": [
    "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": "2020-10-15T12:31:00.000+08:00",
    "duration": "3h",
    "weekly_period": "Monday,Thursday",
    "recurrence": "FREQ=WEEKLY;INTERVAL=4;BYDAY=MO,TU"
  },
  "parameters": {
    "key": "WorkerImageId"
  },
  "operation_policy": {
    "cluster_auto_upgrade": {
      "enabled": true,
      "channel": "patch"
    }
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-10-18	OpenAPI 返回结构发生变更	查看变更详情
2024-10-15	OpenAPI 返回结构发生变更	查看变更详情
2024-04-26	API 内部配置变更，不影响调用	查看变更详情