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

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

StartTaskExecution

啟動AWS DataSync任務。對於每個任務，您一次只能運行一個任務執行。

任務執行有幾個階段。如需詳細資訊，請參閱任務執行狀態。

重要

如果您打算將資料傳輸到 Amazon S3 位置或從 Amazon S3 位置傳輸資料，請DataSync在開始之前查看 S3 請求費用和DataSync定價頁面的影響。

請求語法

{
   "Excludes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "Includes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "OverrideOptions": { 
      "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"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TaskArn": "string"
}

請求參數

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

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

Excludes

指定篩選規則清單，可決定要從任務中排除的檔案。清單包含單一篩選字串，其中包含要排除的模式。模式以 "|" (也就是管道) 分隔，例如 "/folder1|/folder2"。

類型：FilterRule 物件陣列

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

必要：否

Includes

指定篩選規則清單，可決定在執行任務時要包含的檔案。模式應該包含單一篩選字串，其中包含要包含的模式。模式以 "|" (也就是管道) 分隔，例如 "/folder1|/folder2"。

類型：FilterRule 物件陣列

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

必要：否

OverrideOptions

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

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

類型：Options 物件

必要：否

Tags

指定要您要對代表任務的 Amazon Resource Name (ARN) 套用的標籤。

標籤是有助於管理、篩選和搜尋 DataSync Resource Name 的鍵值對。

類型：TagListEntry 物件陣列

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

必要：否

TaskArn

指定要您要啟動的任務的 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}$

必要：是

回應語法

{
   "TaskExecutionArn": "string"
}

回應元素

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

TaskExecutionArn

正在執行的任務的 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}$

錯誤

如需所有動作常見的錯誤相關資訊，請參閱常見錯誤。

InternalException

當在AWS DataSync服務中發生錯誤時，拋出此異常。

HTTP 狀態碼：500

InvalidRequestException

當客戶端提交格式錯誤的請求時，拋出此異常。

HTTP 狀態碼：400

範例

請求範例

下列範例會使用指定工作的預設選項來啟動工作執行。

{
    "OverrideOptions": {
        "Atime": "BEST_EFFORT",
        "BytesPerSecond": 1000,
        "Gid": "NONE",
        "Mtime": "PRESERVE",
        "PosixPermissions": "PRESERVE",
        "PreserveDevices": "NONE",
        "PreserveDeletedFiles": "PRESERVE",
        "Uid": "NONE",
        "VerifyMode": "POINT_IN_TIME_CONSISTENT"
    },
    "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026"
}

回應範例

此範例說明的一種用法StartTaskExecution。

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

另請參閱

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