

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.

# Mettre à jour le cluster
<a name="update-cluster"></a>

Mettez à jour le cluster.

**Topics**
+ [Syntaxe de demande](#update-cluster-request)
+ [Corps de la requête](#update-cluster-request-body)
+ [Syntaxe de réponse](#update-cluster-response)
+ [Corps de la réponse](#update-cluster-response-body)
+ [Exemple](#update-cluster-example)

## Syntaxe de demande
<a name="update-cluster-request"></a>

```
PUT /v3/clusters/{{{clusterName}}}
{
  "clusterConfiguration": "string",
  "dryrun": boolean,
  "forceUpdate": boolean,
  "region": "string",
  "suppressValidators": "string",
  "validationFailureLevel": "string"
}
```

## Corps de la requête
<a name="update-cluster-request-body"></a>

**Configuration du cluster**  
La configuration du cluster sous forme de document YAML.  
Obligatoire : oui

**Nom du cluster**  
Le nom du cluster.  
Type : chaîne  
Obligatoire : oui

**course à sec**  
Si ce paramètre est défini sur`true`, n'effectuez que la validation de la demande sans créer de ressource. Utilisez ce paramètre pour valider la configuration du cluster et les exigences de mise à jour. La valeur par défaut est `false`.  
Type : valeur booléenne  
Obligatoire : non

**Forcer la mise à jour**  
Si ce paramètre est défini sur`true`, ignorez les erreurs de validation de la mise à jour et forcez la mise à jour. La valeur par défaut est `false`.  
Type : valeur booléenne  
Obligatoire : non

**region**  
Celui dans Région AWS lequel se trouve le cluster.  
Type : chaîne  
Obligatoire : non

**Supprimer les validateurs**  
Identifie un ou plusieurs validateurs de configuration à supprimer.  
Type : chaîne  
Format : `(ALL|type:[A-Za-z0-9]+)`  
Obligatoire : non  
Exemples de valeurs valides :`currentValue`,`requestedValue`, `message`

**validation FailureLevel**  
Le niveau de validation minimum pour provoquer l'échec de la mise à jour.  
Type : chaîne  
Valeurs valides : `INFO | WARNING | ERROR`  
Obligatoire : non

## Syntaxe de réponse
<a name="update-cluster-response"></a>

```
{
  "cluster": {
    "clusterName": "string",
    "region": "string",
    "version": "string",
    "cloudformationStackArn": "string",
    "cloudformationStackStatus": "UPDATE_IN_PROGRESS",
    "clusterStatus": "UPDATE_IN_PROGRESS",
    "scheduler": {
      "type": "string",
      "metadata": {
        "name": "string",
        "version": "string"
      }
    }
  },
  "validationMessages": [
    {
      "id": "string",
      "type": "string",
      "level": "INFO",
      "message": "string"
    }
  ],
  "changeSet": [
    {
      "parameter": "string",
      "currentValue": "string",
      "requestedValue": "string"
    }
  ]
}
```

## Corps de la réponse
<a name="update-cluster-response-body"></a>

**Ensemble de modifications**  
Le changement défini pour la mise à jour du cluster.    
**Valeur actuelle**  
La valeur actuelle du paramètre à mettre à jour.  
Type : chaîne  
**paramètre**  
Paramètre à mettre à jour.  
Type : chaîne  
**Valeur demandée**  
La valeur demandée pour le paramètre à mettre à jour.  
Type : chaîne

**cluster**    
**formation des nuages StackArn**  
Le nom de ressource Amazon (ARN) de la CloudFormation pile principale.  
Type : chaîne  
**formation des nuages StackStatus**  
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`  
**Nom du cluster**  
Le nom 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`  
**region**  
L' Région AWS endroit dans lequel le cluster est créé.  
Type : chaîne  
**planificateur**    
**metadata**  
Les métadonnées du planificateur.    
**name**  
Le nom du planificateur.  
Type : chaîne  
**version**  
La version du planificateur.  
Type : chaîne  
**type**  
Type de planificateur.  
Type : chaîne

**version**  
AWS ParallelCluster version utilisée pour créer le cluster.  
Type : chaîne

**Messages de validation**  
Liste des messages dont le niveau de validation est inférieur à`validationFailureLevel`. La liste des messages est collectée lors de la validation de la configuration.    
**id**  
L'ID du validateur.  
Type : chaîne  
**level**  
Le niveau de validation.  
Type : chaîne  
Valeurs valides : `INFO | WARNING | ERROR`  
**message**  
Le message de validation.  
Type : chaîne  
**type**  
Type de validateur.  
Type : chaîne

## Exemple
<a name="update-cluster-example"></a>

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

**Demande**

```
$ update_cluster({{cluster_name_3x}}, {{path/config-file.yaml}})
```

**Réponse 200 **

```
{
  'change_set': [
    {
      'current_value': '10',
      'parameter': 'Scheduling.SlurmQueues[queue1].ComputeResources[t2micro].MaxCount',
      'requested_value': '15'
    }
  ],
  'cluster': {
    'cloudformation_stack_arn': 'arn:aws:cloudformation:us-east-1:123456789012:stack/test-api-cluster/e0462730-50b5-11ed-99a3-0a5ddc4a34c7',
    'cloudformation_stack_status': 'UPDATE_IN_PROGRESS',
    'cluster_name': 'cluster-3x',
    'cluster_status': 'UPDATE_IN_PROGRESS',
    'region': 'us-east-1',
    'scheduler': {
      'type': 'slurm'
    },
    'version': '3.2.1'
  }
}
```

------