CreateTask - Amazon DataSync
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

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

CreateTask

配置任务,该任务定义Amazon 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 资源名称(ARN)。

有关如何使用 CloudWatch Logs 的更多信息 DataSync,请参阅《Amazon DataSync用户指南》中的 “监控您的任务”。

有关这些日志组的更多信息,请参阅 Amazon Logs 用户指南中的使用 CloudWatch 日志组和日志流

类型:字符串

长度约束:最大长度为 562。

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

必需:否

DestinationLocationArn

Amazon 存储资源位置的 Amazon 资源名称(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 资源名称(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 资源名称(ARN)的标签。

标签是键值对,帮助您管理、筛选和搜索 DataSync 资源。

类型:TagListEntry 对象数组

数组成员:最少 0 项。最多 50 项。

必需:否

响应语法

{ "TaskArn": "string" }

响应元素

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

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

TaskArn

任务的 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}$

错误

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

InternalException

当Amazon 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 资源名称 (ARN)。

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

另请参阅

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