调用DescribeClustersV1查看您在ACK中创建的所有的集群信息。

调试

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

请求语法

GET /api/v1/clusters?name=String&cluster_type=String&page_size=Long&page_number=Long HTTP/1.1 
Content-Type:application/json

请求参数

表 1. 请求Query参数
参数名称 类型 是否必选 示例 说明
name String cluster-demo

集群名称。

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

cluster_type String Kubernetes

集群类型,取值:

  • Kubernetes: 专有版集群。
  • ManagedKubernetes:托管版集群。
  • Ask:Serverless集群。
  • ExternalKubernetes:注册集群。
page_size Long 10

每页显示的记录数。

page_number Long 3

当前页码。

响应体语法

HTTP/1.1 200
Content-Type:application/json
{
  "clusters" : [ {
    "cluster_id" : "String",
    "cluster_type" : "String",
    "created" : "String",
    "init_version" : "String",
    "current_version" : "String",
    "next_version" : "String",
    "deletion_protection" : Boolean,
    "docker_version" : "String",
    "external_loadbalancer_id" : "String",
    "master_url" : "String",
    "meta_data" : "String",
    "name" : "String",
    "network_mode" : "String",
    "private_zone" : Boolean,
    "profile" : "String",
    "region_id" : "String",
    "resource_group_id" : "String",
    "security_group_id" : "String",
    "size" : Long,
    "state" : "String",
    "subnet_cidr" : "String",
    "tags" : [ {
      "key" : "String",
      "value" : "String"
    } ],
    "updated" : "String",
    "vpc_id" : "String",
    "vswitch_id" : "String",
    "worker_ram_role_name" : "String",
    "zone_id" : "String",
    "cluster_spec" : "String",
    "maintenance_window" : {
      "enable" : Boolean,
      "maintenance_time" : "String",
      "duration" : "String",
      "weekly_period" : "String"
    }
  } ],
  "page_info" : {
    "page_number" : Integer,
    "page_size" : Integer,
    "total_count" : Integer
  }
}

响应参数

表 2. 响应Body参数
参数名称 类型 示例 说明
clusters Array

集群信息列表。

cluster_id String c3fb96524f9274b4495df0f12a6b5****

集群ID。

cluster_type String Kubernetes

集群类型,取值:

  • Kubernetes: 专有版集群。
  • ManagedKubernetes:托管版集群。
  • Ask:Serverless集群。
  • ExternalKubernetes:注册集群。
created String 2020-08-20T10:51:29+08:00

集群创建时间。

init_version String 1.16.9-aliyun.1

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

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

current_version String 1.16.9-aliyun.1

集群当前版本。

next_version String 1.18.8-aliyun.1

集群可升级版本。

deletion_protection Boolean true

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

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

集群Docker版本。

external_loadbalancer_id String lb-2vcrbmlevo6kjpgch****

集群中Ingress SLB实例。

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

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

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

meta_data String {\"Addons\":[{\"config\":***}

集群元数据信息。

name String cluster-demo

集群名称。

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

network_mode String vpc

集群网络模式。取值:

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

集群Private Zone配置。取值:

  • true:启用Private Zone。
  • 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 5

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

state String running

集群运行状态,取值:

  • initial:集群创建中。
  • failed:集群创建失败。
  • running:集群运行中。
  • updating:集群升级中。
  • updating_failed:集群升级失败。
  • scaling:集群伸缩中。
  • stopped:集群已经停止运行。
  • deleting:集群删除中。
  • deleted:集群已经被删除。
  • delete_failed:集群删除失败。
subnet_cidr String 172.21.0.0/16

Pod网络地址段,必须是有效的私有网段,即以下网段及其子网:

  • 10.0.0.0/8
  • 172.16-31.0.0/12-16
  • 192.168.0.0/16

不能与VPC及VPC内已有Kubernetes集群使用的网段重复,创建成功后不能修改。

关于集群网络规划,请参见VPC下Kubernetes的网络地址段规划

tags Array of tag

集群资源标签。

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

集群更新时间。

vpc_id String vpc-2vcg932hsxsxuqbgl****

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

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

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

worker_ram_role_name String KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****

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

zone_id String cn-beijing-b

集群所属可用区ID。

cluster_spec String ack.standard

托管版集群类型,面向托管集群:

  • ack.pro.small:专业托管集群。
  • ack.standard:标准托管集群。
maintenance_window maintenance_window

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

page_info object

分页信息。

page_number Integer 3

分页数。

page_size Integer 20

单页大小。

total_count Integer 50

结果总数。

查询所有集群列表示例

请求示例

GET /api/v1/clusters?name=cluster-demo&cluster_type=Kubernetes&page_size=10&page_number=3 HTTP/1.1 
Content-Type:application/json

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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
  }
}

错误码

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