DescribeTaskExecution - AWS DataSync
請求語法請求參數回應語法回應元素錯誤範例另請參閱

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

DescribeTaskExecution

傳回正在執行任務的相關詳細中繼資料。

請求語法

{
   "TaskExecutionArn": "string"
}

請求參數

如需有關所有動作共用之參數的資訊，請參閱一般參數。

請求接受採用 JSON 格式的下列資料。

TaskExecutionArn

正在執行任務的 Amazon Resource Name (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否則此數字小於。

類型：Long

BytesTransferred

傳輸所涉及的位元組總數。如需透過網路傳送的位元組總數，請參閱BytesCompressed。

類型：Long

BytesWritten

寫入目標AWS儲存資源的邏輯位元組數目。

類型：Long

EstimatedBytesToTransfer

要透過網路傳輸的估計實體位元組數。

類型：Long

EstimatedFilesToTransfer

要透過網路傳輸的預期檔案數目。這個值是在任務執行PREPARING階段之前的TRANSFERRING階段計算的。此值是要傳輸的預期檔案數目。它是根據比較來源位置和目標位置的內容，以及尋找需要傳輸的增量來計算。

類型：Long

Excludes

在傳輸期間排除特定資料的篩選規則清單。如需詳細資訊和範例，請參閱篩選傳輸的資料DataSync。

類型：FilterRule 物件陣列

陣列成員：項目數下限為 0。項目數上限為 1。

FilesTransferred

透過網路傳輸的實際檔案數目。在任務執行TRANSFERRING階段期間，會持續計算和更新此值。當從源讀取每個文件並通過網絡發送時，它會定期更新。

如果傳輸過程發生失敗，此值可能會小於 EstimatedFilesToTransfer。在某些情況下，此值也可以大於EstimatedFilesToTransfer。對於某些位置類型來說，此元素具實作特定性質，因此請勿將其做為正確檔案數的指標或是用來監控您的任務執行。

類型：Long

Includes

在傳輸期間包含特定資料的篩選規則清單。如需詳細資訊和範例，請參閱篩選傳輸的資料DataSync。

類型：FilterRule 物件陣列

陣列成員：項目數下限為 0。項目數上限為 1。

Options

設定您的AWS DataSync工作設定。這些選項包括如何DataSync處理檔案、物件及其關聯的中繼資料。您也可以指定如何DataSync驗證資料完整性、設定工作的頻寬限制以及其他選項。

每個任務設定都有預設值。除非您需要，否則Options在開始任務之前不必配置任何這些設置。

類型：Options 物件

Result

任務執行的結果。

類型：TaskExecutionResultDetail 物件

StartTime

工作執行的開始時間。

類型：Timestamp

Status

任務執行的狀態。

如需有關工作執行狀態的詳細資訊，請參閱瞭解工作狀態。

類型：字串

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

TaskExecutionArn

所描述之任務執行的 Amazon Resource Name (ARN)。 TaskExecutionArn是階層式TaskArn的，包含已執行的工作。

例如，具有 ARN 的TaskExecution值會使用 ARN arn: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

當在AWS 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"
}

另請參閱

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：