ListRestoreJobSummaries - 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.

ListRestoreJobSummaries

Cette demande obtient un résumé des tâches de restauration créées ou en cours d’exécution au cours des 30 derniers jours. Vous pouvez inclure les paramètres AccountID, State,, ResourceType AggregationPeriod MaxResults, NextToken ou pour filtrer les résultats.

Cette demande renvoie un résumé contenant la région, le compte, l'état RestourceType, MessageCategory, StartTime, EndTime, et le nombre de tâches incluses.

Syntaxe de la demande

GET /audit/restore-job-summaries?AccountId=AccountId&AggregationPeriod=AggregationPeriod&MaxResults=MaxResults&NextToken=NextToken&ResourceType=ResourceType&State=State HTTP/1.1

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

AccountId

Renvoie le nombre de tâches pour le compte spécifié.

Si la demande est envoyée depuis un compte membre ou un compte ne faisant pas partie d' AWS Organizations, les offres d'emploi enregistrées dans le compte du demandeur seront renvoyées.

Les comptes root, administrateur et administrateur délégué peuvent utiliser la valeur ANY pour renvoyer le nombre de tâches de chaque compte de l’organisation.

AGGREGATE_ALL agrège le nombre de tâches provenant de tous les comptes de l’organisation authentifiée, puis renvoie la somme.

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

AggregationPeriod

Période pendant laquelle les résultats sont renvoyés.

  • ONE_DAY- Le nombre de tâches quotidiennes des 14 jours précédents.

  • SEVEN_DAYS- Le nombre de tâches agrégé pour les 7 jours précédents.

  • FOURTEEN_DAYS- Le nombre de tâches agrégé pour les 14 jours précédents.

Valeurs valides : ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS

MaxResults

Ce paramètre définit le nombre maximum d’éléments à renvoyer.

La valeur est un nombre entier. La plage de valeurs acceptées est comprise entre 1 et 500.

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

NextToken

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

ResourceType

Renvoie le nombre de tâches pour le type de ressource spécifié. Utilisez la demande GetSupportedResourceTypes pour obtenir des chaînes pour les types de ressources pris en charge.

La valeur ANY renvoie le nombre de tous les types de ressources.

AGGREGATE_ALL agrège le nombre de tâches pour tous les types de ressources et renvoie la somme.

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

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

State

Ce paramètre renvoie le nombre de tâches pour les tâches dans l’état spécifié.

La valeur ANY renvoie le nombre de tous les états.

AGGREGATE_ALL agrège le nombre de tâches pour tous les états et renvoie la somme.

Valeurs valides : CREATED | PENDING | RUNNING | ABORTED | COMPLETED | FAILED | AGGREGATE_ALL | ANY

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

{
   "AggregationPeriod": "string",
   "NextToken": "string",
   "RestoreJobSummaries": [ 
      { 
         "AccountId": "string",
         "Count": number,
         "EndTime": number,
         "Region": "string",
         "ResourceType": "string",
         "StartTime": number,
         "State": "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.

AggregationPeriod

Période pendant laquelle les résultats sont renvoyés.

  • ONE_DAY- Le nombre de tâches quotidiennes des 14 jours précédents.

  • SEVEN_DAYS- Le nombre de tâches agrégé pour les 7 jours précédents.

  • FOURTEEN_DAYS- Le nombre de tâches agrégé pour les 14 jours précédents.

Type : chaîne

NextToken

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

Type : chaîne

RestoreJobSummaries

Ce retour contient un résumé qui contient la région, le compte, l'état ResourceType, MessageCategory, StartTime, EndTime, et le nombre de tâches incluses.

Type : tableau d’objets RestoreJobSummary

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

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 AWS SDK spécifiques au langage, consultez les pages suivantes :