Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
# Décrire le cluster
Obtenez des informations détaillées sur un cluster existant.
**Topics**
+ [Syntaxe de demande](#describe-cluster-request)
+ [Corps de la demande](#describe-cluster-request-body)
+ [Syntaxe de réponse](#describe-cluster-response)
+ [Corps de la réponse](#describe-cluster-response-body)
+ [Exemple](#describe-cluster-example)
## Syntaxe de demande
```
GET /v3/clusters/{clusterName}
{
"region": "string"
}
```
## Corps de la demande
**Nom du cluster**
Nom du cluster.
Type : chaîne
Obligatoire : oui
**region**
Le dans Région AWS lequel se trouve le cluster.
Type : chaîne
Obligatoire : non
## Syntaxe de réponse
**Note**
`failureReason`est passé à la version 3.5.0 à `failures` partir de AWS ParallelCluster la version 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
}
}
```
## Corps de la réponse
**Nom du cluster**
Nom du cluster.
Type : chaîne
**cloudformationStackArn**
Le nom de ressource Amazon (ARN) de la CloudFormation pile principale.
Type : chaîne
**cloudformationStackStatus**
L'état de la CloudFormation pile.
Type : chaîne
Valeurs valides : `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`
**Configuration du cluster**
**url**
URL du fichier de configuration du cluster.
Type : chaîne
**État du cluster**
État du cluster.
Type : chaîne
Valeurs valides : `CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED`
**computeFleetStatus**
État du parc informatique.
Type : chaîne
Valeurs valides : `START_REQUESTED | STARTING | RUNNING | PROTECTED | STOP_REQUESTED | STOPPING | STOPPED | UNKNOWN | ENABLED | DISABLED`
**creationTime**
Horodatage de la création du cluster.
Type : datetime
**lastUpdatedTime**
Horodatage de la dernière mise à jour du cluster.
Type : datetime
**region**
L' Région AWS endroit dans lequel le cluster est créé.
Type : chaîne
**balises**
Liste des balises associées au cluster.
**clé**
Nom du tag.
Type : chaîne
**balise**
Valeur du tag.
Type : chaîne
**version**
AWS ParallelCluster Version utilisée pour créer le cluster.
Type : chaîne
**échecs**
La liste des défaillances lorsque la pile de clusters est en `CREATE_FAILED` état.
**Code d'échec**
Le code d'échec lorsque la pile de clusters est en `CREATE_FAILED` état.
Type : chaîne
**Raison de l'échec**
La raison de l'échec lorsque la pile de clusters est en `CREATE_FAILED` état.
Type : chaîne
**head\$1node**
Le nœud principal du cluster.
**instanceId**
L'ID de l' EC2 instance Amazon.
Type : chaîne
**instanceType**
Type d' EC2 instance Amazon.
Type : chaîne
**launchTime**
Heure à laquelle l' EC2 instance Amazon a été lancée.
Type : datetime
**privateIpAddress**
Adresse IP privée du cluster.
Type : chaîne
**publicIpAddress**
Adresse IP publique du cluster.
Type : chaîne
**state**
État de l'instance du nœud principal.
Type : chaîne
Valeurs valides : `pending | running | shutting-down | terminated | stopping | stopped`
**planificateur**
**métadonnées**
Les métadonnées du planificateur.
**name**
Nom du planificateur.
Type : chaîne
**version**
Version du planificateur.
Type : chaîne
**Nodes de connexion**
status
État du nœud de connexion.
Type : chaîne
Valeurs valides : `PENDING | FAILED | ACTIVE`
adresse
Adresse du nœud de connexion.
Type : chaîne
Nom du pool
Nom du pool de nœuds de connexion.
Type : chaîne
scheme
Le schéma du nœud de connexion.
Type : chaîne
Nœuds sains
Le nombre de nœuds sains.
Type : entier
Nœuds malsains
Le nombre de nœuds défectueux.
Type : entier
**type**
Type de planificateur.
Type : chaîne
## Exemple
------
#### [ Python ]
**Demande**
```
$ describe_cluster(cluster_name_3x)
```
**Réponse 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"
}
```
------