翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# describeClusterInstances
<a name="describe-cluster-instances"></a>

クラスターに属するインスタンスについて説明します。

**Topics**
+ [リクエスト構文](#describe-cluster-instances-request)
+ [リクエスト本文](#describe-cluster-instances-request-body)
+ [レスポンスの構文](#describe-cluster-instances-response)
+ [レスポンス本文](#describe-cluster-instances-response-body)
+ [例](#describe-cluster-instances-example)

## リクエスト構文
<a name="describe-cluster-instances-request"></a>

```
GET /v3/clusters/{clusterName}/instances
{
  "nextToken": "string",
  "nodeType": "string",
  "queueName": "string",
  "region": "string"
}
```

## リクエスト本文
<a name="describe-cluster-instances-request-body"></a>

**clusterName**  
クラスターの名前。  
タイプ: 文字列  
必須: はい

**nextToken**  
次の結果セットのトークン。  
型: 文字列  
必須: いいえ

**nodeType**  
ノードタイプ別にインスタンスをフィルタリングします。  
タイプ: 文字列  
有効な値: `HeadNode`、`ComputeNode`、`LoginNode`  
必須: いいえ

**queueName**  
キュー名でインスタンスをフィルタリングします。  
型: 文字列  
必須: いいえ

**region**  
クラスター AWS リージョン がある 。  
型: 文字列  
必須: いいえ

## レスポンスの構文
<a name="describe-cluster-instances-response"></a>

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

## レスポンス本文
<a name="describe-cluster-instances-response-body"></a>

**インスタンス**  
クラスターインスタンスのリスト。    
**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**  
次の結果セットの取得に使用できるトークン、または追加の結果がない場合は `null` です。  
タイプ: 文字列

## 例
<a name="describe-cluster-instances-example"></a>

------
#### [ Python ]

**リクエスト**

```
$ describe_cluster_instances(cluster_name_3x)
```

**200 レスポンス**

```
{
  "instances": [
    {
      "instance_id": "i-abcdef01234567890",
      "instance_type": "t2.micro",
      "launch_time": datetime.datetime(2022, 3, 30, 14, 2, 7, tzinfo=tzlocal()),
      "node_type": "HeadNode",
      "private_ip_address": "192.0.2.5",
      "public_ip_address": "198.51.100.180",
      "state": "running"
    }
  ]
}
```

------