Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

# describeCluster
<a name="describe-cluster"></a>

Obtenga información detallada sobre un clúster existente.

**Topics**
+ [Sintaxis de la solicitud](#describe-cluster-request)
+ [Cuerpo de la solicitud](#describe-cluster-request-body)
+ [Sintaxis de la respuesta](#describe-cluster-response)
+ [Cuerpo de respuesta](#describe-cluster-response-body)
+ [Ejemplo](#describe-cluster-example)

## Sintaxis de la solicitud
<a name="describe-cluster-request"></a>

```
GET /v3/clusters/{clusterName}
{
  "region": "string"
}
```

## Cuerpo de la solicitud
<a name="describe-cluster-request-body"></a>

**clusterName**  
El nombre del clúster.  
Tipo: cadena  
Obligatorio: sí

**region**  
El lugar en el Región de AWS que se encuentra el clúster.  
Tipo: cadena  
Requerido: no

## Sintaxis de la respuesta
<a name="describe-cluster-response"></a>

**nota**  
`failureReason`ha cambiado a `failures` partir de la AWS ParallelCluster versión 3.5.0.

```
{
  "clusterName": "string",
  "region": "string",
  "version": "string",
  "cloudFormationStackStatus": "CREATE_IN_PROGRESS",
  "clusterStatus": "CREATE_IN_PROGRESS",
  "scheduler": {
    "type": "string",
    "metadata": {
      "name": "string",
      "version": "string"
    }
  },
  "cloudformationStackArn": "string",
  "creationTime": "2019-08-24T14:15:22Z",
  "lastUpdatedTime": "2019-08-24T14:15:22Z",
  "clusterConfiguration": {
    "url": "string"
  },
  "computeFleetStatus": "START_REQUESTED",
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "headNode": {
    "instanceId": "string",
    "instanceType": "string",
    "launchTime": "2019-08-24T14:15:22Z",
    "privateIpAddress": "string",
    "publicIpAddress": "string",
    "state": "pending"
  },
  "failures": [
    {
      "failureCode": "string",
      "failureReason": "string"
    }
  ],
  "loginNodes": {      
    "status": "string",
    "address": "string",
    "poolName": "string",
    "scheme": "string",
    "healthyNodes": integer,
    "unhealthyNodes": integer
  }
}
```

## Cuerpo de respuesta
<a name="describe-cluster-response-body"></a>

**clusterName**  
El nombre del clúster.  
Tipo: cadena

**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`

**clusterConfiguration**    
**url**  
La URL del archivo de configuración 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`

**computeFleetStatus**  
El estado de la flota de computación.  
Tipo: cadena  
Valores válidos: `START_REQUESTED | STARTING | RUNNING | PROTECTED | STOP_REQUESTED | STOPPING | STOPPED | UNKNOWN | ENABLED | DISABLED`

**creationTime**  
Marca de tiempo de la creación del clúster.  
Tipo: datetime

**lastUpdatedTime**  
Marca de tiempo de la última actualización del clúster.  
Tipo: datetime

**region**  
El Región de AWS lugar en el que se crea el clúster.  
Tipo: cadena

**etiquetas**  
La lista de etiquetas asociadas al clúster.    
**clave**  
Nombre de la etiqueta.  
Tipo: cadena  
**etiqueta**  
Valor de la etiqueta.  
Tipo: cadena

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

**failures**  
La lista de errores cuando la pila de clústeres está en estado `CREATE_FAILED`.    
**failureCode**  
El código de error cuando la pila de clústeres está en estado `CREATE_FAILED`.  
Tipo: cadena  
**failureReason**  
El motivo del error cuando la pila de clústeres está en estado `CREATE_FAILED`.  
Tipo: cadena

**head\$1node**  
El nodo principal del clúster.    
**instanceId**  
El ID de la EC2 instancia de Amazon.  
Tipo: cadena  
**instanceType**  
El tipo de EC2 instancia de Amazon.  
Tipo: cadena  
**launchTime**  
La hora en que se lanzó la EC2 instancia de Amazon.  
Tipo: datetime  
**privateIpAddress**  
La dirección IP privada del clúster.  
Tipo: cadena  
**publicIpAddress**  
La dirección IP pública del clúster.  
Tipo: cadena  
**estado**  
El estado de la instancia de nodo principal.  
Tipo: cadena  
Valores válidos: `pending | running | shutting-down | terminated | stopping | stopped`

**programador**    
**metadatos**  
Los metadatos del programador.    
**nombre**  
El nombre del programador.  
Tipo: cadena  
**versión**  
La versión del programador.  
Tipo: cadena

**loginNodes**    
status  
El estado del nodo de inicio de sesión.  
Tipo: cadena  
Valores válidos: `PENDING | FAILED | ACTIVE`  
dirección  
La dirección del nodo de inicio de sesión.  
Tipo: cadena  
poolName  
El nombre del grupo de nodos de inicio de sesión.  
Tipo: cadena  
scheme  
El esquema del nodo de inicio de sesión.  
Tipo: cadena  
healthyNodes  
La cantidad de nodos en buen estado.  
Tipo: número entero  
unhealthyNodes  
El número de nodos en mal estado.  
Tipo: número entero

**type**  
El tipo de programador.  
Tipo: cadena

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

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

**Solicitud**

```
$ describe_cluster(cluster_name_3x)
```

**Respuesta 200**

```
{
  "cloud_formation_stack_status": "CREATE_COMPLETE",
  "cloudformation_stack_arn": "arn:aws:cloudformation:us-east-1:123456789012:stack/cluster_name_3x/16b49540-aee5-11ec-8e18-0ac1d712b241",
  "cluster_configuration": {
    "url": "https://parallelcluster-...."
  },
  "cluster_name": "cluster_name_3x",
  "cluster_status": "CREATE_COMPLETE",
  "compute_fleet_status": "RUNNING",
  "creation_time": datetime.datetime(2022, 3, 28, 22, 19, 9, 661000, tzinfo=tzlocal()),
  "head_node": {
    "instance_id": "i-abcdef01234567890",
    "instance_type": "t2.micro",
    "launch_time": datetime.datetime(2022, 3, 28, 22, 21, 56, tzinfo=tzlocal()),
    "private_ip_address": "172.31.56.3",
    "public_ip_address": "107.23.100.164",
    "state": "running"
  },
  "last_updated_time": datetime.datetime(2022, 3, 28, 22, 19, 9, 661000, tzinfo=tzlocal()),
  "region": "us-east-1",
  "tags": [
    {
      "key": "parallelcluster:version", "value": "3.2.1"
    }
  ],
  "version": "3.2.1"
}
```

------