DescribeTaskExecution

Renvoie les métadonnées détaillées à propos d'une tâche qui est en cours d'exécution.

Syntaxe de la demande

{
   "TaskExecutionArn": "string"
}

Paramètres de demande

Pour plus d'informations sur les paramètres communs à toutes les actions, voirParamètres courants.

Cette demande accepte les données suivantes au format JSON.

TaskExecutionArn

Amazon Resource Name (ARN) de la tâche qui est en cours d'exécution.

Type : Chaîne

Contraintes de longueur : Longueur maximum de 128.

Modèle : ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$

Obligatoire Oui

Syntaxe de la réponse

{
   "BytesTransferred": number,
   "BytesWritten": number,
   "EstimatedBytesToTransfer": number,
   "EstimatedFilesToTransfer": number,
   "Excludes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "FilesTransferred": number,
   "Includes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "Options": { 
      "Atime": "string",
      "BytesPerSecond": number,
      "Gid": "string",
      "LogLevel": "string",
      "Mtime": "string",
      "ObjectTags": "string",
      "OverwriteMode": "string",
      "PosixPermissions": "string",
      "PreserveDeletedFiles": "string",
      "PreserveDevices": "string",
      "SecurityDescriptorCopyFlags": "string",
      "TaskQueueing": "string",
      "TransferMode": "string",
      "Uid": "string",
      "VerifyMode": "string"
   },
   "Result": { 
      "ErrorCode": "string",
      "ErrorDetail": "string",
      "PrepareDuration": number,
      "PrepareStatus": "string",
      "TotalDuration": number,
      "TransferDuration": number,
      "TransferStatus": "string",
      "VerifyDuration": number,
      "VerifyStatus": "string"
   },
   "StartTime": number,
   "Status": "string",
   "TaskExecutionArn": "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.

BytesTransferred

Le nombre physique d'octets qui sont transférés sur le réseau.

Type : Long

BytesWritten

Nombre d'octets logiques écrits sur la destinationAWSressource de stockage.

Type : Long

EstimatedBytesToTransfer

Le nombre physique estimé d'octets qui doivent être transférés sur le réseau.

Type : Long

EstimatedFilesToTransfer

Le nombre attendu de fichiers qui doivent être transférés sur le réseau. Cette valeur est calculée pendant la phase PREPARING, avant la phase TRANSFERT. Cette valeur correspond au nombre attendu de fichiers à transférer. Il est calculé en fonction de la comparaison du contenu des emplacements source et de destination et de la recherche du delta qui doit être transféré.

Type : Long

Excludes

Liste de règles de filtre qui détermine les fichiers à exclure d'une tâche. La liste doit contenir une seule chaîne de filtre composée des motifs à exclure. Les modèles sont délimités par « | » (une barre verticale), par exemple : "/folder1|/folder2"

Type : Array deFilterRuleobjets

Membres de tableau : Nombre minimal de 0 éléments. Nombre maximum de 1 élément.

FilesTransferred

Le nombre réel de fichiers qui ont été transférés sur le réseau. Cette valeur est calculée et mise à jour en permanence pendant la phase TRANSFERRING (TRANSFERT EN COURS). Elle est mise à jour régulièrement lors de chaque fichier est lu à partir de la source et envoyé sur le réseau.

Si une erreur survient au cours d'un transfert, cette valeur peut être inférieure à EstimatedFilesToTransfer. Cette valeur peut également être supérieure à EstimatedFilesTransferred dans certains cas. Cet élément est propre à l'implémentation pour certains types d'emplacement, afin de ne pas l'utiliser comme indicateur pour un nombre de fichiers correct ou pour surveiller l'exécution de votre tâche.

Type : Long

Includes

Liste de règles de filtre qui détermine les fichiers à inclure lors de l'exécution d'une tâche. La liste doit contenir une chaîne de filtre unique composée des modèles à inclure. Les modèles sont délimités par « | » (une barre verticale), par exemple : "/folder1|/folder2"

