ListRestoreJobs - AWS Backup
Syntaxe de la demandeParamètres de demande URICorps 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.

ListRestoreJobs

Renvoie la liste des tâches AWS Backup initiées pour restaurer une ressource enregistrée, y compris les détails du processus de restauration.

Syntaxe de la demande

GET /restore-jobs/?accountId=ByAccountId&completeAfter=ByCompleteAfter&completeBefore=ByCompleteBefore&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&maxResults=MaxResults&nextToken=NextToken&resourceType=ByResourceType&restoreTestingPlanArn=ByRestoreTestingPlanArn&status=ByStatus HTTP/1.1

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

ByAccountId

L'ID du compte à partir duquel répertorier les tâches. Renvoie uniquement les tâches de restauration associées à l'ID de compte spécifié.

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

ByCompleteAfter

Renvoie uniquement les tâches de copie terminées après une date exprimée au format Unix et au format UTC (temps universel coordonné).

ByCompleteBefore

Renvoie uniquement les tâches de copie terminées avant une date exprimée au format Unix et au format UTC (temps universel coordonné).

ByCreatedAfter

Renvoie uniquement les tâches de restauration créées après la date spécifiée.

ByCreatedBefore

Renvoie uniquement les tâches de restauration créées avant la date spécifiée.

ByResourceType

Incluez ce paramètre pour renvoyer uniquement les tâches de restauration pour les ressources spécifiées :

  • Aurora pour Amazon Aurora

  • CloudFormationpour AWS CloudFormation

  • DocumentDB pour Amazon DocumentDB (compatible avec MongoDB)

  • DynamoDB pour Amazon DynamoDB

  • EBS pour Amazon Elastic Block Store

  • EC2 pour Amazon Elastic Compute Cloud

  • EFS pour Amazon Elastic File System

  • FSxpour Amazon FSx

  • Neptune pour Amazon Neptune

  • RDS pour Amazon Relational Database Service

  • Redshift pour Amazon Redshift

  • S3pour Amazon Simple Storage Service (Amazon S3)

  • SAP HANA on Amazon EC2pour les bases de données SAP HANA sur les instances Amazon Elastic Compute Cloud

  • Storage Gatewaypour AWS Storage Gateway

  • Timestream pour Amazon Timestream

  • VirtualMachinepour machines VMware virtuelles

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

ByRestoreTestingPlanArn

Cela renvoie uniquement les tâches de test de la restauration qui correspondent à l’Amazon Resource Name (ARN) des ressources spécifié.

ByStatus

Renvoie uniquement les tâches de restauration associées au statut de tâche spécifié.

Valeurs valides : PENDING | RUNNING | COMPLETED | ABORTED | FAILED

MaxResults

Le nombre maximum d'éléments à renvoyer.

Plage valide : valeur minimum de 1. La valeur maximale est 1 000.

NextToken

L'élément suivant selon une liste partielle des éléments renvoyés. Par exemple, si une demande est faite pour renvoyer MaxResults éléments, NextToken vous permet de renvoyer d'autres éléments dans votre liste en commençant par l'emplacement indiqué par le jeton suivant.

Corps de la requête

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

Syntaxe de la réponse

HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "RestoreJobs": [ 
      { 
         "AccountId": "string",
         "BackupSizeInBytes": number,
         "CompletionDate": number,
         "CreatedBy": { 
            "RestoreTestingPlanArn": "string"
         },
         "CreatedResourceArn": "string",
         "CreationDate": number,
         "DeletionStatus": "string",
         "DeletionStatusMessage": "string",
         "ExpectedCompletionTimeMinutes": number,
         "IamRoleArn": "string",
         "PercentDone": "string",
         "RecoveryPointArn": "string",
         "RecoveryPointCreationDate": number,
         "ResourceType": "string",
         "RestoreJobId": "string",
         "Status": "string",
         "StatusMessage": "string",
         "ValidationStatus": "string",
         "ValidationStatusMessage": "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 au format JSON par le service.

NextToken

L'élément suivant selon une liste partielle des éléments renvoyés. Par exemple, si une demande est faite pour renvoyer MaxResults éléments, NextToken vous permet de renvoyer d'autres éléments dans votre liste en commençant par l'emplacement indiqué par le jeton suivant.

Type : String

RestoreJobs

Tableau d'objets contenant des informations détaillées sur les tâches de restauration des ressources enregistrées.

Type : tableau d’objets RestoreJobsListMember

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.

Code d’état HTTP : 400

MissingParameterValueException

Indique qu'un paramètre obligatoire est manquant.

Code d’état HTTP : 400

ResourceNotFoundException

Aucune ressource requise pour l'action n'existe.

Code d’état HTTP : 400

ServiceUnavailableException

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

Code d’état HTTP : 500

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :