DescribeClusterNodes - Container Service for Kubernetes

您可以呼叫 DescribeClusterNodes 介面，查詢符合條件的節點列表資訊。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

cs:DescribeClusterNodes

get

*Cluster

acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

無

請求文法

GET /clusters/{ClusterId}/nodes HTTP/1.1

路徑參數

名稱	類型	必填	描述	樣本值
ClusterId	string	是	叢集 ID。	c82e6987e2961451182edacd74faf****

請求參數

名稱	類型	必填	描述	樣本值
instanceIds	string	否	節點執行個體 ID 列表，多值使用英文半形逗號（,）分隔。	"i-bp11xjhwkj8k966u**,i-bp1dmhc2bu5igkyq**"
nodepool_id	string	否	節點池 ID。	npe25633140a7d4fbea56cd0479c******
state	string	否	叢集節點狀態，按照叢集節點運行狀態進行過濾，取值： `all`：不按照運行狀態進行過濾，查詢所有狀態的節點。 `running`：正在運行的叢集節點。 `removing`：正在刪除的叢集節點。 `initial`：正在初始化的叢集節點。 `failed`：建立失敗的叢集節點。預設值：`all`。	running
pageSize	string	否	每頁可顯示的最大記錄數。取值範圍為[1,100]。預設值：10。	10
pageNumber	string	否	目前查詢的頁碼數。預設值：1。	1
nodeNames	string	否		cn-hangzhou.192.168.0.1
nodeIps	string	否		192.168.0.1
nodeLabels	string	否		nodeLabels=app=nginx,env=prod

返回參數

名稱	類型	描述	樣本值
	object	返回資料體。
nodes	array<object>	節點詳情列表。
	object	節點詳情。
creation_time	string	節點建立時間。	2025-04-16T07:28:00Z
error_message	string	節點建立時錯誤資訊。	error***
expired_time	string	節點到期時間。	2099-12-31T15:59:00Z
host_name	string	節點主機名稱。	iZ2vcckdmxp7u0urj2k****
image_id	string	節點使用的系統映像 ID。	aliyun_3_x64_20G_alibase_20241218.vhd
instance_charge_type	string	節點付費類型。取值： `PrePaid`：預付費，包年包月。 `PostPaid`：按量付費。	PostPaid
instance_id	string	節點執行個體 ID。	i-2vcckdmxp7u0urj2****
instance_name	string	節點在叢集中的名稱。	worker-k8s-for-cs-c5cdf7e3938bc4f8eb0e44b21a80f****
instance_role	string	節點角色類型： Master：叢集 Master 節點。 Worker：叢集 Worker 節點。	Worker
instance_status	string	節點對應的 ECS 狀態。 `Pending`：建立中。 `Running`：運行中。 `Starting`：啟動中。 `Stopping`：停止中。 `Stopped`：已停止。	Running
instance_type	string	節點規格。	ecs.c5.xlarge
instance_type_family	string	節點所屬 ECS 規格族名稱。	ecs.c5
ip_address	array	節點 IP 位址。
	string	IP 位址。	192.168.xx.xx
is_aliyun_node	boolean	是否為阿里雲執行個體。取值： `true`：是阿里雲執行個體。 `false`：不是阿里雲執行個體。	true
node_name	string	節點名稱，叢集內節點標識。	cn-chengdu.192.168xx.xx
node_status	string	節點是否就緒。取值： `Ready`：節點已就緒。 `NotReady`：節點未就緒。 `Unknown`：未知。 `Offline`：離線中。	Ready
nodepool_id	string	節點池 ID。	np0794239424a84eb7a95327369d56****
source	string	節點透過何種方式初始化，例如：手動建立或 ROS 建立。	ess
state	string	節點運行狀態。取值： `pending`：建立中。 `running`：運行中。 `starting`：啟動中。 `stopping`：停止中。 `stopped`：已停止。	running
spot_strategy	string	搶佔式執行個體類型，取值： NoSpot：非搶佔式執行個體。 SpotWithPriceLimit：設定搶佔執行個體價格上限。 SpotAsPriceGo：系統自動出價，跟隨目前市場實際價格。	NoSpot
page	object	分頁資訊。
page_number	integer	目前頁碼。	1
page_size	integer	每頁可顯示的最大記錄數。	10
total_count	integer	結果總數。	5

樣本

正常返回樣本

JSON格式

{
  "nodes": [
    {
      "creation_time": "2025-04-16T07:28:00Z",
      "error_message": "error***",
      "expired_time": "2099-12-31T15:59:00Z",
      "host_name": "iZ2vcckdmxp7u0urj2k****",
      "image_id": "aliyun_3_x64_20G_alibase_20241218.vhd",
      "instance_charge_type": "PostPaid",
      "instance_id": "i-2vcckdmxp7u0urj2****",
      "instance_name": "worker-k8s-for-cs-c5cdf7e3938bc4f8eb0e44b21a80f****",
      "instance_role": "Worker",
      "instance_status": "Running",
      "instance_type": "ecs.c5.xlarge",
      "instance_type_family": "ecs.c5",
      "ip_address": [
        "192.168.xx.xx"
      ],
      "is_aliyun_node": true,
      "node_name": "cn-chengdu.192.168xx.xx",
      "node_status": "Ready",
      "nodepool_id": "np0794239424a84eb7a95327369d56****",
      "source": "ess",
      "state": "running",
      "spot_strategy": "NoSpot"
    }
  ],
  "page": {
    "page_number": 1,
    "page_size": 10,
    "total_count": 5
  }
}

錯誤碼

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

變更歷史

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