文档

DescribeClusterDetail - 查询指定集群的信息

更新时间:

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

调试

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

授权信息

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

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

请求语法

GET /clusters/{ClusterId}

请求参数

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

集群 ID。

cdde1f21ae22e483ebcb068a6eb7f****

返回参数

名称类型描述示例值
object

返回体参数。

cluster_idstring

集群 ID。

c82e6987e2961451182edacd74faf****
cluster_typestring
  • Kubernetes: ACK 专有集群。

  • ManagedKubernetes:ACK 托管类的集群,包括 ACK 托管集群(ACK 集群 Pro 版、ACK 集群基础版)、ACK Serverless 集群(Pro 版、基础版)、ACK Edge 集群(Pro 版、基础版)、ACK 灵骏集群(Pro 版)。

  • ExternalKubernetes:注册集群。

Kubernetes
createdstring

集群创建时间。

2019-11-25T15:50:20+08:00
init_versionstring

集群初始化版本。

1.16.6-aliyun.1
current_versionstring

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

1.16.6-aliyun.1
deletion_protectionboolean

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

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

集群中的 Docker 版本。

19.03.5
meta_datastring

集群元数据信息。

\"Addons\":***
namestring

集群名称。

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

cluster-demo
region_idstring

集群所在地域 ID。

cn-beijing
resource_group_idstring

集群资源组 ID。

rg-acfmyvw3wjm****
security_group_idstring

集群安全组 ID。

sg-25yq****
sizelong

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

5
statestring

集群运行状态,取值:

  • initial:集群创建中。
  • failed:集群创建失败。
  • running:集群运行中。
  • updating:集群升级中。
  • updating_failed:集群升级失败。
  • scaling:集群伸缩中。
  • waiting:等待接入状态。
  • disconnected:断开状态。
  • stopped:集群已经停止运行。
  • deleting:集群删除中。
  • deleted:集群已经被删除。
  • delete_failed:集群删除失败。
running
tagsarray

集群资源标签。

tag

集群资源标签。

updatedstring

集群更新时间。

2020-01-13T23:01:03+08:00
vpc_idstring

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

vpc-2zecuu62b9zw7a7qn****
vswitch_idstring

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

vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****
subnet_cidrstring

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
master_urlstring

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

{\"intranet_api_server_endpoint\":\"https://192.168.0.251:6443\"***}
profilestring

当您选择cluster_typeManagedKubernetes时,即 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_specstring

当您选择cluster_typeManagedKubernetes并配置profile后,您可以进一步指定集群的规格。

  • ack.pro.small:集群 Pro 版。

  • ack.standard:集群基础版(取值为空时默认选择)。

ack.pro.small
worker_ram_role_namestring

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

KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****
maintenance_windowmaintenance_window

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

parametersobject

集群 ROS 参数集合。

string

ROS 参数

WorkerImageId

示例

正常返回示例

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",
  "deletion_protection": true,
  "docker_version": "19.03.5",
  "meta_data": "\\\"Addons\\\":***",
  "name": "cluster-demo",
  "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",
  "master_url": "{\\\"intranet_api_server_endpoint\\\":\\\"https://192.168.0.251:6443\\\"***}",
  "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"
  },
  "parameters": {
    "key": "WorkerImageId"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-04-26API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (1)