查询指定地域内全部集群列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
cs:DescribeClustersForRegion |
list |
*全部资源
|
无 | 无 |
请求语法
GET /regions/{region_id}/clusters HTTP/1.1路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| region_id |
string |
是 |
地域。 |
cn-hangzhou |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| name |
string |
否 |
通过集群名称进行模糊查询。 |
test-cluster |
| cluster_type |
string |
否 |
查询指定类型的集群，可取值：
枚举值：
|
Kubernetes |
| page_size |
integer |
否 |
每页记录数量。 |
3 |
| page_number |
integer |
否 |
页数。 |
10 |
| profile |
string |
否 |
查询指定子类型的集群，可取值：
枚举值：
|
Serverless |
| cluster_spec |
string |
否 |
查询指定规格的集群。取值：
Pro XL、Pro 2XL、Pro 4XL 为ACK Pro 预设控制面提供的三个档位，通过预先分配并固化控制面资源，确保 API 并发与 Pod 调度能力始终处于确定的高水平状态，适用于 AI 训练推理、超大规模集群及关键任务型业务。 Pro 版及预设控制面版本的集群管理费用请参见集群管理费用。 枚举值：
|
ack.standard |
| cluster_id |
string |
否 |
集群 ID。 |
c8155823d057948c69a**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回数据体。 |
||
| clusters |
array<object> |
集群详情列表。 |
|
|
object |
集群详情。 |
||
| cluster_id |
string |
集群 ID。 |
c905d1364c2dd4b6284a3f41790c4**** |
| cluster_type |
string |
集群类型：
|
ManagedKubernetes |
| created |
string |
集群创建时间。 |
2020-12-01T20:40:40+08:00 |
| init_version |
string |
集群初始版本。 |
1.16.6-aliyun.1 |
| current_version |
string |
集群当前版本。 |
1.16.6-aliyun.1 |
| next_version |
string |
集群可升级版本。 |
1.18.8-aliyun.1 |
| deletion_protection |
boolean |
集群删除保护，防止通过控制台或 API 误删除集群。取值：
|
false |
| name |
string |
集群名称。 |
test-cluster |
| profile |
string |
集群子类型：
|
Default |
| region_id |
string |
地域 ID。 |
cn-beijing-a |
| resource_group_id |
string |
集群资源组 ID。 |
rg-acfmyvw3wjm**** |
| security_group_id |
string |
集群安全组 ID。 |
sg-2zeihch86ooz9io4**** |
| container_cidr |
string |
集群 Pod 网络网段。 |
172.20.0.0/16 |
| service_cidr |
string |
服务网络网段。 |
172.21.0.0/20 |
| proxy_mode |
string |
集群 kube-proxy 代理模式。 枚举值：
|
ipvs |
| timezone |
string |
时区。 |
Asia/Shanghai |
| ip_stack |
string |
集群的 IP 协议栈。 |
ipv4 |
| cluster_domain |
string |
集群本地域名 |
cluster.local |
| size |
integer |
集群节点数。 |
2 |
| state |
string |
集群运行状态，取值：
|
running |
| tags |
array |
集群标签列表。 |
|
| tag |
集群标签。 |
||
| updated |
string |
集群更新时间。 |
2020-12-08T15:37:00+08:00 |
| vpc_id |
string |
集群所在的 VPC ID。 |
vpc-2zeg8nf1ukc0fcmvq**** |
| vswitch_ids |
array |
集群控制面虚拟交换机列表。 |
|
|
string |
集群控制面虚拟交换机。 |
vsw-2vc41xuumx5z2rdma**** |
|
| cluster_spec |
string |
集群的规格。取值：
Pro XL、Pro 2XL、Pro 4XL 为ACK Pro 预设控制面提供的三个档位，通过预先分配并固化控制面资源，确保 API 并发与 Pod 调度能力始终处于确定的高水平状态，适用于 AI 训练推理、超大规模集群及关键任务型业务。 Pro 版及预设控制面版本的集群管理费用请参见集群管理费用。 |
ack.standard |
| page_info |
object |
分页信息。 |
|
| page_number |
integer |
页数。 |
1 |
| page_size |
integer |
每页记录数量。 |
10 |
| total_count |
integer |
结果总数。 |
10 |
示例
正常返回示例
JSON格式
{
"clusters": [
{
"cluster_id": "c905d1364c2dd4b6284a3f41790c4****",
"cluster_type": "ManagedKubernetes",
"created": "2020-12-01T20:40:40+08:00",
"init_version": "1.16.6-aliyun.1",
"current_version": "1.16.6-aliyun.1",
"next_version": "1.18.8-aliyun.1",
"deletion_protection": false,
"name": "test-cluster",
"profile": "Default",
"region_id": "cn-beijing-a",
"resource_group_id": "rg-acfmyvw3wjm****",
"security_group_id": "sg-2zeihch86ooz9io4****",
"container_cidr": "172.20.0.0/16",
"service_cidr": "172.21.0.0/20",
"proxy_mode": "ipvs",
"timezone": "Asia/Shanghai",
"ip_stack": "ipv4",
"cluster_domain": "cluster.local",
"size": 2,
"state": "running",
"tags": [
{
"key": "env",
"value": "prod"
}
],
"updated": "2020-12-08T15:37:00+08:00",
"vpc_id": "vpc-2zeg8nf1ukc0fcmvq****",
"vswitch_ids": [
"vsw-2vc41xuumx5z2rdma****"
],
"cluster_spec": "ack.standard"
}
],
"page_info": {
"page_number": 1,
"page_size": 10,
"total_count": 10
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。