

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

# décrire ClusterInstances
<a name="describe-cluster-instances"></a>

Décrivez les instances qui appartiennent à un cluster.

**Topics**
+ [Syntaxe de demande](#describe-cluster-instances-request)
+ [Corps de la demande](#describe-cluster-instances-request-body)
+ [Syntaxe de réponse](#describe-cluster-instances-response)
+ [Corps de la réponse](#describe-cluster-instances-response-body)
+ [Exemple](#describe-cluster-instances-example)

## Syntaxe de demande
<a name="describe-cluster-instances-request"></a>

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

## Corps de la demande
<a name="describe-cluster-instances-request-body"></a>

**Nom du cluster**  
Nom du cluster.  
Type : chaîne  
Obligatoire : oui

**nextToken**  
Jeton de l'ensemble de résultats suivant.  
Type : chaîne  
Obligatoire : non

**Type de nœud**  
Filtrez les instances par type de nœud.  
Type : chaîne  
Valeurs valides : `HeadNode`, `ComputeNode`, `LoginNode`  
Obligatoire : non

**Nom de la file d'attente**  
Filtrez les instances par nom de file d'attente.  
Type : chaîne  
Obligatoire : non

**region**  
Le dans Région AWS lequel se trouve le cluster.  
Type : chaîne  
Obligatoire : non

## Syntaxe de réponse
<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"
    }
  ]
}
```

## Corps de la réponse
<a name="describe-cluster-instances-response-body"></a>

**Instances**  
La liste des instances de cluster.    
**instanceId**  
L'ID de l'instance Amazon EC2.  
Type : chaîne  
**instanceType**  
Type d'instance Amazon EC2.  
Type : chaîne  
**launchTime**  
Heure à laquelle l'instance Amazon EC2 a été lancée.  
Type : datetime  
**Type de nœud**  
Type de nœud.  
Type : chaîne  
Valeurs valides : `HeadNode`, `ComputeNode`, `LoginNode`  
**public IpAddress**  
Adresse IP publique du cluster.  
Type : chaîne  
**Nom de la file d'attente**  
Nom de la file d'attente dans laquelle l'instance Amazon EC2 sauvegarde un nœud.  
Type : chaîne  
**state**  
État de l'instance Amazon EC2 du nœud.  
Type : chaîne  
Valeurs valides : `pending | running | shutting-down | terminated | stopping | stopped`

**nextToken**  
Jeton qui peut être utilisé pour obtenir l'ensemble de résultats suivant, ou `null`, s'il n'y a pas de résultats supplémentaires.  
Type : chaîne

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

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

**Demande**

```
$ describe_cluster_instances({{cluster_name_3x}})
```

**Réponse 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"
    }
  ]
}
```

------