listClusters

Rufen Sie eine Liste vorhandener Cluster ab.

Erforderliche Syntax

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

Anforderungstext

clusterStatus

Nach Clusterstatus filtern. Die Standardeinstellung ist „Alle Cluster“.

Typ: Zeichenfolge

Zulässige Werte: CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED

Erforderlich: nein

nextToken

Ein Token, das für paginierte Anfragen verwendet wird.

Typ: Zeichenfolge

Erforderlich: Nein

Region

Der AWS-Region der Cluster.

Typ: Zeichenfolge

Erforderlich: Nein

Antwortsyntax

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

Antworttext

Cluster

cloudformationStackArn

Der Amazon-Ressourcenname (ARN) des CloudFormation Hauptstapels.

Typ: Zeichenfolge

cloudformationStackStatus

Der CloudFormation Stack-Status.

Typ: Zeichenfolge

Zulässige Werte: 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

clusterName

Der Name des Clusters

Typ: Zeichenfolge

clusterStatus

Der Cluster-Status.

Typ: Zeichenfolge

Zulässige Werte: CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED

Scheduler

Metadaten

Die Scheduler-Metadaten.

Name

Der Name des Schedulers.

Typ: Zeichenfolge

version

Die Scheduler-Version.

Typ: Zeichenfolge

Typ

Der Typ des Schedulers.

Typ: Zeichenfolge

Region

Der AWS-Region , in dem der Cluster erstellt wurde.

Typ: Zeichenfolge

version

Die AWS ParallelCluster Version, die zum Erstellen des Clusters verwendet wurde.

Typ: Zeichenfolge

nextToken

Ein Token, das für paginierte Anfragen verwendet wird.

Typ: Zeichenfolge

Beispiel

Python

Anforderung

$ list_clusters()

200 Antwort

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