您可以调用DescribeClustersV1接口查看本账号下符合条件的ACK集群（例如指定集群类型、集群规格）列表信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
cs:GetClusters |
get |
*Cluster
|
无 | 无 |
请求语法
GET /api/v1/clusters HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| name |
string |
否 |
集群名称。 |
cluster-demo |
| cluster_type |
string |
否 |
集群类型。
|
Kubernetes |
| page_size |
integer |
否 |
每页显示的记录数。 |
10 |
| page_number |
integer |
否 |
当前页码。 |
1 |
| profile |
string |
否 |
当您选择
|
Default |
| cluster_spec |
string |
否 |
选择
Pro XL、Pro 2XL、Pro 4XL 为ACK Pro 预设控制面提供的三个档位，通过预先分配并固化控制面资源，确保 API 并发与 Pod 调度能力始终处于确定的高水平状态，适用于 AI 训练推理、超大规模集群及关键任务型业务。 Pro 版及预设控制面版本的集群管理费用请参见集群管理费用。 |
ack.pro.small |
| region_id |
string |
否 |
集群地域。通过指定该字段，可以过滤出该地域下的集群列表。 |
cn-hangzhou |
| cluster_id |
string |
否 |
集群 ID。 |
c3fb96524f9274b4495df0f12a6b5**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回体数据。 |
||
| clusters |
array<object> |
集群信息列表。 |
|
|
array<object> |
集群实例。 |
||
| cluster_id |
string |
集群 ID。 |
c3fb96524f9274b4495df0f12a6b5**** |
| cluster_type |
string |
集群类型。 |
Kubernetes |
| created |
string |
集群创建时间。 |
2025-04-07T09:57:26+08:00 |
| init_version |
string |
集群版本。ACK 支持的 Kubernetes 版本，请参见 Kubernetes 版本发布概览。 |
1.32.1-aliyun.1 |
| current_version |
string |
集群当前版本。 |
1.32.1-aliyun.1 |
| next_version |
string |
集群可升级版本。 |
1.xx.x-aliyun.1 |
| deletion_protection |
boolean |
集群删除保护，防止通过控制台或 API 误删除集群。取值：
|
true |
docker_version
deprecated
|
string |
集群 Docker 版本。 |
19.03.5 |
external_loadbalancer_id
deprecated
|
string |
集群中 Ingress SLB 实例。 默认实例规格：性能保障型（slb.s1.small）。 |
lb-2vcrbmlevo6kjpgch**** |
| master_url |
string |
集群 API Server 访问地址，包含内网访问地址以及公网访问地址。 |
{\"api_server_endpoint\":\"\",\"intranet_api_server_endpoint\":\"https://192.168.xx.xx:6443\"} |
| meta_data |
string |
集群元数据信息。 |
{\"Addons\":[{\"config\":***}} |
| name |
string |
集群名称。 |
cluster-demo |
network_mode
deprecated
|
string |
集群网络模式。取值：
|
vpc |
private_zone
deprecated
|
boolean |
集群 Private Zone 配置。取值：
|
false |
| profile |
string |
集群子类型。 |
Default |
| region_id |
string |
集群所在地域 ID。 |
cn-beijing |
| resource_group_id |
string |
集群资源组 ID。 |
rg-acfmyvw3wjm**** |
| security_group_id |
string |
集群安全组 ID。 |
sg-2vcgwsrwgt5mp0yi**** |
| container_cidr |
string |
Pod 网络网段，Flannel 网络配置。 |
172.20.xx.xx/16 |
| service_cidr |
string |
服务网络网段。 |
172.21.xx.xx/20 |
| proxy_mode |
string |
kube-proxy 代理模式。
|
ipvs |
| timezone |
string |
时区。 |
Asia/Shanghai |
| ip_stack |
string |
集群的 IP 协议栈，可取值：
|
ipv4 |
| cluster_domain |
string |
集群本地域名。 |
cluster.local |
| size |
integer |
集群当前节点数量，包含 Master 节点以及 Worker 节点。 |
5 |
| state |
string |
集群运行状态，取值：
|
running |
subnet_cidr
deprecated
|
string |
【该字段已废弃】请使用 container_cidr 获取 Pod 网络网段。 |
null |
| tags |
array |
集群资源标签。 |
|
| tag |
集群资源标签。 |
||
| updated |
string |
集群更新时间。 |
2025-04-07T09:57:26+08:00 |
| vpc_id |
string |
集群专有网络 ID。 |
vpc-2vcg932hsxsxuqbgl**** |
vswitch_id
deprecated
|
string |
集群虚拟交换机 ID。 |
vsw-2vc41xuumx5z2rdma****,vsw-2vc41xuumx5z2rdma**** |
| vswitch_ids |
array |
集群控制面虚拟交换机。 |
|
|
string |
集群控制面虚拟交换机。 |
vsw-2vc41xuumx5z2rdma**** |
|
worker_ram_role_name
deprecated
|
string |
Worker RAM 角色名称，授权 ECS 实例为集群 Worker 节点。 |
KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0**** |
zone_id
deprecated
|
string |
集群所属可用区 ID。 |
cn-beijing-b |
| cluster_spec |
string |
集群规格。 |
ack.standard |
| maintenance_window | maintenance_window |
集群维护窗口，该功能只在 ACK 托管集群和 ACK Serverless 集群中生效。 |
|
| operation_policy |
object |
集群自动运维策略。 |
|
| cluster_auto_upgrade |
object |
集群自动升级。 |
|
| enabled |
boolean |
是否开启集群自动升级。 |
true |
| channel |
string |
集群自动升级频次。更多信息，请参见升级频次。 取值：
|
patch |
| page_info |
object |
分页信息。 |
|
| page_number |
integer |
分页数。 |
3 |
| page_size |
integer |
单页大小。 |
20 |
| total_count |
integer |
结果总数。 |
50 |
示例
正常返回示例
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
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。