DescribeTaskExecution - Amazon DataSync
请求语法请求参数响应语法响应元素错误示例另请参阅
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

DescribeTaskExecution

返回有关正在执行的任务的详细元数据。

请求语法

{
   "TaskExecutionArn": "string"
}

请求参数

有关所有操作的通用参数的信息，请参阅通用参数。

请求接受采用 JSON 格式的以下数据。

TaskExecutionArn

正在任务的 Amazon 资源名称（ARN）。

类型：字符串

长度约束：最大长度为 128。

模式：^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}$

必需：是

响应语法

{
   "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"
}

响应元素

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回的以下数据。

BytesCompressed

应用压缩后通过网络传输的物理字节数。在大多数情况下，BytesTransferred除非数据不可压缩，否则此数字会小于。

类型：长整型

BytesTransferred

传输中涉及的总字节数。有关通过网络发送的字节数，请参阅BytesCompressed。

类型：长整型

BytesWritten

写入目标Amazon存储资源的逻辑字节数。

类型：长整型

EstimatedBytesToTransfer

要通过网络传输的估计物理字节数。

类型：长整型

EstimatedFilesToTransfer

通过网络传输的预期文件数。该值是在任务执行PREPARING阶段之前的TRANSFERRING阶段计算的。此值是预期要传输的文件数。它是通过比较源位置和目的地位置的内容并找到需要传输的增量来计算的。

类型：长整型

Excludes

在传输过程中排除特定数据的筛选规则列表。有关更多信息和示例，请参阅筛选数据 DataSync。

类型：FilterRule 对象数组

数组成员：最少 0 项。最多 1 项。

FilesTransferred

通过网络传输的实际文件数。该值是在任务执行TRANSFERRING阶段持续计算和更新的。当从源代码读取每个文件并通过网络发送时，它会定期更新。

如果传输期间发生故障，该值可能小于 EstimatedFilesToTransfer。在某些情况下，此值也可以大于EstimatedFilesToTransfer。此元素是特定于某些位置类型的实施，因此不要将其用作正确文件编号的指示符或监控任务执行。

类型：长整型

Includes

在传输期间包含特定数据的筛选规则列表。有关更多信息和示例，请参阅筛选数据 DataSync。

类型：FilterRule 对象数组

数组成员：最少 0 项。最多 1 项。

Options

配置您的Amazon DataSync任务设置。这些选项包括如何 DataSync 处理文件、对象及其关联的元数据。您还可以指定如何 DataSync 验证数据完整性、为任务设置带宽限制以及其他选项。

每个任务设置的状态。除非需要，否则Options在开始任务之前不必对其进行任何配置。

类型：Options 对象

Result

任务的状态。

类型：TaskExecutionResultDetail 对象

StartTime

开始执行任务的时间。

类型：时间戳

Status

任务的状态。

有关任务执行状态的详细信息，请参阅了解任务状态。

类型：字符串

有效值: QUEUED | LAUNCHING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS | ERROR

TaskExecutionArn

所描述的任务名称（ARN）。 TaskExecutionArn是分层TaskArn的，包括已执行的任务。

例如，具有 ARN 的TaskExecution值使用 ARNarn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b 执行任务arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2。

类型：字符串

长度约束：最大长度为 128。

模式：^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}$

错误

有关所有操作常见错误的信息，请参阅常见错误。

InternalException

当Amazon DataSync服务中发生错误时，会抛出此异常。

HTTP 状态代码：500

InvalidRequestException

当客户端提交格式错误的请求时，会引发此异常。

HTTP 状态代码：400

示例

示例请求

此示例说明了一个DescribeTaskExecution请求。

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

示例响应

此示例说明了DescribeTaskExecution响应。

{
   "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"
}

另请参阅

有关在特定语言的 Amazon 软件开发工具包中使用此 API 的更多信息，请参阅以下内容：