DescribeTaskExecution

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

Syntaxe de la requête

{
   "TaskExecutionArn": "string"
}

Paramètres de demande

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

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

TaskExecutionArn

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

Type : String

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

{
   "BytesCompressed": number,
   "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.

BytesCompressed

Le nombre physique d'octets transférés sur le réseau après l'application de la compression. Dans la plupart des cas, ce nombre est inférieur à BytesTransferred sauf si les données ne sont pas compressibles.

Type : long

BytesTransferred

Nombre total d'octets impliqués dans le transfert. Pour le nombre d'octets envoyés sur le réseau, reportez-vous à la sectionBytesCompressed.

Type : long

BytesWritten

Nombre d'octets logiques écrits dans la ressource de AWS stockage de destination.

Type : long

EstimatedBytesToTransfer

Nombre physique estimé d'octets à transférer sur le réseau.

Type : long

EstimatedFilesToTransfer

Le nombre prévu de fichiers à transférer sur le réseau. Cette valeur est calculée pendant la PREPARING phase précédant la TRANSFERRING phase d'exécution de la tâche. Cette valeur est le nombre prévu de fichiers à transférer. Il est calculé en comparant le contenu des emplacements source et de destination et en trouvant le delta qui doit être transféré.

Type : long

Excludes

Liste de règles de filtre qui excluent des données spécifiques lors de votre transfert. Pour plus d'informations et des exemples, consultez Filtrage des données transférées par DataSync.

Type : tableau d’objets FilterRule

Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 1 élément.

FilesTransferred

Le nombre réel de fichiers transférés sur le réseau. Cette valeur est calculée et mise à jour en permanence pendant la TRANSFERRING phase d'exécution de la tâche. Il est mis à jour régulièrement lorsque chaque fichier est lu depuis la source et envoyé via le réseau.

Si une erreur survient au cours d'un transfert, cette valeur peut être inférieure à EstimatedFilesToTransfer. Dans certains cas, cette valeur peut également être supérieure àEstimatedFilesToTransfer. 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 incluent des données spécifiques lors de votre transfert. Pour plus d'informations et des exemples, consultez Filtrage des données transférées par DataSync.

Type : tableau d’objets FilterRule

Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 1 élément.

Options

Configure les paramètres de vos AWS DataSync tâches. Ces options incluent la façon DataSync dont sont gérés les fichiers, les objets et leurs métadonnées associées. Vous pouvez également spécifier comment DataSync vérifier l'intégrité des données, définir des limites de bande passante pour votre tâche, entre autres options.

Chaque paramètre de tâche dispose d'une valeur par défaut. À moins que vous n'en ayez besoin, vous n'avez pas à les configurer Options avant de commencer votre tâche.

Type : objet Options

Result

L'état d'exécution de la tâche.

Type : objet TaskExecutionResultDetail

StartTime

Heure à laquelle l'exécution de la tâche a commencé.

Type : Timestamp

Status

L'état d'exécution de la tâche.

Pour des informations détaillées sur les statuts d'exécution des tâches, voir Comprendre les statuts des tâches.

Type : String

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

TaskExecutionArn

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

Par exemple, une TaskExecution valeur avec l'ARN a arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b exécuté la tâche avec l'ARNarn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2.

Type : String

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, reportez-vous à la sectionErreurs courantes.

InternalException

Cette exception est levée lorsqu'une erreur se produit dans le AWS DataSync service.

Code d'état HTTP : 500

InvalidRequestException

Cette exception est levée lorsque le client soumet une demande mal formée.

Code d'état HTTP : 400

Exemples

Exemple de demande

Cet exemple illustre une DescribeTaskExecution demande.

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

Exemple de réponse

Cet exemple illustre une DescribeTaskExecution réponse.

{
   "BytesCompressed": "3500",
   "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

• AWSSDK pour JavaScript

• AWS SDK pour PHP V3

• AWS SDK pour Python

• Kit SDK AWS pour Ruby V3