As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

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

Descreve as instâncias que pertençam a um cluster.

**Topics**
+ [Sintaxe da solicitação](#describe-cluster-instances-request)
+ [Corpo da solicitação](#describe-cluster-instances-request-body)
+ [Sintaxe da resposta](#describe-cluster-instances-response)
+ [Corpo da resposta](#describe-cluster-instances-response-body)
+ [Exemplo](#describe-cluster-instances-example)

## Sintaxe da solicitação
<a name="describe-cluster-instances-request"></a>

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

## Corpo da solicitação
<a name="describe-cluster-instances-request-body"></a>

**clusterName**  
O nome do cluster.  
Tipo: string  
Obrigatório: Sim

**nextToken**  
O token para o próximo conjunto de resultados.  
Tipo: string  
Obrigatório: Não

**nodeType**  
Filtra as instâncias por tipo de nó.  
Tipo: string  
Valores válidos: `HeadNode`, `ComputeNode`, `LoginNode`  
Obrigatório: Não

**queueName**  
Filtra as instâncias pelo nome da fila.  
Tipo: string  
Obrigatório: Não

**região**  
O em Região da AWS que o cluster está.  
Tipo: string  
Obrigatório: Não

## Sintaxe da resposta
<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"
    }
  ]
}
```

## Corpo da resposta
<a name="describe-cluster-instances-response-body"></a>

**instâncias**  
A lista de instâncias do cluster.    
**instanceId**  
O ID da EC2 instância da Amazon.  
Tipo: string  
**instanceType**  
O tipo de EC2 instância da Amazon.  
Tipo: string  
**launchTime**  
A hora em que a EC2 instância da Amazon foi lançada.  
Tipo: datetime  
**nodeType**  
O tipo de nó.  
Tipo: string  
Valores válidos: `HeadNode`, `ComputeNode`, `LoginNode`  
**publicIpAddress**  
O endereço IP público do cluster.  
Tipo: string  
**queueName**  
O nome da fila na qual a EC2 instância da Amazon está apoiando um nó.  
Tipo: string  
**estado**  
O status da EC2 instância do nó da Amazon.  
Tipo: string  
Valores válidos: `pending | running | shutting-down | terminated | stopping | stopped`

**nextToken**  
Um token que pode ser usado para recuperar o próximo conjunto de resultados ou `null` se não houver resultados adicionais.  
Tipo: string

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

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

**Solicitação**

```
$ describe_cluster_instances({{cluster_name_3x}})
```

**Resposta 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"
    }
  ]
}
```

------