Type : Array deFilterRuleobjets

Membres de tableau : Nombre minimal de 0 éléments. Nombre maximum de 1 élément.

Options

Représente les options disponibles pour contrôler le comportement d'unStartTaskExecution. Le comportement inclut la conservation des métadonnées telles que l'ID utilisateur (UID), l'ID de groupe (GID) et les autorisations de fichiers, ainsi que le remplacement des fichiers dans la destination, la vérification de l'intégrité des données, etc.

Un ensemble d'options par défaut est associé à une tâche. Si vous ne spécifiez aucune option dansStartTaskExecution, la valeur par défaut est utilisée. Vous pouvez remplacer les options par défaut de chaque exécution de tâche en spécifiant un remplacementOptionsvaleur pourStartTaskExecution.

Type : objet Options

Result

Résultat de l'exécution de la tâche.

Type : objet TaskExecutionResultDetail

StartTime

Heure de début de l'exécution de la tâche.

Type : Horodatage

Status

État de l'exécution de la tâche.

Pour de plus amples informations sur les états d'une exécution de tâche, veuillez consulterComprendre les états des tâches.

Type : Chaîne

Valeurs valides : QUEUED | LAUNCHING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS | ERROR

TaskExecutionArn

Amazon Resource Name (ARN) de l'exécution de tâche qui a été décrite.TaskExecutionArnest hiérarchique et inclutTaskArnpour la tâche exécutée.

Par exemple, unTaskExecutionvaleur avec l'ARNarn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019bexécuté la tâche avec l'ARNarn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2.

Type : Chaîne

Contraintes de longueur : Longueur maximum de 128.

Modèle : ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$

Erreurs

Pour plus d'informations sur les erreurs communes à toutes les actions, voirErreurs courantes.

InternalException

Cette exception est renvoyée lors d'une erreur se produit dans leAWS DataSyncservice.

Code d'état HTTP : 500

InvalidRequestException

Cette exception est renvoyée lorsque le client envoie une demande mal formée.

Code d'état HTTP : 400

Exemples

Exemple

L'exemple suivant de la retourne les informations suivantes sur leTaskExecutionvaleur spécifiée dans l'exemple de demande.

Exemple de demande

{
  "TaskExecutionArn": "arn:aws:datasync:us-east-1:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f"
}

Exemple

Cet exemple illustre une utilisation de DescribeTaskExecution.

Exemple de réponse

{
   "BytesTransferred": "5000",
   "BytesWritten": "5000",
   "EstimatedBytesToTransfer": "5000",
   "EstimatedFilesToTransfer": "100",
   "FilesTransferred": "100",
   "Result": { 
      "ErrorCode": "??????",
      "ErrorDetail": "??????",
      "PrepareDuration": "100",
      "PrepareStatus": "SUCCESS",
      "TransferDuration": "60",
      "TransferStatus": "AVAILABLE",
      "VerifyDuration": "30",
      "VerifyStatus": "SUCCESS"
   },
   "StartTime": "1532660733.39",
   "Status": "SUCCESS",
   "OverrideOptions": { 
      "Atime": "BEST_EFFORT",
      "BytesPerSecond": "1000",
      "Gid": "NONE",
      "Mtime": "PRESERVE",
      "PosixPermissions": "PRESERVE",
      "PreserveDevices": "NONE",
      "PreserveDeletedFiles": "PRESERVE",
      "Uid": "NONE",
      "VerifyMode": "POINT_IN_TIME_CONSISTENT"
   },
   "TaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f"
}

Voir aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des kits SDK AWS spécifiques au langage, consultez les ressources suivantes :

• Interface de ligne de commande AWS

• AWS SDK pour .NET

• Kit AWS SDK pour C++

• Kit AWS SDK pour Go

• Kit SDK AWS pour Java V2

• Kit AWS SDK pour JavaScript

• AWS SDK pour PHP V3

• AWS SDK pour Python

• AWSSDK pour Ruby V3