StartBackupJob - AWS Backup
Syntaxe de la requêteURIParamètres de demandeCorps de la requêteSyntaxe de la réponseEléments de réponseErreursconsultez aussi

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.

StartBackupJob

Démarre une tâche de sauvegarde à la demande pour la ressource spécifiée.

Syntaxe de la requête

PUT /backup-jobs HTTP/1.1
Content-type: application/json

{
   "BackupOptions": { 
      "string" : "string" 
   },
   "BackupVaultName": "string",
   "CompleteWindowMinutes": number,
   "IamRoleArn": "string",
   "IdempotencyToken": "string",
   "Lifecycle": { 
      "DeleteAfterDays": number,
      "MoveToColdStorageAfterDays": number,
      "OptInToArchiveForSupportedResources": boolean
   },
   "RecoveryPointTags": { 
      "string" : "string" 
   },
   "ResourceArn": "string",
   "StartWindowMinutes": number
}

URIParamètres de demande

La demande n'utilise aucun URI paramètre.

Corps de la requête

La demande accepte les données suivantes au JSON format suivant.

BackupOptions

L'option de sauvegarde pour une ressource sélectionnée. Cette option est uniquement disponible pour les tâches de sauvegarde Windows Volume Shadow Copy Service (VSS).

Valeurs valides : définissez ce paramètre "WindowsVSS":"enabled" sur pour activer l'option de WindowsVSS sauvegarde et créer une VSS sauvegarde Windows. Définissez sur "WindowsVSS""disabled" pour créer une sauvegarde régulière. L'option WindowsVSS n'est pas activée par défaut.

Type : mappage chaîne/chaîne

Modèle de clé :^[a-zA-Z0-9\-\_\.]{1,50}$

Modèle de valeur : ^[a-zA-Z0-9\-\_\.]{1,50}$

Obligatoire : non

BackupVaultName

Le nom d'un conteneur logique où les sauvegardes sont stockées. Les coffres-forts de sauvegarde sont identifiés par des noms spécifiques pour le compte utilisé pour les créer et la région AWS dans laquelle ils sont créés.

Type : chaîne

Modèle : ^[a-zA-Z0-9\-\_]{2,50}$

Obligatoire : oui

CompleteWindowMinutes

Valeur en minutes pendant laquelle une sauvegarde démarrée avec succès doit se terminer, faute de quoi AWS Backup annule la tâche. Cette valeur est facultative. Cette valeur commence le compte à rebours à partir du moment auquel la sauvegarde a été planifiée. Cela n'ajoute pas de temps supplémentaire pour StartWindowMinutes, ni si la sauvegarde a démarré plus tard que prévu.

Comme StartWindowMinutes, ce paramètre a une valeur maximale de 100 ans (52 560 000 minutes).

Type : long

Obligatoire : non

IamRoleArn

Spécifie le IAM rôle ARN utilisé pour créer le point de récupération cible ; par exemple,arn:aws:iam::123456789012:role/S3Access.

Type : String

Obligatoire : oui

IdempotencyToken

Chaîne choisie par le client que vous pouvez utiliser pour faire la distinction entre des appels par ailleurs identiques à StartBackupJob. Toute nouvelle tentative d'une demande réussie avec le même jeton d'idempotence entraîne un message de réussite sans qu'aucune action ne soit entreprise.

Type : chaîne

Obligatoire : non

Lifecycle

Le cycle de vie définit le moment où une ressource protégée est transférée vers le stockage à froid et sa date d'expiration. AWS Backup fera automatiquement la transition et expirera les sauvegardes en fonction du cycle de vie que vous définissez.

Les sauvegardes transférées vers un stockage à froid doivent être stockées dans le stockage à froid pendant au moins 90 jours. Par conséquent, le paramètre « rétention » doit être supérieur de 90 jours au paramètre « nombre de jours avant transfert vers stockage à froid ». Le paramètre « transition to cold after days (nombre de jours avant transfert vers stockage à froid) » ne peut pas être modifié après le transfert d'une sauvegarde vers un stockage à froid.

