您可以調用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
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。