您可以调用DescribeClustersV1接口查看本账号下符合条件的ACK集群（例如指定集群类型、集群规格）列表信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| cs:GetClusters | get | *Cluster acs:cs:*:{#accountId}:cluster/* |
| 无 |
请求语法
GET /api/v1/clusters HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| name | string | 否 | 集群名称。 | cluster-demo |
| cluster_type | string | 否 | 集群类型。
| Kubernetes |
| page_size | long | 否 | 每页显示的记录数。 | 10 |
| page_number | long | 否 | 当前页码。 | 1 |
| profile | string | 否 | 当您选择
| Default |
| cluster_spec | string | 否 | 当您选择
| ack.pro.small |
| region_id | string | 否 | 集群地域。通过指定该字段，可以过滤出该地域下的集群列表。 | cn-hangzhou |
| cluster_id | string | 否 | 集群 ID。 | c3fb96524f9274b4495df0f12a6b5**** |
返回参数
示例
正常返回示例
JSON格式
{
"clusters": [
{
"cluster_id": "c3fb96524f9274b4495df0f12a6b5****",
"cluster_type": "Kubernetes",
"created": "2025-04-07T09:57:26+08:00",
"init_version": "1.32.1-aliyun.1",
"current_version": "1.32.1-aliyun.1",
"next_version": "1.xx.x-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.xx.xx: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****",
"container_cidr": "172.20.xx.xx/16",
"service_cidr": "172.21.xx.xx/20",
"proxy_mode": "ipvs",
"timezone": "Asia/Shanghai",
"ip_stack": "ipv4",
"cluster_domain": "cluster.local",
"size": 5,
"state": "running",
"subnet_cidr": null,
"tags": [
{
"key": "env",
"value": "prod"
}
],
"updated": "2025-04-07T09:57:26+08:00",
"vpc_id": "vpc-2vcg932hsxsxuqbgl****",
"vswitch_id": "vsw-2vc41xuumx5z2rdma****,vsw-2vc41xuumx5z2rdma****",
"vswitch_ids": [
"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": "2020-10-15T12:31:00.000+08:00",
"duration": "3h",
"weekly_period": "Monday,Thursday",
"recurrence": "FREQ=WEEKLY;INTERVAL=4;BYDAY=MO,TU"
},
"operation_policy": {
"cluster_auto_upgrade": {
"enabled": true,
"channel": "patch"
}
}
}
],
"page_info": {
"page_number": 3,
"page_size": 20,
"total_count": 50
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-10-18 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-10-15 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-11-24 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2020-09-14 | OpenAPI 入参发生变更 | 查看变更详情 |