文档

DescribeClustersV1 - 查询集群列表

更新时间:

您可以调用DescribeClustersV1接口查看本账号下符合条件的ACK集群(例如指定集群类型、集群规格)列表信息。

调试

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

调试

授权信息

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

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

请求语法

GET /api/v1/clusters

请求参数

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

集群名称。

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

cluster-demo
cluster_typestring
  • Kubernetes: ACK 专有集群。
  • ManagedKubernetes:ACK 托管类的集群,包括 ACK 托管集群(ACK 集群 Pro 版、ACK 集群基础版)、ACK Serverless 集群(Pro 版、基础版)、ACK Edge 集群(Pro 版、基础版)、ACK 灵骏集群(Pro 版)。
  • ExternalKubernetes:注册集群。
Kubernetes
page_sizelong

每页显示的记录数。

10
page_numberlong

当前页码。

3
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
region_idstring

集群地域。通过指定该字段,可以过滤出该地域下的集群列表。

cn-hangzhou
cluster_idstring

集群 ID。

ca418e5e6fa2849d78301341700axxxxx

返回参数

名称类型描述示例值
object

返回体数据。

clustersobject []

集群信息列表。

cluster_idstring

集群 ID。

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

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

  • ExternalKubernetes:注册集群。

Kubernetes
createdstring

集群创建时间。

2020-08-20T10:51:29+08:00
init_versionstring

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

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

1.16.9-aliyun.1
current_versionstring

集群当前版本。

1.16.9-aliyun.1
next_versionstring

集群可升级版本。

1.18.8-aliyun.1
deletion_protectionboolean

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

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

集群 Docker 版本。

19.03.5
external_loadbalancer_idstring

集群中 Ingress SLB 实例。

默认实例规格:性能保障型(slb.s1.small)。

lb-2vcrbmlevo6kjpgch****
master_urlstring

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

{\"api_server_endpoint\":\"\",\"intranet_api_server_endpoint\":\"https://192.168.0.251:6443\"}
meta_datastring

集群元数据信息。

{\"Addons\":[{\"config\":***}
namestring

集群名称。

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

cluster-demo
network_modestring

集群网络模式。取值:

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

集群 Private Zone 配置。取值:

  • true:启用 Private Zone。
  • false:不启用 Private Zone。
false
profilestring

集群标识,取值:

  • 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
region_idstring

集群所在地域 ID。

cn-beijing
resource_group_idstring

集群资源组 ID。

rg-acfmyvw3wjm****
security_group_idstring

集群安全组 ID。

sg-2vcgwsrwgt5mp0yi****
sizelong

集群当前节点数量,包含 Master 节点以及 Worker 节点。

5
statestring

集群运行状态,取值:

  • initial:集群创建中。
  • failed:集群创建失败。
  • running:集群运行中。
  • updating:集群升级中。
  • updating_failed:集群升级失败。
  • scaling:集群伸缩中。
  • stopped:集群已经停止运行。
  • deleting:集群删除中。
  • deleted:集群已经被删除。
  • delete_failed:集群删除失败。
running
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.21.0.0/16
tagsarray

集群资源标签。

tag

集群资源标签。

updatedstring

集群更新时间。

2020-09-16T11:09:55+08:00
vpc_idstring

集群专有网络 ID,创建集群时必传。

vpc-2vcg932hsxsxuqbgl****
vswitch_idstring

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

vsw-2vc41xuumx5z2rdma****,vsw-2vc41xuumx5z2rdma****
worker_ram_role_namestring

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

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

集群所属可用区 ID。

cn-beijing-b
cluster_specstring

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

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

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

ack.standard
maintenance_windowmaintenance_window

集群维护窗口,该功能只在专业托管版中生效。

page_infoobject

分页信息。

page_numberinteger

分页数。

3
page_sizeinteger

单页大小。

20
total_countinteger

结果总数。

50

示例

正常返回示例

JSON格式

{
  "clusters": [
    {
      "cluster_id": "c3fb96524f9274b4495df0f12a6b5****",
      "cluster_type": "Kubernetes",
      "created": "2020-08-20T10:51:29+08:00",
      "init_version": "1.16.9-aliyun.1",
      "current_version": "1.16.9-aliyun.1",
      "next_version": "1.18.8-aliyun.1",
      "deletion_protection": true,
      "docker_version": "19.03.5",
      "external_loadbalancer_id": "lb-2vcrbmlevo6kjpgch****",
      "master_url": "{\\\"api_server_endpoint\\\":\\\"\\\",\\\"intranet_api_server_endpoint\\\":\\\"https://192.168.0.251:6443\\\"}",
      "meta_data": "{\\\"Addons\\\":[{\\\"config\\\":***}",
      "name": "cluster-demo",
      "network_mode": "vpc",
      "private_zone": false,
      "profile": "Default",
      "region_id": "cn-beijing",
      "resource_group_id": "rg-acfmyvw3wjm****",
      "security_group_id": "sg-2vcgwsrwgt5mp0yi****",
      "size": 5,
      "state": "running",
      "subnet_cidr": "172.21.0.0/16",
      "tags": [
        {
          "key": "env",
          "value": "prod"
        }
      ],
      "updated": "2020-09-16T11:09:55+08:00",
      "vpc_id": "vpc-2vcg932hsxsxuqbgl****",
      "vswitch_id": "vsw-2vc41xuumx5z2rdma****,vsw-2vc41xuumx5z2rdma****",
      "worker_ram_role_name": "KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****",
      "zone_id": "cn-beijing-b",
      "cluster_spec": "ack.standard",
      "maintenance_window": {
        "enable": false,
        "maintenance_time": "03:00:00Z",
        "duration": "3h",
        "weekly_period": "Monday,Thursday"
      }
    }
  ],
  "page_info": {
    "page_number": 3,
    "page_size": 20,
    "total_count": 50
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-11-24OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:cluster_id
2020-09-14OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:region_id
  • 本页导读 (1)
文档反馈