通過 API 分頁查詢 ENS 叢集節點池 - 邊緣節點服務 ENS - 阿里雲 - ENS

查詢叢集內所有節點池列表。

介面說明

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

ens:DescribeClusterNodePools

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
ClusterId	string	是	A short description of struct	eck-xxxxxxxx
PageNumber	integer	是	分頁頁碼（從 1 開始）	1
PageSize	integer	是	分頁每頁大小	10

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
Page	object	當前頁頁碼。
PageNumber	integer	頁碼。	1
PageSize	integer	輸入時設定的每頁行數。	10
TotalCount	integer	總數。	20
NodePools	array<object>	節點池列表。
	array<object>
NodepoolInfo	object	節點池資訊。
Name	string	節點池名稱。	eck-node-pool-1
EnsRegionId	string	ENS 的節點 ID。	cn-fuzhou-23
NodepoolId	string	節點池 ID。	np68mi5y1dd748ky37ojo2kqdrz
ScalingGroup	object	Auto Scaling組
VswitchIds	array	虛擬交換器 id。
	string	虛擬交換器 id。	vsw-58eu2p6v64qw8ihhit1wz7wgv
InstanceChargeType	string	執行個體計費方式。	PrePaid
InstanceTypes	array	規格列表資訊。
	string	規格列表資訊。	ens.sn1.small
SystemDiskCategory	string	節點系統硬碟類型，可選類型："local_ssd", "cloud_ssd", "cloud_efficiency", "local_hdd"。	cloud_efficiency
SystemDiskSize	integer	節點系統硬碟大小	80
ImageId	string	鏡像 ID。	m-673f5z4h69ibwtallg6zmcaxr
KeyPairName	string	金鑰組名稱。	key-pair-name
DataDisks	array<object>	資料盤列表，參數限制同系統硬碟
	object	資料盤列表，參數限制同系統硬碟
Category	string	磁碟類型	cloud_efficiency
Size	integer	磁碟大小，單位 GB。	80
Password	string	執行個體的密碼。	************
KubernetesConfig	object	kubernetes 相關配置。
PreUserData	string	執行個體建立後，接入叢集前執行的指令碼，內容需要 base64。	ZWNobyBvawo=
UserData	string	執行個體建立後，接入叢集後執行的指令碼，內容需要 base64。	ZWNobyBvawo=
Status	object	節點池狀態。
State	string	節點池狀態。 active：已達終態 scaling：擴容中 removing_nodes：縮容中	active
TotalNodes	integer	總執行個體數（包含建立中、使用中、刪除中的）。	10
DesiredNodes	integer	期望執行個體數。	10
ServingNodes	integer	使用中的執行個體數。	10
InitialNodes	integer	建立中的執行個體數。	0
RemovingNodes	integer	刪除中的執行個體數。	0
FailedNodes	integer		0
ClusterId	string	叢集 ID。	eck-xxxxxxxx
RequestId	string	請求 ID。	F3B261DD-3858-4D3C-877D-303ADF374600

樣本

正常返回樣本

JSON格式

{
  "Page": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 20
  },
  "NodePools": [
    {
      "NodepoolInfo": {
        "Name": "eck-node-pool-1",
        "EnsRegionId": "cn-fuzhou-23",
        "NodepoolId": "np68mi5y1dd748ky37ojo2kqdrz"
      },
      "ScalingGroup": {
        "VswitchIds": [
          "vsw-58eu2p6v64qw8ihhit1wz7wgv"
        ],
        "InstanceChargeType": "PrePaid",
        "InstanceTypes": [
          "ens.sn1.small"
        ],
        "SystemDiskCategory": "cloud_efficiency",
        "SystemDiskSize": 80,
        "ImageId": "m-673f5z4h69ibwtallg6zmcaxr",
        "KeyPairName": "key-pair-name",
        "DataDisks": [
          {
            "Category": "cloud_efficiency",
            "Size": 80
          }
        ],
        "Password": "************"
      },
      "KubernetesConfig": {
        "PreUserData": "ZWNobyBvawo=",
        "UserData": "ZWNobyBvawo="
      },
      "Status": {
        "State": "active",
        "TotalNodes": 10,
        "DesiredNodes": 10,
        "ServingNodes": 10,
        "InitialNodes": 0,
        "RemovingNodes": 0,
        "FailedNodes": 0
      },
      "ClusterId": "eck-xxxxxxxx"
    }
  ],
  "RequestId": "F3B261DD-3858-4D3C-877D-303ADF374600"
}

錯誤碼

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

變更歷史

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