Clusters de listes

Récupérez la liste des clusters existants.

Syntaxe de demande

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

Corps de la demande

É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

Un jeton utilisé pour les requêtes paginées.

Type : chaîne

Obligatoire : non

region

Le Région AWS des clusters.

Type : chaîne

Obligatoire : non

Syntaxe de réponse

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

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

Le dans Région AWS lequel le cluster est créé.

Type : chaîne

version

AWS ParallelCluster Version utilisée pour créer le cluster.

Type : chaîne

nextToken

Un jeton utilisé pour les requêtes paginées.

Type : chaîne

Exemple

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'
      },
      ...
   ]
}