すべてのプロダクト
Search

このプロダクト

    ENS:DescribeClusterNodePools

    ドキュメントセンター

    ENS:DescribeClusterNodePools

    最終更新日:Mar 31, 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

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ClusterId

    string

    必須

    クラスターの ID。

    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-node-pool-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

    システムディスクのサイズ (GB 単位)。

    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

    例

    成功レスポンス

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

    エラーコード

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

    変更履歴

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