For AI agents: the complete documentation index is available at https://docs.ovhcloud.com/fr/llms.txt, the full documentation bundle is available at https://docs.ovhcloud.com/fr/llms-full.txt, and this page is available as Markdown at https://docs.ovhcloud.com/fr/guides/bare-metal-cloud/dedicated-servers/encryption-at-rest-api.md.
Aller au contenu

Gérer l'Encryption at Rest d'un serveur dédié avec l'API

Voir en Markdown

Découvrez comment vérifier l'éligibilité, activer ou désactiver l'Encryption at Rest et suivre l'opération sur un serveur dédié OVHcloud avec l'API OVHcloud v2

Objectif

L'API OVHcloud v2 vous permet d'automatiser l'Encryption at Rest sur vos serveurs dédiés. Ce guide vous explique comment vérifier qu'un serveur accepte l'Encryption at Rest, l'activer ou la désactiver, et suivre l'opération avec l'API OVHcloud.

Info

La clé de chiffrement reste à l'intérieur de chaque disque. OVHcloud gère la passphrase qui déverrouille les disques, et elle ne vous est jamais transmise. L'utilisation de vos propres clés n'est pas disponible. Pour plus d'informations, consultez le guide « Qu'est-ce que l'Encryption at Rest sur un serveur dédié ? »

Danger

L'activation et la désactivation de l'Encryption at Rest effacent l'une comme l'autre toutes les données du serveur. La désactivation efface cryptographiquement les disques : aucun déchiffrement sur place n'est possible. Dans les deux cas, le système d'exploitation doit être réinstallé ensuite. L'API ne demande aucune confirmation : la requête suffit à lancer l'opération. Sauvegardez vos données au préalable.

Prérequis

Introduction

Sur l'API v2, un serveur dédié est une ressource qui présente deux vues de sa configuration :

  • targetSpec correspond à l'état que vous demandez ;
  • currentState correspond à l'état réellement appliqué sur le serveur.

Vous modifiez la configuration en envoyant une nouvelle targetSpec accompagnée du checksum de la ressource. OVHcloud l'applique ensuite de manière asynchrone et indique la progression dans currentTasks et resourceStatus.

L'Encryption at Rest n'est pas disponible dans le provider Terraform OVHcloud.

En pratique

Cette section couvre les trois étapes de l'opération : vérifier, demander, suivre.

Étape 1 - Vérifier que le serveur accepte l'opération

Interrogez le serveur en demandant la disponibilité de ses actions :

ParamètreObligatoireDescriptionExemple
serviceNameOuiNom de service du serveur dédié.ns1234567.ip-203-0-113.eu
actionsNonRenseignez true pour obtenir currentState.actions.true

Sans actions=true, la réponse ne contient pas currentState.actions. Cette absence signifie que l'information n'a pas été demandée, et non que l'action est indisponible.

L'entrée ENABLE_ENCRYPTION_AT_REST de currentState.actions porte un status :

statusSignification
AVAILABLELe serveur accepte l'opération dès maintenant.
UNAVAILABLELe serveur refuse l'opération. blockedBy liste toutes les raisons.
UNDETERMINEDRien de connu ne bloque l'opération, mais une vérification n'a pas pu aboutir. Vous pouvez essayer.

Chaque raison de blockedBy comporte un code et une nature :

codenatureSignification
NOT_ELIGIBLEPERMANENTLe serveur ne propose pas l'Encryption at Rest.
EXCLUSIVE_OPERATION_RUNNINGTRANSIENTUne autre opération est en cours sur le serveur. details.operationId l'identifie. Réessayez une fois qu'elle est terminée.

Exemple d'extrait de réponse :

{
  "currentState": {
    "actions": [
      {
        "action": "ENABLE_ENCRYPTION_AT_REST",
        "status": "AVAILABLE",
        "blockedBy": null
      }
    ],
    "features": {
      "encryptionAtRest": {
        "enabled": false
      }
    }
  }
}

Notez le checksum renvoyé dans la même réponse : vous en aurez besoin à l'étape suivante.

Étape 2 - Activer ou désactiver l'Encryption at Rest

Envoyez l'état cible avec le checksum de votre dernière lecture. Deux méthodes sont disponibles :

  • PATCH ne modifie que les fonctionnalités que vous indiquez. Utilisez-la pour modifier uniquement l'Encryption at Rest.
  • PUT remplace toute la spécification cible : toutes les fonctionnalités doivent figurer dans le corps de la requête.

Avec PATCH, utilisez l'appel API et le corps suivants :

