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.
Renvoie les métadonnées relatives à vos tâches de copie.
Syntaxe de la demande
GET /copy-jobs/?accountId=ByAccountId&completeAfter=ByCompleteAfter&completeBefore=ByCompleteBefore&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&destinationVaultArn=ByDestinationVaultArn&maxResults=MaxResults&messageCategory=ByMessageCategory&nextToken=NextToken&parentJobId=ByParentJobId&resourceArn=ByResourceArn&resourceType=ByResourceType&state=ByState 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 copie 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 copie créées après la date spécifiée.
- ByCreatedBefore
-
Renvoie uniquement les tâches de copie créées avant la date spécifiée.
- ByDestinationVaultArn
-
Un Amazon Resource Name (ARN) qui identifie de façon unique un coffre-fort de sauvegarde source à partir duquel copier ; par exemple,
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault. - 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_ALLetINVALIDPARAMETERS.Consultez Surveillance pour obtenir la liste des chaînes acceptées.
La valeur ANY renvoie le nombre de toutes les catégories de messages.
AGGREGATE_ALLagrè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 copie qui correspondent à l'Amazon Resource Name (ARN) des ressources spécifié.
- ByResourceType
-
Renvoie uniquement les tâches de sauvegarde pour les ressources spécifiées :
-
Aurorapour Amazon Aurora -
CloudFormationpour AWS CloudFormation -
DocumentDBpour Amazon DocumentDB (compatible avec MongoDB) -
DynamoDBpour Amazon DynamoDB -
EBSpour Amazon Elastic Block Store -
EC2pour Amazon Elastic Compute Cloud -
EFSpour Amazon Elastic File System -
FSxpour Amazon FSx -
Neptunepour Amazon Neptune -
RDSpour Amazon Relational Database Service -
Redshiftpour 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 -
Timestreampour Amazon Timestream -
VirtualMachinepour les machines VMware virtuelles
Modèle :
^[a-zA-Z0-9\-\_\.]{1,50}$ -
- ByState
-
Renvoie uniquement les tâches de copie qui sont dans l'état spécifié.
Valeurs valides :
CREATED | RUNNING | COMPLETED | FAILED | 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 un MaxResults certain nombre d'articles, cela vous NextToken permet de renvoyer d'autres articles 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
{
"CopyJobs": [
{
"AccountId": "string",
"BackupSizeInBytes": number,
"ChildJobsInState": {
"string" : number
},
"CompletionDate": number,
"CompositeMemberIdentifier": "string",
"CopyJobId": "string",
"CreatedBy": {
"BackupPlanArn": "string",
"BackupPlanId": "string",
"BackupPlanVersion": "string",
"BackupRuleId": "string"
},
"CreationDate": number,
"DestinationBackupVaultArn": "string",
"DestinationRecoveryPointArn": "string",
"IamRoleArn": "string",
"IsParent": boolean,
"MessageCategory": "string",
"NumberOfChildJobs": number,
"ParentJobId": "string",
"ResourceArn": "string",
"ResourceName": "string",
"ResourceType": "string",
"SourceBackupVaultArn": "string",
"SourceRecoveryPointArn": "string",
"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 au format JSON par le service.
- CopyJobs
-
Tableau de structures contenant des métadonnées relatives à vos tâches de copie renvoyées au format JSON.
Type : tableau d’objets CopyJob
- NextToken
-
L'élément suivant selon une liste partielle des éléments renvoyés. Par exemple, si une demande est faite pour renvoyer un MaxResults certain nombre d'articles, cela vous NextToken permet de renvoyer d'autres articles 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.
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 :
