调用DescribeClustersV1查看您在ACK中创建的所有的集群信息(包括Swarm和Kubernetes集群)。

调试

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

请求头

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

请求语法

get /api/v1/clusters http|https

请求参数

名称 类型 是否必选 示例值 描述
Name String cluster-demo

集群名称。

ClusterType String Kubernetes

集群类型。

page_size Long 10

分页大小。

page_number Long 3

分页数。

返回数据

名称 类型 示例值 描述
clusters Array of clusters

集群详情列表。

cluster_healthy String "***"

集群健康状态。

cluster_id String "c3fb96524f9274b4495df0f12a6b5****"

集群ID。

cluster_type String "Kubernetes"

集群类型,有下面几种取值:

  • Kubernetes:Kubernetes专有版。
  • ManagedKubernetes:标准托管版集群、边缘托管版集群。
  • Ask:标准Serverless集群。
created String "2020-08-20T10:51:29+08:00"

集群创建时间。

current_version String "1.16.9-aliyun.1"

集群当前版本。

data_disk_category String "cloud"

系统盘类型。

data_disk_size Long "120"

系统盘大小。

deletion_protection Boolean "true"

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

docker_version String "19.03.5"

集群内Docker版本。

external_loadbalancer_id String "lb-2vcrbmlevo6kjpgch****"

集群Ingerss SLB实例ID。

init_version String "1.16.9-aliyun.1"

集群初始化版本。

master_url String "***"

集群的endpoint地址,包括api_server_endpoint、dashboard_endpoint等。更多详细信息,参见SSH访问Kubernetes集群

meta_data String "***"

集群元数据信息。

name String "cluster-demo"

集群名称。

network_mode String "vpc"

集群网络模式,VPC或IPVS。

node_status String "running"

集群节点状态。

private_zone Boolean "false"

集群是否开启Private Zone。

profile String "Default"

集群标识,取值为:

  • Edge:边缘托管版集群。
  • Default:默认值,非边缘托管版集群。
region_id String "cn-beijing"

集群所属地域ID。

resource_group_id String "rg-acfmyvw3wjm****"

集群资源组ID。

security_group_id String "sg-2vcgwsrwgt5mp0yi****"

集群安全组ID。

size Long "6"

集群节点数量。

state String "running"

集群运行状态。

subnet_cidr String "172.21.0.0/16"

POD网络地址段。

tags Array of tags

集群标签。

key String "tier"

标签key。

value String "frontend"

标签值。

updated String "2020-09-16T11:09:55+08:00"

集群更新时间。

vpc_id String "vpc-2vcg932hsxsxuqbgl****"

集群使用的VPC。

vswitch_cidr String "***"

VSwitch的CIDR block。

vswitch_id String "vsw-2vc41xuumx5z2rdma****,vsw-2vc41xuumx5z2rdma****"

虚拟交换机ID。

worker_ram_role_name String "***"

集群RAM 角色名称。

zone_id String "cn-beijing-b"

集群所属可用区ID。

page_info Object

分页信息。

page_number Integer "3"

分页数。

page_size Integer "20"

单页大小。

total_count Integer "50"

结果总数。

示例

请求示例

GET /api/v1/clusters HTTP/1.1
公共请求头

正常返回示例

XML 格式

<page_info>
    <page_number>3</page_number>
    <total_count>50</total_count>
    <page_size>20</page_size>
</page_info>
<clusters>
    <private_zone>false</private_zone>
    <resource_group_id>rg-acfmyvw3wjm****</resource_group_id>
    <vpc_id>vpc-2vcg932hsxsxuqbgl****</vpc_id>
    <network_mode>vpc</network_mode>
    <security_group_id>sg-2vcgwsrwgt5mp0yi****</security_group_id>
    <cluster_type>Kubernetes</cluster_type>
    <docker_version>19.03.5</docker_version>
    <data_disk_category>cloud</data_disk_category>
    <zone_id>cn-beijing-b</zone_id>
    <cluster_id>c3fb96524f9274b4495df0f12a6b5****</cluster_id>
    <external_loadbalancer_id>lb-2vcrbmlevo6kjpgch****</external_loadbalancer_id>
    <meta_data>***</meta_data>
    <vswitch_id>vsw-2vc41xuumx5z2rdma****,vsw-2vc41xuumx5z2rdma****</vswitch_id>
    <state>running</state>
    <init_version>1.16.9-aliyun.1</init_version>
    <node_status>running</node_status>
    <created>2020-08-20T10:51:29+08:00</created>
    <deletion_protection>true</deletion_protection>
    <profile>Default</profile>
    <subnet_cidr>172.21.0.0/16</subnet_cidr>
    <master_url>***</master_url>
    <region_id>cn-beijing</region_id>
    <current_version>1.16.9-aliyun.1</current_version>
    <tags>
        <value>frontend</value>
        <key>tier</key>
    </tags>
    <vswitch_cidr>***</vswitch_cidr>
    <cluster_healthy>***</cluster_healthy>
    <data_disk_size>120</data_disk_size>
    <size>6</size>
    <name>cluster-demo</name>
    <updated>2020-09-16T11:09:55+08:00</updated>
    <worker_ram_role_name>***</worker_ram_role_name>
</clusters>

JSON 格式

{
    "page_info": {
        "page_number": "3",
        "total_count": "50",
        "page_size": "20"
    },
    "clusters": {
        "private_zone": "false",
        "resource_group_id": "rg-acfmyvw3wjm****",
        "vpc_id": "vpc-2vcg932hsxsxuqbgl****",
        "network_mode": "vpc",
        "security_group_id": "sg-2vcgwsrwgt5mp0yi****",
        "cluster_type": "Kubernetes",
        "docker_version": "19.03.5",
        "data_disk_category": "cloud",
        "zone_id": "cn-beijing-b",
        "cluster_id": "c3fb96524f9274b4495df0f12a6b5****",
        "external_loadbalancer_id": "lb-2vcrbmlevo6kjpgch****",
        "meta_data": "***",
        "vswitch_id": "vsw-2vc41xuumx5z2rdma****,vsw-2vc41xuumx5z2rdma****",
        "state": "running",
        "init_version": "1.16.9-aliyun.1",
        "node_status": "running",
        "created": "2020-08-20T10:51:29+08:00",
        "deletion_protection": "true",
        "profile": "Default",
        "subnet_cidr": "172.21.0.0/16",
        "master_url": "***",
        "region_id": "cn-beijing",
        "current_version": "1.16.9-aliyun.1",
        "tags": {
            "value": "frontend",
            "key": "tier"
        },
        "vswitch_cidr": "***",
        "cluster_healthy": "***",
        "data_disk_size": "120",
        "size": "6",
        "name": "cluster-demo",
        "updated": "2020-09-16T11:09:55+08:00",
        "worker_ram_role_name": "***"
    }
}

错误码

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