查詢指定地區內全部叢集列表。
調試
您可以在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
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。