

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.

# describeClusterInstances
<a name="describe-cluster-instances"></a>

Describe las instancias que pertenecen a un clúster.

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

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

```
GET /v3/clusters/{clusterName}/instances
{
  "nextToken": "string",
  "nodeType": "string",
  "queueName": "string",
  "region": "string"
}
```

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

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

**nextToken**  
El token del conjunto siguiente de resultados.  
Tipo: cadena  
Requerido: no

**nodeType**  
Filtra las instancias por tipo de nodo.  
Tipo: cadena  
Valores válidos: `HeadNode`, `ComputeNode`, `LoginNode`  
Obligatorio: no

**queueName**  
Filtra las instancias por nombre de cola.  
Tipo: cadena  
Requerido: no

**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-instances-response"></a>

```
{
  "nextToken": "string",
  "instances": [
    {
      "instanceId": "string",
      "instanceType": "string",
      "launchTime": "2019-08-24T14:15:22Z",
      "privateIpAddress": "string",
      "publicIpAddress": "string",
      "state": "pending",
      "nodeType": "HeadNode",
      "queueName": "string",
      "poolName": "string"
    }
  ]
}
```

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

**instances**  
La lista de instancias 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  
**nodeType**  
El tipo de nodo.  
Tipo: cadena  
Valores válidos: `HeadNode`, `ComputeNode`, `LoginNode`  
**publicIpAddress**  
La dirección IP pública del clúster.  
Tipo: cadena  
**queueName**  
El nombre de la cola en la que la EC2 instancia de Amazon respalda un nodo.  
Tipo: cadena  
**estado**  
El estado de la EC2 instancia de Amazon del nodo.  
Tipo: cadena  
Valores válidos: `pending | running | shutting-down | terminated | stopping | stopped`

**nextToken**  
Un token que se puede utilizar para recuperar el siguiente conjunto de resultados o `null` si no hay resultados adicionales.  
Tipo: cadena

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

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

**Solicitud**

```
$ describe_cluster_instances(cluster_name_3x)
```

**Respuesta 200**

```
{
  "instances": [
    {
      "instance_id": "i-abcdef01234567890",
      "instance_type": "t2.micro",
      "launch_time": datetime.datetime(2022, 3, 30, 14, 2, 7, tzinfo=tzlocal()),
      "node_type": "HeadNode",
      "private_ip_address": "192.0.2.5",
      "public_ip_address": "198.51.100.180",
      "state": "running"
    }
  ]
}
```

------