{
  "checksum": "<checksum from your last read>",
  "targetSpec": {
    "features": {
      "encryptionAtRest": {
        "enabled": true
      }
    }
  }
}

Avec PUT, utilisez l'appel API suivant :

Le corps a la même forme, avec toutes les fonctionnalités de targetSpec.features renseignées.

ParamètreObligatoireDescriptionExemple
serviceNameOuiNom de service du serveur dédié.ns1234567.ip-203-0-113.eu
checksum (corps)OuiChecksum renvoyé par votre dernière lecture du serveur."a1b2c3..."
targetSpec.features.encryptionAtRest.enabled (corps)Ouitrue pour activer, false pour désactiver.true

La réponse renvoie le serveur avec resourceStatus à UPDATING et l'opération listée dans currentTasks, avec le type ENCRYPTION_AT_REST_TARGET_SPEC_UPDATE.

Étape 3 - Suivre l'opération

Interrogez à nouveau le serveur avec la même requête GET, aussi souvent que nécessaire. L'opération peut prendre jusqu'à 24 heures de bout en bout, et davantage si une intervention en datacenter est nécessaire. Dans ce cas, vous recevez aussi les e-mails habituels d'ouverture et de clôture de l'intervention.

ChampCe qu'il indique
targetSpec.features.encryptionAtRest.enabledL'état que vous avez demandé.
currentState.features.encryptionAtRest.enabledL'état réellement appliqué sur les disques.
currentTasksL'opération en cours. Le champ est absent lorsqu'aucune opération n'est en cours.
resourceStatusUPDATING pendant l'opération, puis READY.

L'opération est terminée lorsque resourceStatus vaut READY et que currentState correspond à targetSpec. Lorsque l'opération réussit, le serveur redémarre en mode rescue et vous recevez l'e-mail habituel du mode rescue. Réinstallez ensuite le système d'exploitation (consultez le guide « Installer un OS via l'API OVHcloud sur un serveur dédié »).

En cas d'échec, currentState conserve sa valeur précédente, targetSpec conserve votre demande et aucune tâche ne reste en cours. Renvoyez la requête, avec le checksum de votre dernière lecture, pour réessayer.

Info

Le lien de tâche renvoyé dans currentTasks n'ouvre pas encore de vue détaillée de la tâche. Suivez l'opération en interrogeant le serveur.

Erreurs

Le tableau ci-dessous liste les erreurs que vous pouvez recevoir lors de la demande, et la marche à suivre pour chacune.

HTTPClasse d'erreurCauseQue faire
400Client::BadRequest::EncryptionAtRestNotEligibleLe serveur ne propose pas l'Encryption at Rest.Consultez les prérequis et limites.
400Client::BadRequest::EncryptionAtRestNotAvailableInRegionL'Encryption at Rest n'est pas disponible dans la région du serveur.Aucune action n'est possible sur ce serveur pour le moment.
400Client::BadRequest::ChecksumMissingLe corps ne contient pas de checksum.Interrogez à nouveau le serveur et envoyez son checksum.
400Client::BadRequest::TargetSpecEmptyLe corps du PATCH ne renseigne aucune fonctionnalité.Renseignez targetSpec.features.encryptionAtRest.
400Client::BadRequest::InvalidPayloadLe corps n'est pas valide.Vérifiez le corps à l'aide des exemples ci-dessus.
404Client::NotFound::DedicatedServerAucun serveur ne correspond à serviceName.Vérifiez le nom de service.
409Client::Conflict::ChecksumMismatchLe serveur a été modifié depuis votre dernière lecture.Interrogez-le à nouveau et envoyez le nouveau checksum.
409Client::Conflict::EncryptionAtRestAlreadyEnabledL'Encryption at Rest est déjà activée.Aucune action n'est nécessaire.
409Client::Conflict::EncryptionAtRestNotEnabledVous avez demandé la désactivation, mais l'Encryption at Rest n'est pas activée.Aucune action n'est nécessaire.
409Client::Conflict::EncryptionAtRestNetworkPrerequisiteNotMetLe serveur n'a pas d'adresse IP de démarrage, par exemple parce qu'OVHcloud Link Aggregation (OLA) est activé.Rétablissez la configuration réseau standard, puis réessayez.
409Client::Conflict::OperationAlreadyRunningUne autre opération est en cours sur le serveur.Attendez qu'elle se termine, puis réessayez.

Aller plus loin

Qu'est-ce que l'Encryption at Rest sur un serveur dédié ?

Prérequis et limites de l'Encryption at Rest

FAQ Encryption at Rest des serveurs dédiés

Échangez avec notre communauté d'utilisateurs.

Cette page vous a-t-elle aidé ?