您可以調用DescribeClustersV1接口查看本賬號下符合條件的ACK集群（例如指定集群類型、集群規格）列表信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| cs:GetClusters | get |
|
| 無 |
請求語法
GET /api/v1/clusters HTTP/1.1
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| name | string | 否 | 集群名稱。 命名規則：由數字、漢字、英文字符或短劃線（-）組成，長度范圍 1~63 個字符，且不能以短劃線（-）開頭。 | cluster-demo |
| cluster_type | string | 否 |
| Kubernetes |
| page_size | long | 否 | 每頁顯示的記錄數。 | 10 |
| page_number | long | 否 | 當前頁碼。 | 3 |
| 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": "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****",
"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": 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****",
"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 入參發生變更 | 查看變更詳情 |