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á.
# describeCluster
Obtém informações detalhadas sobre um cluster existente.
**Topics**
+ [Sintaxe da solicitação](#describe-cluster-request)
+ [Corpo da solicitação](#describe-cluster-request-body)
+ [Sintaxe da resposta](#describe-cluster-response)
+ [Corpo da resposta](#describe-cluster-response-body)
+ [Exemplo](#describe-cluster-example)
## Sintaxe da solicitação
```
GET /v3/clusters/{clusterName}
{
"region": "string"
}
```
## Corpo da solicitação
**clusterName**
O nome do cluster.
Tipo: string
Obrigatório: Sim
**região**
O em Região da AWS que o cluster está.
Tipo: string
Obrigatório: Não
## Sintaxe da resposta
**nota**
`failureReason`mudou para `failures` começar com a AWS ParallelCluster versão 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
}
}
```
## Corpo da resposta
**clusterName**
O nome do cluster.
Tipo: string
**cloudformationStackArn**
O Amazon Resource Name (ARN) da pilha principal CloudFormation .
Tipo: string
**cloudformationStackStatus**
O status da CloudFormation pilha.
Tipo: string
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**
URL do arquivo de configuração do cluster.
Tipo: string
**clusterStatus**
Status do cluster.
Tipo: string
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**
Status da frota de computação.
Tipo: string
Valores válidos: `START_REQUESTED | STARTING | RUNNING | PROTECTED | STOP_REQUESTED | STOPPING | STOPPED | UNKNOWN | ENABLED | DISABLED`
**creationTime**
Marca de data e hora da criação do cluster.
Tipo: datetime
**lastUpdatedTime**
Marca de data/hora da última atualização do cluster.
Tipo: datetime
**região**
O Região da AWS no qual o cluster é criado.
Tipo: string
**tags**
Lista de tags associadas ao cluster.
**key**
Nome da tag.
Tipo: string
**tag**
Valor da tag.
Tipo: string
**version**
A AWS ParallelCluster versão usada para criar o cluster.
Tipo: string
**falhas**
A lista de falhas quando a pilha do cluster está em status `CREATE_FAILED`.
**failureCode**
Código de falha quando a pilha do cluster está em status `CREATE_FAILED`.
Tipo: string
**failureReason**
Razão da falha quando a pilha do cluster está em status `CREATE_FAILED`.
Tipo: string
**head\$1node**
Nó principal 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
**privateIpAddress**
O endereço IP privado do cluster.
Tipo: string
**publicIpAddress**
O endereço IP público do cluster.
Tipo: string
**estado**
O status da instância do nó principal.
Tipo: string
Valores válidos: `pending | running | shutting-down | terminated | stopping | stopped`
**scheduler (programador)**
**metadados**
Os metadados do programador.
**nome**
O nome do programador.
Tipo: string
**version**
A versão do programador.
Tipo: string
**loginNodes**
status
O status do nó de login.
Tipo: string
Valores válidos: `PENDING | FAILED | ACTIVE`
address
O endereço do nó de login.
Tipo: string
poolName
O nome do grupo de nós de login.
Tipo: string
scheme
O esquema do nó de login.
Tipo: string
healthyNodes
O número de nós saudáveis.
Tipo: inteiro
unhealthyNodes
O número de nós não saudáveis.
Tipo: inteiro
**type**
O tipo de programador.
Tipo: string
## Exemplo
------
#### [ Python ]
**Solicitação**
```
$ describe_cluster(cluster_name_3x)
```
**Resposta 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"
}
```
------