すべてのプロダクト
Search

このプロダクト

    Container Service for Kubernetes:DescribeClusterNodes

    ドキュメントセンター

    Container Service for Kubernetes:DescribeClusterNodes

    最終更新日:Jun 23, 2026

    クラスター内で指定された条件を満たすノードのリストを照会します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    cs:DescribeClusterNodes

    get

    *Cluster

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

    		 なし なし

    リクエスト構文

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

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ClusterId

    string

    必須

    クラスター ID。

    c82e6987e2961451182edacd74faf****

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceIds

    string

    任意

    ノードのインスタンス ID。複数の 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: クラスターのマスターノード。

    • 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

    ノードが Alibaba Cloud インスタンスかどうかを示します。有効な値:

    • true: ノードは Alibaba Cloud インスタンスです。

    • false: ノードは Alibaba Cloud インスタンスではありません。

    true
    node_name

    string

    ノード名。クラスター内のノードの識別子です。

    cn-chengdu.192.168xx.xx
    node_status

    string

    ノードの準備状態を示します。有効な値:

    • Ready: ノードは準備完了です。

    • NotReady: ノードは準備ができていません。

    • Unknown: ノードのステータスは不明です。

    • Offline: ノードはオフラインです。

    Ready
    nodepool_id

    string

    ノードプール ID。

    np0794239424a84eb7a95327369d56****
    source

    string

    手動作成や Resource Orchestration Service (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

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

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

    変更履歴

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