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

ListCopyJobs

Renvoie les métadonnées relatives à vos tâches de copie.

Syntaxe de la requête

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

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 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 en temps universel coordonné (UTC).

ByCompleteBefore

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

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

Nom de ressource Amazon (ARN) qui identifie de manière unique un coffre-fort de sauvegarde source à partir duquel effectuer une copie ; 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_ALL et INVALIDPARAMETERS.

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_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 copie qui correspondent à 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

  • 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 SAP HANA bases de données sur les instances Amazon Elastic Compute Cloud

  • Storage Gatewaypour AWS Storage Gateway

  • Timestream pour 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 sous JSON forme formatée par le service.

CopyJobs

Tableau de structures contenant des métadonnées relatives à vos tâches de copie renvoyées sous JSON format.

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.

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 :