使用 DescribeClusterDetail API 擷取叢集詳細資料 - 邊緣節點服務 ENS

查詢叢集詳細資料

介面說明

單使用者調用頻率： 100 次/秒。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ens:DescribeClusterDetail

get

*全部資源

*

無

請求文法

POST  HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
ClusterId	string	是	叢集 ID。	eck-11111111

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	Id of the request。	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
ClusterId	string	叢集 ID。	eck-11111111
Name	string	叢集名稱。	your-cluster-name
AliUid	string	使用者識別碼。	1574790082031102
EnsRegionId	string	ENS 節點 ID。	cn-fuzhou-23
KubernetesVersion	string	叢集版本，與 Kubernetes 社區基準版本保持一致。建議選擇最新版本，若不指定，預設使用最新版本。	1.32.1.aliyunedge.1
VpcId	string	叢集使用的專用網路。	n-xxxxxxxxx
VswitchIds	array	叢集節點所在虛擬交換器 id。
	string	叢集節點所在虛擬交換器 id。	vsw-xxxxxxxxx
PodVswitchIds	array	Pod 虛擬交換器 ID。
	string	Pod 虛擬交換器 ID。	vsw-xxxxxxxx
ContainerCidr	string	Pod 網路位址區段。	172.20.0.0/16
ServiceCidr	string	Service 網路位址區段。	172.19.0.0/20
PublicAccess	boolean	是否開啟公網訪問。	true
LoadBalancerId	string	APIServer 的 CLB 執行個體 ID。	lb-5snthcyu1x10g7tywj7iu****
ControlPlaneConfig	object	控制平面配置。
InstanceSpec	string	節點執行個體類型。	ens.esk.sn1.medium
ImageId	string	控制面虛擬機器鏡像 ID。	m-5ul335umat4e2y9ynwi84p3f9
SystemDiskCategory	string	節點系統硬碟類型。	cloud_efficiency
SystemDiskSize	integer	節點系統硬碟大小。	120
ContainerRuntime	string	運行時類型。	containerd
NodePortRange	string	節點服務連接埠範圍	30000-32767
Size	integer	控制面節點數量。	3
JoinToken	string	叢集接入鑒權 token。	xxxx.yyy
Config	any	叢集 kubeconfig。	apiVersion: v1 clusters: - cluster: certificate-authority-data: x server: https://111.111.111.111:6443 name: kubernetes contexts: - context: cluster: kubernetes user: user name: eck-xxxxx current-context: eck-xxxx kind: Config preferences: {} users: - name: user user: client-certificate-data: x client-key-data: x
State	string	叢集狀態 initial：建立中。 failed：建立失敗。 running：運行中。 deleting：釋放中。	running

樣本

正常返回樣本

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "ClusterId": "eck-11111111",
  "Name": "your-cluster-name",
  "AliUid": "1574790082031102",
  "EnsRegionId": "cn-fuzhou-23",
  "KubernetesVersion": "1.32.1.aliyunedge.1",
  "VpcId": "n-xxxxxxxxx",
  "VswitchIds": [
    "vsw-xxxxxxxxx"
  ],
  "PodVswitchIds": [
    "vsw-xxxxxxxx"
  ],
  "ContainerCidr": "172.20.0.0/16",
  "ServiceCidr": "172.19.0.0/20",
  "PublicAccess": true,
  "LoadBalancerId": "lb-5snthcyu1x10g7tywj7iu****",
  "ControlPlaneConfig": {
    "InstanceSpec": "ens.esk.sn1.medium",
    "ImageId": "m-5ul335umat4e2y9ynwi84p3f9",
    "SystemDiskCategory": "cloud_efficiency",
    "SystemDiskSize": 120,
    "ContainerRuntime": "containerd",
    "NodePortRange": "30000-32767",
    "Size": 3
  },
  "JoinToken": "xxxx.yyy",
  "Config": "apiVersion: v1\nclusters:\n- cluster:\n    certificate-authority-data: x\n    server: https://111.111.111.111:6443\n  name: kubernetes\ncontexts:\n- context:\n    cluster: kubernetes\n    user: user\n  name: eck-xxxxx\ncurrent-context: eck-xxxx\nkind: Config\npreferences: {}\nusers:\n- name: user\n  user:\n    client-certificate-data: x\n    client-key-data: x",
  "State": "running"
}

錯誤碼

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

變更歷史

更多資訊，參考變更詳情。