调用DescribeClusters查看您在容器服务中创建的所有集群(包括Swarm和Kubernetes集群)。

调试

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

请求头

该接口使用公共请求头,无特殊请求头。请参见[公共请求参数文档]。

请求语法

GET /clusters HTTPS|HTTP

请求参数

名称 类型 是否必选 示例值 描述
name String test

根据集群Name进行模糊匹配查询。

clusterType String ManagedKubernetes

集群类型。

返回数据

名称 类型 示例值 描述
clusters Array

集群详情列表。

cluster_id String cb95aa626a47740afbf6aa099b650****

集群ID。

cluster_type String Kubernetes

集群类型。

created String 2019-11-25T15:50:20+08:00

集群的创建时间。

current_version String 1.14.8-aliyun.1

集群当前版本。

data_disk_category String cloud

数据盘类型。

data_disk_size Integer 0

数据盘大小,单位GB。

deletion_protection Boolean true

是否开启集群删除保护,防止通过控制台或api误删除集群。

docker_version String 18.09.2

集群使用的Docker版本。

external_loadbalancer_id String lb-2ze3buguz3gx9920zwf24

集群负载均衡服务的 ID。

master_url String "{\"api_server_endpoint\":\"https://47.93.195.255:6443https://mirana.cs-cn-beijing.aliyuncs.com:4243https://192.168.0.79:6443\"}", "external_loadbalancer_id": "lb-2ze3buguz3gx9920zwf24"

连接集群的endpoint地址,包括api_server_endpoint、dashboard_endpoint、mirana_endpoint、reverse_tunnel_endpoint和intranet_api_server_endpoint。更多详细信息,参见SSH访问Kubernetes集群

meta_data String ***

集群元数据信息。

name String my-test-Kubernetes-cluster

集群名称。

network_mode String vpc

集群网络模式(VPC网络:vpc)。

region_id String cn-beijing

集群所在地域 ID。

resource_group_id String rg-acfmyvw3wjmb3uq

集群资源组ID。

security_group_id String sg-2zedf74ifulatvx0z2ag

集群安全组ID。

size String 4

节点数。

state String running

集群状态,running为运行状态,filed和stoped为异常状态。

tags Array

集群标签。

key String 2

集群标签名称。

value String 3

集群标签值。

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

最后更新时间。

vpc_id String vpc-2zecuu62b9zw7a7qnn2**

专有网络(VPC) ID。

vswitch_cidr String ""

虚拟交换机(VSwitch)的网络前缀。

vswitch_id String vsw-2zete8s4qocqg0mf6xx**

虚拟交换机 (VSwitch) ID。

zone_id String cn-beijing-a

集群所在地域的Zone的ID。

示例

请求示例

GET /clusters HTTP/1.1
公共请求头

正常返回示例

XML 格式

<0>
    <name>sl-numa</name>
    <cluster_id>cd62be8675b514f278163cf750acb****</cluster_id>
    <size>4</size>
    <region_id>cn-shenzhen</region_id>
    <state>running</state>
    <cluster_type>Kubernetes</cluster_type>
    <current_version>1.16.6-aliyun.1</current_version>
    <resource_group_id>rg-acfmyvw3wjm****</resource_group_id>
    <instance_type/>
    <vswitch_id>vsw-wz9uwxhawmtzg7u9h****,vsw-wz9uwxhawmtzg7u9h****,vsw-wz9uwxhawmtzg7u9h****,vsw-wz9uwxhawmtzg7u9h****</vswitch_id>
    <data_disk_category>cloud</data_disk_category>
    <security_group_id>sg-wz956lln6kknnwlw****</security_group_id>
    <tags>
        <key>ack.aliyun.com</key>
        <value>cd62be8675b514f278163cf750acb1789</value>
    </tags>
    <zone_id>cn-shenzhen-e</zone_id>
    <docker_version>19.03.5</docker_version>
    <deletion_protection>false</deletion_protection>
</0>
<1>
    <name>sl-terway</name>
    <cluster_id>c5b269738d1f5427ebd32884fc59c****</cluster_id>
    <size>5</size>
    <region_id>cn-shenzhen</region_id>
    <state>running</state>
    <cluster_type>Kubernetes</cluster_type>
    <current_version>1.16.6-aliyun.1</current_version>
    <vpc_id>vpc-wz984yvbd6lck22z3****</vpc_id>
    <vswitch_id>vsw-wz9uwxhawmtzg7u9h****,vsw-wz9uwxhawmtzg7u9h****,vsw-wz9uwxhawmtzg7u9h****,vsw-wz9uwxhawmtzg7u9h****</vswitch_id>
    <security_group_id>sg-wz9e8pvnjalx1tm1****</security_group_id>
    <tags>
        <key>ack.aliyun.com</key>
        <value>c5b269738d1f5427ebd32884fc59c5c0f</value>
    </tags>
    <zone_id>cn-shenzhen-e</zone_id>
    <docker_version>19.03.5</docker_version>
    <deletion_protection>false</deletion_protection>
</1>

JSON 格式

[
	{
		"name": "sl-numa",
		"cluster_id": "cd62be8675b514f278163cf750acb****",
		"size": 4,
		"region_id": "cn-shenzhen",
		"state": "running",
		"cluster_type": "Kubernetes",
		"current_version": "1.16.6-aliyun.1",
		"resource_group_id": "rg-acfmyvw3wjm****",
		"instance_type": "",
		"vswitch_id": "vsw-wz9uwxhawmtzg7u9h****,vsw-wz9uwxhawmtzg7u9h****,vsw-wz9uwxhawmtzg7u9h****,vsw-wz9uwxhawmtzg7u9h****",
		"data_disk_category": "cloud",
		"security_group_id": "sg-wz956lln6kknnwlwleag",
		"tags": [
			{
				"key": "ack.aliyun.com",
				"value": "cd62be8675b514f278163cf750acb1789"
			}
		],
		"zone_id": "cn-shenzhen-e",
		"docker_version": "19.03.5",
		"deletion_protection": false
	},
	{
		"name": "sl-terway",
		"cluster_id": "c5b269738d1f5427ebd32884fc59c5c0f",
		"size": 5,
		"region_id": "cn-shenzhen",
		"state": "running",
		"cluster_type": "Kubernetes",
		"current_version": "1.16.6-aliyun.1",
		"vpc_id": "vpc-wz984yvbd6lck22z3pvgt",
		"vswitch_id": "vsw-wz9uwxhawmtzg7u9h5mmm,vsw-wz9uwxhawmtzg7u9h5mmm,vsw-wz9uwxhawmtzg7u9h5mmm,vsw-wz9uwxhawmtzg7u9h5mmm",
		"security_group_id": "sg-wz9e8pvnjalx1tm1g80p",
		"tags": [
			{
				"key": "ack.aliyun.com",
				"value": "c5b269738d1f5427ebd32884fc59c5c0f"
			}
		],
		"zone_id": "cn-shenzhen-e",
		"docker_version": "19.03.5",
		"deletion_protection": false
	}

]

错误码

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