DescribeClusters - （旧）查询用户所有集群实例-阿里云帮助中心

查看容器服务中创建的所有集群（包括Swarm和Kubernetes集群）。

调试

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

授权信息

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

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

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

请求语法

GET /clusters HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
name	string	否	根据集群 Name 进行模糊匹配查询。	test
clusterType	string	否	集群类型。	ManagedKubernetes

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	348D4C9C-9105-4A1B-A86E-B58F0F875575
clusters	array<object>	集群详情列表。
clusterDetail	object
created	string	集群的创建时间。	2019-11-25T15:50:20+08:00
security_group_id	string	集群安全组 ID。	sg-2zedf74ifulatvx0****
docker_version	string	集群使用的 Docker 版本。	18.09.2
master_url	string	连接集群的 endpoint 地址，包括 api_server_endpoint、dashboard_endpoint、mirana_endpoint、reverse_tunnel_endpoint 和 intranet_api_server_endpoint。更多详细信息，参见SSH 访问 Kubernetes 集群。	"{\"api_server_endpoint\":\"https://47.93.xx.xxx:6443https://mirana.cs-cn-beijing.aliyuncs.com:4243https://192.xxx.x.xx:6443\"}", "external_loadbalancer_id": "lb-2ze3buguz3gx9920z****"
meta_data	string	集群元数据信息。	***
cluster_id	string	集群 ID。	cb95aa626a47740afbf6aa099b650****
external_loadbalancer_id	string	集群负载均衡服务的 ID。	lb-2ze3buguz3gx9920z****
network_mode	string	集群网络模式（VPC 网络：vpc）。	vpc
zone_id	string	集群所在地域的 Zone 的 ID。	cn-beijing-a
deletion_protection	boolean	是否开启集群删除保护，防止通过控制台或 api 误删除集群。	true
current_version	string	集群当前版本。	1.14.8-aliyun.1
updated	string	最后更新时间。	2020-01-13T23:01:03+08:00
resource_group_id	string	集群资源组 ID。	rg-acfmyvw3wjm****
cluster_type	string	集群类型。	Kubernetes
region_id	string	集群所在地域 ID。	cn-beijing
vpc_id	string	专有网络(VPC) ID。	vpc-2zecuu62b9zw7a7qn****
data_disk_size	integer	数据盘大小，单位 GB。	0
state	string	集群状态，running 为运行状态，filed 和 stoped 为异常状态。	running
size	integer	节点数。	4
vswitch_id	string	虚拟交换机(VSwitch) ID。	vsw-2zete8s4qocqg0mf6****
vswitch_cidr	string	虚拟交换机(VSwitch)的网络前缀。	"26"
name	string	集群名称。	my-test-Kubernetes-cluster
data_disk_category	string	数据盘类型。	cloud
tags	array<object>	集群标签。
tags	object
key	string	集群标签名称。	2
value	string	集群标签值。	3

示例

正常返回示例

JSON格式

{
  "RequestId": "348D4C9C-9105-4A1B-A86E-B58F0F875575",
  "clusters": [
    {
      "created": "2019-11-25T15:50:20+08:00",
      "security_group_id": "sg-2zedf74ifulatvx0****",
      "docker_version": "18.09.2",
      "master_url": "\"{\\\"api_server_endpoint\\\":\\\"https://47.93.xx.xxx:6443https://mirana.cs-cn-beijing.aliyuncs.com:4243https://192.xxx.x.xx:6443\\\"}\",   \"external_loadbalancer_id\": \"lb-2ze3buguz3gx9920z****\"",
      "meta_data": "***",
      "cluster_id": "cb95aa626a47740afbf6aa099b650****",
      "external_loadbalancer_id": "lb-2ze3buguz3gx9920z****",
      "network_mode": "vpc",
      "zone_id": "cn-beijing-a",
      "deletion_protection": true,
      "current_version": "1.14.8-aliyun.1",
      "updated": "2020-01-13T23:01:03+08:00",
      "resource_group_id": "rg-acfmyvw3wjm****",
      "cluster_type": "Kubernetes",
      "region_id": "cn-beijing",
      "vpc_id": "vpc-2zecuu62b9zw7a7qn****",
      "data_disk_size": 0,
      "state": "running",
      "size": 4,
      "vswitch_id": "vsw-2zete8s4qocqg0mf6****",
      "vswitch_cidr": 26,
      "name": "my-test-Kubernetes-cluster",
      "data_disk_category": "cloud",
      "tags": [
        {
          "key": 2,
          "value": 3
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-06-25	OpenAPI 入参发生变更	查看变更详情