describeClusterInstances
クラスターに属するインスタンスについて説明します。
リクエストの構文
GET /v3/clusters/{clusterName}/instances { "nextToken": "string", "nodeType": "string", "queueName": "string", "region": "string" }
リクエスト本文
- clusterName
-
クラスターの名前。
タイプ: 文字列
必須: はい
- nextToken
-
ページ分割されたリクエストに使用するトークン。
タイプ: 文字列
必須: いいえ
- nodeType
-
ノードタイプ別にインスタンスをフィルタリングします。
タイプ: 文字列
有効な値:
HeadNode、ComputeNode、LoginNode必須：いいえ
- queueName
-
キュー名でインスタンスをフィルタリングします。
タイプ: 文字列
必須: いいえ
- region
-
クラスターが存在する AWS リージョン。
タイプ: 文字列
必須: いいえ
レスポンスの構文
{ "nextToken": "string", "instances": [ { "instanceId": "string", "instanceType": "string", "launchTime": "2019-08-24T14:15:22Z", "privateIpAddress": "string", "publicIpAddress": "string", "state": "pending", "nodeType": "HeadNode", "queueName": "string", "poolName": "string" } ] }
レスポンス本文
- インスタンス
-
クラスターインスタンスのリスト。
- instanceId
-
Amazon EC2 インスタンス ID。
タイプ: 文字列
- instanceType
-
Amazon EC2 インスタンスタイプ
タイプ: 文字列
- launchTime
-
EC2 インスタンスの起動時刻。
型: 日時
- nodeType
-
ノードタイプ。
タイプ: 文字列
有効な値:
HeadNode、ComputeNode、LoginNode - publicIpAddress
-
クラスターのパブリック IP アドレス。
タイプ: 文字列
- queueName
-
Amazon EC2 インスタンスがノードをバッキングしているキューの名前。
タイプ: 文字列
- state
-
ノードの Amazon EC2 インスタンスのステータス。
タイプ: 文字列
有効な値:
pending | running | shutting-down | terminated | stopping | stopped
- nextToken
-
ページ分割されたリクエストに使用するトークン。
タイプ: 文字列
例
