查询指定地域内全部集群列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| cs:DescribeClustersForRegion | list | *全部资源 * |
| 无 |
请求语法
GET /regions/{region_id}/clusters HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| name | string | 否 | 通过集群名称进行模糊查询。 | test-cluster |
| cluster_type | string | 否 | 查询指定类型的集群，可取值：
| Kubernetes |
| page_size | long | 否 | 每页记录数量。 | 3 |
| page_number | long | 否 | 页数。 | 10 |
| profile | string | 否 | 查询指定子类型的集群，可取值：
| Serverless |
| cluster_spec | string | 否 | 查询指定规格的集群，可取值：
| ack.standard |
| cluster_id | string | 否 | 集群 ID。 | c8155823d057948c69a**** |
| region_id | string | 是 | 地域。 | cn-hangzhou |
返回参数
示例
正常返回示例
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
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史