Les types de ressources pouvant passer au stockage à froid sont répertoriés dans le tableau Disponibilité des fonctionnalités par ressource. AWS Backup ignore cette expression pour les autres types de ressources.

Ce paramètre a une valeur maximale de 100 ans (36 500 jours).

Type : objet Lifecycle

Obligatoire : non

RecoveryPointTags

Les balises à attribuer aux ressources.

Type : mappage chaîne/chaîne

Obligatoire : non

ResourceArn

Nom de ressource Amazon (ARN) qui identifie une ressource de manière unique. Le format du ARN dépend du type de ressource.

Type : String

Obligatoire : oui

StartWindowMinutes

Valeur en minutes après la planification d'une sauvegarde avant qu'une tâche soit annulée si elle ne démarre pas correctement. Cette valeur est facultative et elle est de 8 heures par défaut. Si cette valeur est incluse, elle doit être d'au moins 60 minutes pour éviter les erreurs.

Ce paramètre a une valeur maximale de 100 ans (52 560 000 minutes).

Pendant la fenêtre de démarrage, le statut de la tâche de sauvegarde reste CREATED jusqu'à ce qu'elle ait démarré ou jusqu'à ce que le délai de la fenêtre de démarrage soit écoulé. Si, dans la fenêtre de démarrage, time AWS Backup reçoit une erreur autorisant une nouvelle tentative de la tâche, elle AWS Backup réessaiera automatiquement de recommencer la tâche au moins toutes les 10 minutes jusqu'à ce que la sauvegarde commence avec succès (le statut de la tâche passe àRUNNING) ou jusqu'à ce que le statut de la tâche passe à EXPIRED (ce qui devrait se produire une fois la fenêtre de démarrage terminée).

Type : long

Obligatoire : non

Syntaxe de la réponse

HTTP/1.1 200
Content-type: application/json

{
   "BackupJobId": "string",
   "CreationDate": number,
   "IsParent": boolean,
   "RecoveryPointArn": "string"
}

Eléments de réponse

Si l'action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées sous JSON forme formatée par le service.

BackupJobId

Identifie de manière unique une demande AWS Backup de sauvegarde d'une ressource.

Type : String

CreationDate

Date et heure de création d'une tâche de sauvegarde, au format Unix et en temps universel coordonné (UTC). La valeur de CreationDate est précise en millisecondes. Par exemple, la valeur 1516925490,087 représente le vendredi 26 janvier 2018 à 00 h 11 m 30,087 s.

Type : Timestamp

IsParent

Il s'agit d'une valeur booléenne renvoyée indiquant qu'il s'agit d'une tâche de sauvegarde parent (composite).

Type : booléen

RecoveryPointArn

Remarque : Ce champ n'est renvoyé que pour les ressources Amazon EFS et Advanced DynamoDB.

Et ARN qui identifie de manière unique un point de récupération ; par exemple,arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Type : String

Erreurs

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.

InvalidParameterValueException

Indique une erreur avec la valeur d'un paramètre. Par exemple, la valeur est hors de portée.

HTTPCode de statut : 400

InvalidRequestException

Indique une erreur dans la saisie de la demande. Par exemple, un paramètre n'est pas du bon type.

HTTPCode de statut : 400

LimitExceededException

Une limite de la demande a été dépassée ; par exemple, le nombre maximum d'éléments autorisés dans une demande.

HTTPCode de statut : 400

MissingParameterValueException

Indique qu'un paramètre obligatoire est manquant.

HTTPCode de statut : 400

ResourceNotFoundException

Aucune ressource requise pour l'action n'existe.

HTTPCode de statut : 400

ServiceUnavailableException

La demande a échoué en raison d'une défaillance temporaire du serveur.

HTTPCode de statut : 500

consultez aussi

Pour plus d'informations sur son utilisation API dans l'une des langues spécifiques AWS SDKs, consultez ce qui suit :