全部產品
Search
文件中心

ENS:DescribeClustersV1 - 查詢叢集列表

更新時間:Apr 21, 2026

查詢叢集列表

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ens:DescribeClustersV1

create

*全部資源

*

請求文法

POST  HTTP/1.1

請求參數

名稱

類型

必填

描述

樣本值

Name

string

叢集名稱。

test-eck-name

ClusterId

string

叢集 ID。

eck-xxxxxxxx

EnsRegionId

string

叢集所在 ENS Region ID。

cn-hangzhou-58

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

RequestId

string

Id of the request

C0003E8B-B930-4F59-ADC0-0E209A9012A8

Clusters

array<object>

叢集資訊列表。

array<object>

叢集詳細資料。

ClusterId

string

叢集執行個體 ID。

eck-xxxxxxx

Name

string

叢集名稱。

test-eck-name

AliUid

string

使用者識別碼。

1375383353108460

EnsRegionId

string

ENS 節點 ID。

cn-hangzhou-55

KubernetesVersion

string

叢集版本,與 Kubernetes 社區基準版本保持一致。建議選擇最新版本,若不指定,預設使用最新版本。

1.31.9-aliyunedge.1

VpcId

string

叢集使用的專用網路。

n-5wsgr3xeolb2ist303wp3cscp

VswitchIds

array

叢集節點所在虛擬交換器 id。vswitch_ids 所處 ENS Region 必須與 ens_region_id 一致。

string

虛擬交換器 id。

vsw-xxxxxxx

PodVswitchIds

array

每個 Pod 虛擬交換器分別對應一個 Worker 節點的虛擬交換器,Pod 虛擬交換器和 Worker 節點的虛擬交換器的可用性區域需保持一致。如果不填,預設使用 vswitch_ids。

string

虛擬交換器 id。

vsw-xxxxxxx

ContainerCidr

string

Pod 網路位址區段,必須是有效私人網段,即以下網段及其子網:10.0.0.0/8、172.16-31.0.0/12-16、192.168.0.0/16。不能與 VPC 及 VPC 內已有 Kubernetes 叢集使用的網段重複,建立成功後不能修改。

10.0.0.0/8

ServiceCidr

string

Service 網路位址區段,可選範圍:10.0.0.0/16-24,172.16-31.0.0/16-24,192.168.0.0/16-24 不能與 VPC 網段 10.1.0.0/21 及 VPC 內已有 Kubernetes 叢集使用的網段重複,建立成功後不能修改。

192.168.0.0/16

PublicAccess

boolean

是否開啟公網訪問。通過 EIP 暴露 API Server,實現叢集公網訪問。 ● true:開啟公網訪問。 ● false:不開啟公網訪問。選擇不開放時,則無法通過外網訪問叢集 API Server。

true

LoadBalancerId

string

Server Load Balancer執行個體 ID。

lb-58dngw0fyimzzvwljfec7hy0z

ControlPlaneConfig

object

控制平面配置。

InstanceSpec

string

執行個體規格。

ens.sn1.medium

ImageId

string

鏡像 ID。

m-68be8cb9f71fhyvjekxa23qsf

SystemDiskCategory

string

節點系統硬碟類型,可選類型:"local_ssd", "cloud_ssd", "cloud_efficiency", "local_hdd"。

cloud_ssd

SystemDiskSize

integer

系統硬碟大小規格,單位:GB。

100

ContainerRuntime

string

運行時的類型。

containerd

NodePortRange

string

節點服務連接埠範圍。

30000-32767

Size

integer

控制面節點數量。

5

JoinToken

string

叢集接入鑒權 token。

xxxxxxxxxx.yyyyyyy

Config

any

叢集 kubeconfig。

{ "kind": "Config", "apiVersion": "v1", "preferences": {}, "clusters": [ { "name": "kubernetes", "cluster": { "server": "https://000.000.000.000:6443", "certificate-authority-data": "" } } ], "users": [ { "name": "kubernetes-admin", "user": { "client-certificate-data": "", "client-key-data": "" } } ], "contexts": [ { "name": "kubernetes-admin@kubernetes", "context": { "cluster": "kubernetes", "user": "kubernetes-admin" } } ], "current-context": "kubernetes-admin@kubernetes" }

State

string

叢集狀態。

running

樣本

正常返回樣本

JSON格式

{
  "RequestId": "C0003E8B-B930-4F59-ADC0-0E209A9012A8",
  "Clusters": [
    {
      "ClusterId": "eck-xxxxxxx",
      "Name": "test-eck-name",
      "AliUid": "1375383353108460",
      "EnsRegionId": "cn-hangzhou-55",
      "KubernetesVersion": "1.31.9-aliyunedge.1",
      "VpcId": "n-5wsgr3xeolb2ist303wp3cscp",
      "VswitchIds": [
        "vsw-xxxxxxx"
      ],
      "PodVswitchIds": [
        "vsw-xxxxxxx"
      ],
      "ContainerCidr": "10.0.0.0/8",
      "ServiceCidr": "192.168.0.0/16",
      "PublicAccess": true,
      "LoadBalancerId": "lb-58dngw0fyimzzvwljfec7hy0z",
      "ControlPlaneConfig": {
        "InstanceSpec": "ens.sn1.medium",
        "ImageId": "m-68be8cb9f71fhyvjekxa23qsf",
        "SystemDiskCategory": "cloud_ssd",
        "SystemDiskSize": 100,
        "ContainerRuntime": "containerd",
        "NodePortRange": "30000-32767",
        "Size": 5
      },
      "JoinToken": "xxxxxxxxxx.yyyyyyy",
      "Config": "{\n        \"kind\": \"Config\",\n        \"apiVersion\": \"v1\",\n        \"preferences\": {},\n        \"clusters\": [\n          {\n            \"name\": \"kubernetes\",\n            \"cluster\": {\n              \"server\": \"https://000.000.000.000:6443\",\n              \"certificate-authority-data\": \"\"\n            }\n          }\n        ],\n        \"users\": [\n          {\n            \"name\": \"kubernetes-admin\",\n            \"user\": {\n              \"client-certificate-data\": \"\",\n              \"client-key-data\": \"\"\n            }\n          }\n        ],\n        \"contexts\": [\n          {\n            \"name\": \"kubernetes-admin@kubernetes\",\n            \"context\": {\n              \"cluster\": \"kubernetes\",\n              \"user\": \"kubernetes-admin\"\n            }\n          }\n        ],\n        \"current-context\": \"kubernetes-admin@kubernetes\"\n      }",
      "State": "running"
    }
  ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情