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.
ListBackupJobs
Renvoie la liste des tâches de sauvegarde existantes pour un compte authentifié au cours des 30 derniers jours. Envisagez d'utiliser ces outils de surveillance pendant une période plus longue.
Syntaxe de la requête
GET /backup-jobs/?accountId=ByAccountId
&backupVaultName=ByBackupVaultName
&completeAfter=ByCompleteAfter
&completeBefore=ByCompleteBefore
&createdAfter=ByCreatedAfter
&createdBefore=ByCreatedBefore
&maxResults=MaxResults
&messageCategory=ByMessageCategory
&nextToken=NextToken
&parentJobId=ByParentJobId
&resourceArn=ByResourceArn
&resourceType=ByResourceType
&state=ByState
HTTP/1.1
URIParamètres de demande
La demande utilise les URI paramètres suivants.
- ByAccountId
-
L'ID du compte à partir duquel répertorier les tâches. Renvoie uniquement les tâches de sauvegarde associées à l'ID de compte spécifié.
S'il est utilisé à partir d'un compte de AWS Organizations gestion, le transfert
*
renvoie tous les emplois de l'organisation.Modèle :
^[0-9]{12}$
- ByBackupVaultName
-
Renvoie uniquement les tâches de sauvegarde qui seront stockées dans le coffre-fort de sauvegarde spécifié. 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.
Modèle :
^[a-zA-Z0-9\-\_]{2,50}$
- ByCompleteAfter
-
Renvoie uniquement les tâches de sauvegarde terminées après une date exprimée au format Unix et en temps universel coordonné (UTC).
- ByCompleteBefore
-
Renvoie uniquement les tâches de sauvegarde terminées avant une date exprimée au format Unix et en temps universel coordonné (UTC).
- ByCreatedAfter
-
Renvoie uniquement les tâches de sauvegarde créées après la date spécifiée.
- ByCreatedBefore
-
Renvoie uniquement les tâches de sauvegarde créées avant la date spécifiée.
- ByMessageCategory
-
Il s'agit d'un paramètre facultatif qui peut être utilisé pour filtrer les tâches MessageCategory dont la valeur correspond à la valeur que vous avez saisie.
Les exemples de chaînes peuvent inclure
AccessDenied
,SUCCESS
,AGGREGATE_ALL
etInvalidParameters
.Consultez Surveillance
Le caractère générique () renvoie le nombre de toutes les catégories de messages.
AGGREGATE_ALL
agrège le nombre de tâches pour toutes les catégories de messages et renvoie la somme. - ByParentJobId
-
Il s'agit d'un filtre permettant de répertorier les tâches enfants (imbriquées) en fonction de l'ID de tâche parent.
- ByResourceArn
-
Renvoie uniquement les tâches de sauvegarde correspondant à la ressource spécifiée Amazon Resource Name (ARN).
- ByResourceType
-
Renvoie uniquement les tâches de sauvegarde pour les ressources spécifiées :
-
Aurora
pour Amazon Aurora -
CloudFormation
pour 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 -
FSx
pour Amazon FSx -
Neptune
pour Amazon Neptune -
RDS
pour Amazon Relational Database Service -
Redshift
pour Amazon Redshift -
S3
pour Amazon Simple Storage Service (Amazon S3) -
SAP HANA on Amazon EC2
pour les SAP HANA bases de données sur les instances Amazon Elastic Compute Cloud -
Storage Gateway
pour AWS Storage Gateway -
Timestream
pour Amazon Timestream -
VirtualMachine
pour machines VMware virtuelles
Modèle :
^[a-zA-Z0-9\-\_\.]{1,50}$
-
- ByState
-
Renvoie uniquement les tâches de sauvegarde qui sont dans l'état spécifié.
Completed with issues
est un statut présent uniquement dans la console AWS Backup . En API effet, ce statut fait référence aux tâches dont l'étatCOMPLETED
et la valeur sont différentes deSUCCESS
; c'est-à-dire que le statut est terminé mais qu'il est accompagné d'un message d'état.MessageCategory
Pour obtenir le nombre de tâches pour
Completed with issues
, exécutez deux GET requêtes et soustrayez le second, le plus petit nombre :GET/tâches de sauvegarde/ ? État = COMPLETED
GET/tâches de sauvegarde/ ? messageCategory= SUCCESS &état= COMPLETED
Valeurs valides :
CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL
- 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
{
"BackupJobs": [
{
"AccountId": "string",
"BackupJobId": "string",
"BackupOptions": {
"string" : "string"
},
"BackupSizeInBytes": number,
"BackupType": "string",
"BackupVaultArn": "string",
"BackupVaultName": "string",
"BytesTransferred": number,
"CompletionDate": number,
"CreatedBy": {
"BackupPlanArn": "string",
"BackupPlanId": "string",
"BackupPlanVersion": "string",
"BackupRuleId": "string"
},
"CreationDate": number,
"ExpectedCompletionDate": number,
"IamRoleArn": "string",
"InitiationDate": number,
"IsParent": boolean,
"MessageCategory": "string",
"ParentJobId": "string",
"PercentDone": "string",
"RecoveryPointArn": "string",
"ResourceArn": "string",
"ResourceName": "string",
"ResourceType": "string",
"StartBy": number,
"State": "string",
"StatusMessage": "string"
}
],
"NextToken": "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.
- BackupJobs
-
Tableau de structures contenant des métadonnées relatives à vos tâches de sauvegarde renvoyées sous JSON format.
Type : tableau d’objets BackupJob
- 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
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
- 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 :