本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
StartTaskExecution
启动Amazon DataSync任务。对于每个任务,您一次只能运行一个任务执行的。
任务执行分为几个阶段。有关更多信息,请参阅任务执行状态。
重要
如果您计划将数据传输到或传出 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
-
配置您的Amazon DataSync任务设置。这些选项包括如何 DataSync 处理文件、对象及其关联的元数据。您还可以指定如何 DataSync 验证数据完整性、为任务设置带宽限制以及其他选项。
每个任务设置都有一个默认值。除非需要,否则
Options
在开始任务之前不必对其进行任何配置。类型:Options 对象
必需:否
- Tags
-
指定要应用于代表任务执行的 Amazon 资源名称(ARN)的标签。
标签是键值对,帮助您管理、筛选和搜索 DataSync 资源。
类型: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
-
当Amazon 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" }
另请参阅
有关在特定语言的 Amazon 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: