listClusters

Obtenga una lista de los clústeres existentes.

Sintaxis de la solicitud

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

Cuerpo de la solicitud

clusterStatus

Filtra por estado de clúster. El valor predeterminado es todos los clústeres.

Tipo: cadena

Valores válidos: CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED

Obligatorio: no

nextToken

Un token que se usa para las solicitudes paginadas.

Tipo: cadena

Requerido: no

región

El Región de AWS de los clústeres.

Tipo: cadena

Requerido: no

Sintaxis de la respuesta

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

Cuerpo de respuesta

clústeres

cloudformationStackArn

El nombre de recurso de Amazon (ARN) de la pila principal CloudFormation .

Tipo: cadena

cloudformationStackStatus

El estado de la CloudFormation pila.

Tipo: cadena

Valores válidos: 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

El nombre del clúster.

Tipo: cadena

clusterStatus

El estado del clúster.

Tipo: cadena

Valores válidos: CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED

programador

metadatos

Los metadatos del programador.

name

El nombre del programador.

Tipo: cadena

versión

La versión del programador.

Tipo: cadena

type

El tipo de programador.

Tipo: cadena

región

El Región de AWS lugar en el que se creó el clúster.

Tipo: cadena

versión

La AWS ParallelCluster versión que se utiliza para crear el clúster.

Tipo: cadena

nextToken

Un token que se usa para las solicitudes paginadas.

Tipo: cadena

Ejemplo

Python

Solicitud

$ list_clusters()

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