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

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

CreateTask

設定工作，定義AWS DataSync傳輸資料的位置和方式。

工作包括來源位置、目的地位置，以及您要傳輸資料的方式和時機的偏好設定 (例如頻寬限制、排程以及其他選項)。

重要

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

請求語法

{
   "CloudWatchLogGroupArn": "string",
   "DestinationLocationArn": "string",
   "Excludes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "Includes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "Name": "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"
   },
   "Schedule": { 
      "ScheduleExpression": "string"
   },
   "SourceLocationArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

請求參數

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

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

CloudWatchLogGroupArn

用於監控和記錄任務事件之 Amazon CloudWatch 日誌群組的 Amazon Resource Name (ARN)。

如需有關如何搭配使用CloudWatch記錄檔的詳細資訊DataSync，請參閱使用AWS DataSync者指南中的監視您的工作。

如需這些群組的詳細資訊，請參閱《Amazon CloudWatch Logs 使用者指南》中的使用日誌群組和日誌串流。

類型：字串

長度限制：長度上限制：長度上限制：長度

模式：^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):logs:[a-z\-0-9]+:[0-9]{12}:log-group:([^:\*]*)(:\*)?$

必要：否

DestinationLocationArn

AWS 儲存資源位置的 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}:location/loc-[0-9a-z]{17}$

必要：是

Excludes

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

類型：FilterRule 物件陣列

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

必要：否

Includes

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

類型：FilterRule 物件陣列

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

必要：否

Name

任務的名稱。這個值是用來識別主控台中任務的文字參考。

類型：字串

長度限制：長度下限為 1。長度上限為 256。

模式：^[a-zA-Z0-9\s+=._:@/-]+$

必要：否

Options

指定任務的組態選項。某些選項包括保留檔案或物件中繼資料以及驗證資料完整性。

您也可以在任務的個別執行 (也稱為任務執行) 開始之前覆寫這些選項。如需詳細資訊，請參閱StartTaskExecution。

類型：Options 物件

必要：否

Schedule

指定用於定期將檔案從來源傳輸到目的地位置的排程。此排程應以 UTC 時間指定。如需詳細資訊，請參閱任務排程。

類型：TaskSchedule 物件

必要：否

SourceLocationArn

任務來源位置的 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}:location/loc-[0-9a-z]{17}$

必要：是

Tags

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

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

類型：TagListEntry 物件陣列

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

必要：否

回應語法

{
   "TaskArn": "string"
}

回應元素

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

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

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}$

錯誤

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

InternalException

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

HTTP 狀態碼：500

InvalidRequestException

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

HTTP 狀態碼：400

範例

請求範例

以下範例會使用來源和目標位置。

{
    "Options": {
        "Atime": "BEST_EFFORT",
        "Gid": "NONE",
        "Mtime": "PRESERVE",
        "PosixPermissions": "PRESERVE",
        "PreserveDevices": "NONE",
        "PreserveDeletedFiles": "PRESERVE",
        "Uid": "NONE",
        "VerifyMode": "POINT_IN_TIME_CONSISTENT"
    },
    "Schedule": {
        "ScheduleExpression": "0 12 ? * SUN,WED *"
    },
    "CloudWatchLogGroupArn": "arn:aws:logs:us-east-2:111222333444:log-group",
    "DestinationLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50fb",
    "Name": "MyTask",
    "SourceLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-0f01451b140b2af49",
    "Tags": [{
        "Key": "Name",
        "Value": "Task-1"
    }]
}

回應範例

以下回應會傳回任務的 Amazon Resource Name (ARN)。

{
  "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026"
}

另請參閱

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