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.

# Clusters de listes
<a name="list-clusters"></a>

Récupérez la liste des clusters existants.

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

## Syntaxe de demande
<a name="list-clusters-request"></a>

```
GET /v3/clusters
{
  "clusterStatus": "string",
  "nextToken": "string",
  "region": "string"
}
```

## Corps de la demande
<a name="list-clusters-request-body"></a>

**État du cluster**  
Filtrez par statut du cluster. La valeur par défaut est tous les clusters.  
Type : chaîne  
Valeurs valides : `CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED`  
Obligatoire : non

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

**region**  
Le Région AWS des clusters.  
Type : chaîne  
Obligatoire : non

## Syntaxe de réponse
<a name="list-clusters-response"></a>

```
{
  "nextToken": "string",
  "clusters": [
    {
      "clusterName": "string",
      "region": "string",
      "version": "string",
      "cloudformationStackArn": "string",
      "cloudformationStackStatus": "CREATE_IN_PROGRESS",
      "clusterStatus": "CREATE_IN_PROGRESS",
      "scheduler": {
        "type": "string",
        "metadata": {
          "name": "string",
          "version": "string"
        }
      }
    }
  ]
}
```

## Corps de la réponse
<a name="list-clusters-response-body"></a>

**clusters**    
**cloudformationStackArn**  
Le nom de ressource Amazon (ARN) de la CloudFormation pile principale.  
Type : chaîne  
**cloudformationStackStatus**  
L'état de la CloudFormation pile.  
Type : chaîne  
Valeurs valides : `CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | ROLLBACK_IN_PROGRESS | ROLLBACK_FAILED | ROLLBACK_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE_CLEANUP_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_ROLLBACK_IN_PROGRESS | UPDATE_ROLLBACK_FAILED | UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS | UPDATE_ROLLBACK_COMPLETE`  
**Nom du cluster**  
Nom du cluster.  
Type : chaîne  
**État du cluster**  
État du cluster.  
Type : chaîne  
Valeurs valides : `CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED`  
**planificateur**    
**métadonnées**  
Les métadonnées du planificateur.    
**name**  
Nom du planificateur.  
Type : chaîne  
**version**  
Version du planificateur.  
Type : chaîne  
**type**  
Type de planificateur.  
Type : chaîne  
**region**  
L' Région AWS endroit dans lequel le cluster est créé.  
Type : chaîne  
**version**  
 AWS ParallelCluster Version utilisée pour créer le cluster.  
Type : chaîne

**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="list-clusters-example"></a>

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

**Demande**

```
$ list_clusters()
```

**Réponse 200**

```
{
  'clusters': 
   [
      {
        'cloudformation_stack_arn': 'arn:aws:cloudformation:us-east-1:123456789012:stack/cluster_name_3x/16b49540-aee5-11ec-8e18-0ac1d712b241',
        'cloudformation_stack_status': 'CREATE_COMPLETE',
        'cluster_name': 'cluster_name_3x',
        'cluster_status': 'CREATE_COMPLETE',
        'region': 'us-east-1',
        'version': '3.2.1'
      },
      ...
   ]
}
```

------