StartTaskExecution - AWS DataSync

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

StartTaskExecution

啟動任務的特定呼叫。一個TaskExecution值表示任務的個別執行。每個任務最多可有一個TaskExecution在一次。

TaskExecution具有以下轉換階段:初始化 | 準備 | 傳輸 | 驗證 | 成功/失敗。

如需詳細資訊,請參閱要素和術語中的 AWS DataSync使用者指南

請求語法

{ "Excludes": [ { "FilterType": "string", "Value": "string" } ], "Includes": [ { "FilterType": "string", "Value": "string" } ], "OverrideOptions": { "Atime": "string", "BytesPerSecond": number, "Gid": "string", "LogLevel": "string", "Mtime": "string", "OverwriteMode": "string", "PosixPermissions": "string", "PreserveDeletedFiles": "string", "PreserveDevices": "string", "SecurityDescriptorCopyFlags": "string", "TaskQueueing": "string", "TransferMode": "string", "Uid": "string", "VerifyMode": "string" }, "TaskArn": "string" }

請求參數

如需所有動作通用之參數的相關資訊,請參閱一般參數

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

Excludes

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

類型:陣列FilterRule對象

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

:必要 否

Includes

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

類型:陣列FilterRule對象

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

:必要 否

OverrideOptions

表示可用於控制行為的選項StartTaskExecutionoperation. 行為包括保留使用者 ID (UID)、群組 ID (GID) 和檔案許可等中繼資料,以及覆寫目的地中的檔案、資料完整性驗證等。

任務具有一組與其關聯的預設選項。如果您沒有在StartTaskExecution,則會使用預設值。您可以藉由將覆寫選項指定為覆寫Options值為StartTaskExecution

類型:Options 物件

:必要 否

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

已啟動之特定任務執行的 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}$

Errors

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

InternalException

當錯誤發生時,就會擲出此例外狀況AWS DataSync服務。

HTTP 狀態碼:500

InvalidRequestException

當用戶端提交格式錯誤的要求時,就會擲出此例外狀況。

HTTP 狀態碼:400

Examples

Example

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

請求範例

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

Example

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

回應範例

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

另請參閱

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