すべてのプロダクト
Search
ドキュメントセンター

ENS:DescribeClusterNodePools

最終更新日:Sep 22, 2026

クラスター内のすべてのノードプールのリストを照会します。

操作説明

  • 単一ユーザーの呼び出し周波数: 1 秒あたり 100 回。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ens:DescribeClusterNodePools

list

*すべてのリソース。

*

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

ClusterId

string

必須

構造体の簡単な説明。

eck-xxxxxxxx

PageNumber

integer

必須

ページ番号。1 から始まります。

1

PageSize

integer

必須

1 ページあたりのエントリ数。

10

レスポンスフィールド

フィールド

型

説明

例

object

応答のスキーマ。

Page

object

現在のページのページネーション情報。

PageNumber

integer

ページ番号。

1

PageSize

integer

リクエストで指定した 1 ページあたりのエントリ数。

10

TotalCount

integer

エントリの総数。

20

NodePools

array<object>

ノードプールのリスト。

array<object>

NodepoolInfo

object

ノードプール情報。

Name

string

ノードプールの名前。

eck-ノードプール-1

EnsRegionId

string

ENS のエッジゾーンの ID。

cn-fuzhou-23

NodepoolId

string

ノードプール ID。

np68mi5y1dd748ky37ojo2kqdrz

ScalingGroup

object

スケーリンググループ。

VswitchIds

array

vSwitch の ID。

string

vSwitch の 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: ノードプールがスケールイン中です。

アクティブな

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

例

成功レスポンス

JSONJSON

{
  "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"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。