DescribeBackupJob - AWS Backup
Syntaxe de la requêteURIParamètres de demandeCorps de la demandeSyntaxe 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.

DescribeBackupJob

Renvoie les détails de la tâche de sauvegarde pour l'BackupJobId spécifié.

Syntaxe de la requête

GET /backup-jobs/backupJobId HTTP/1.1

URIParamètres de demande

La demande utilise les URI paramètres suivants.

backupJobId

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

Obligatoire : oui

Corps de la demande

La demande n’a pas de corps de requête.

Syntaxe de la réponse

HTTP/1.1 200
Content-type: application/json

{
   "AccountId": "string",
   "BackupJobId": "string",
   "BackupOptions": { 
      "string" : "string" 
   },
   "BackupSizeInBytes": number,
   "BackupType": "string",
   "BackupVaultArn": "string",
   "BackupVaultName": "string",
   "BytesTransferred": number,
   "ChildJobsInState": { 
      "string" : number 
   },
   "CompletionDate": number,
   "CreatedBy": { 
      "BackupPlanArn": "string",
      "BackupPlanId": "string",
      "BackupPlanVersion": "string",
      "BackupRuleId": "string"
   },
   "CreationDate": number,
   "ExpectedCompletionDate": number,
   "IamRoleArn": "string",
   "InitiationDate": number,
   "IsParent": boolean,
   "MessageCategory": "string",
   "NumberOfChildJobs": number,
   "ParentJobId": "string",
   "PercentDone": "string",
   "RecoveryPointArn": "string",
   "ResourceArn": "string",
   "ResourceName": "string",
   "ResourceType": "string",
   "StartBy": number,
   "State": "string",
   "StatusMessage": "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.

AccountId

Renvoie l'ID de compte du propriétaire de la tâche de sauvegarde.

Type : chaîne

Modèle : ^[0-9]{12}$

BackupJobId

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

Type : chaîne

BackupOptions

Représente les options spécifiées dans le cadre du plan de sauvegarde ou de la tâche de sauvegarde à la demande.

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}$

BackupSizeInBytes

Taille d'une sauvegarde, en octets.

Type : long

BackupType

Représente le type de sauvegarde réel sélectionné pour une tâche de sauvegarde. Par exemple, si une sauvegarde Windows Volume Shadow Copy Service (VSS) a été effectuée avec succès, BackupType renvoie"WindowsVSS". Si BackupType est vide, le type de sauvegarde était une sauvegarde normale.

Type : chaîne

BackupVaultArn

Nom de ressource Amazon (ARN) qui identifie de manière unique un coffre-fort de sauvegarde ; par exemple,arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

Type : chaîne

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}$

BytesTransferred

Taille en octets transférée vers un coffre-fort de sauvegarde au moment où le statut de la tâche a été demandé.

Type : long

ChildJobsInState

Cela renvoie les statistiques des tâches de sauvegarde enfant (imbriquées) incluses.

Type : mappage chaîne/long

Clés valides : CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL

CompletionDate

Date et heure auxquelles une tâche de création d'une tâche de sauvegarde est terminée, au format Unix et en temps universel coordonné (UTC). La valeur de CompletionDate 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

CreatedBy

Contient des informations d'identification relatives à la création d'une tâche de sauvegarde, dont BackupPlanArn, BackupPlanId, BackupPlanVersion et BackupRuleId du plan de sauvegarde utilisé pour la créer.

Type : objet RecoveryPointCreator

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

ExpectedCompletionDate

Date et heure auxquelles une tâche de sauvegarde des ressources devrait être terminée, au format Unix et en temps universel coordonné (UTC). La valeur de ExpectedCompletionDate 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

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 : chaîne

InitiationDate

Date à laquelle une tâche de sauvegarde a été initiée.

Type : Timestamp

IsParent

Cela renvoie la valeur booléenne indiquant qu'une tâche de sauvegarde est une tâche parent (composite).

Type : booléen

MessageCategory

Nombre de tâches pour la catégorie de message spécifiée.

Les exemples de chaînes peuvent inclure AccessDenied, SUCCESS, AGGREGATE_ALL et INVALIDPARAMETERS. Consultez la section Surveillance pour obtenir la liste des MessageCategory chaînes acceptées.

Type : chaîne

NumberOfChildJobs

Cela renvoie le nombre de tâches de sauvegarde enfant (imbriquées).

Type : long

ParentJobId

Cela renvoie l'ID de la tâche de sauvegarde de la ressource parent (composite).

Type : chaîne

PercentDone

Contient une estimation du pourcentage d'achèvement d'une tâche au moment où le statut de la tâche a été demandé.

Type : chaîne

RecoveryPointArn

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 : chaîne

ResourceArn

Et ARN qui identifie de manière unique une ressource enregistrée. Le format du ARN dépend du type de ressource.

Type : chaîne

ResourceName

Nom non unique de la ressource appartenant à la sauvegarde spécifiée.

Type : chaîne

ResourceType

Type de AWS ressource à sauvegarder ; par exemple, un volume Amazon Elastic Block Store (AmazonEBS) ou une base de données Amazon Relational Database Service (RDSAmazon).

Type : chaîne

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

StartBy

Spécifie l'heure au format Unix et en temps universel coordonné (UTC) à laquelle une tâche de sauvegarde doit être démarrée avant d'être annulée. La valeur est calculée en ajoutant la fenêtre de démarrage à l'heure planifiée. Ainsi, si l'heure prévue était 18 h 00 et que la fenêtre de début était de 2 heures, l'heure StartBy serait 20 h 00 à la date spécifiée. La valeur de StartBy 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

State

L'état actuel d'une tâche de sauvegarde.

Type : chaîne

Valeurs valides : CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL

StatusMessage

Message détaillé expliquant le statut de la tâche de sauvegarde d'une ressource.

Type : chaîne

Erreurs

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

DependencyFailureException

Un AWS service ou une ressource dépendant a renvoyé une erreur au AWS Backup service et l'action ne peut pas être terminée.

HTTPCode de statut : 500

InvalidParameterValueException

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

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 :