本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
DescribeTask
返回任务的相关元数据。
请求语法
{
"TaskArn": "string"
}请求参数
有关所有操作的通用参数的信息，请参阅通用参数。
请求接受采用 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}$必需：是
响应语法
{
"CloudWatchLogGroupArn": "string",
"CreationTime": number,
"CurrentTaskExecutionArn": "string",
"DestinationLocationArn": "string",
"DestinationNetworkInterfaceArns": [ "string" ],
"ErrorCode": "string",
"ErrorDetail": "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",
"SourceNetworkInterfaceArns": [ "string" ],
"Status": "string",
"TaskArn": "string"
}响应元素
如果此操作成功，则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回的以下数据。
- CloudWatchLogGroupArn
-
Amazon CloudWatch 日志组（用于监控和记录任务中的事件）的 Amazon 资源名称（ARN）。
有关这些日志组的更多信息，请参阅《Amazon CloudWatch 用户指南》中的使用日志组和日志流。
类型：字符串
长度约束：最大长度为 562。
模式：
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):logs:[a-z\-0-9]+:[0-9]{12}:log-group:([^:\*]*)(:\*)?$ - CreationTime
-
任务的创建时间。
类型：时间戳
- CurrentTaskExecutionArn
-
传输文件的任务的 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}/execution/exec-[0-9a-f]{17}$ - DestinationLocationArn
-
AWS存储资源位置的 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}$ - DestinationNetworkInterfaceArns
-
为目标位置创建的网络接口的 Amazon 资源名称（ARN）。有关更多信息，请参阅网络接口要求。
类型：字符串数组
长度约束：最大长度为 128。
模式：
^arn:aws[\-a-z]{0,}:ec2:[a-z\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$ - ErrorCode
-
执行任务期间AWS DataSync遇到的错误。您可以使用此错误代码来帮助解决问题。
类型：字符串
- ErrorDetail
-
对任务执行过程中遇到的错误的详细描述。您可以使用此信息来帮助排查问题。
类型：字符串
- Excludes
-
在传输过程中排除特定数据的筛选规则列表。有关更多信息和示例，请参阅 Filtering by DataSferred DataSync by
类型：FilterRule 对象数组
数组成员：最少 0 项。最多 1 项。
- Includes
-
在传输期间包含特定数据的筛选规则列表。有关更多信息和示例，请参阅 Filtering by DataSferred DataSync by
类型：FilterRule 对象数组
数组成员：最少 0 项。最多 1 项。
- Name
-
所描述的任务的名称。
类型：字符串
长度限制：最小长度为 1。长度上限为 256。
模式：
^[a-zA-Z0-9\s+=._:@/-]+$ - Options
-
控制
StartTaskExecution操作行为的配置选项。一些选项包括保留文件或对象元数据以及验证数据完整性。每次执行任务时，您可以重写这些选项。有关更多信息，请参阅StartTaskExecution。
类型：Options 对象
- Schedule
-
用于定期将文件从源位置传输到目标位置的时间表。
类型：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}$ - SourceNetworkInterfaceArns
-
为源位置创建的网络接口的 Amazon 资源名称（ARN）。有关更多信息，请参阅网络接口要求。
类型：字符串数组
长度约束：最大长度为 128。
模式：
^arn:aws[\-a-z]{0,}:ec2:[a-z\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$ - Status
-
所描述的任务的状态。
有关任务执行状态的详细信息，请参阅《AWS DataSync用户指南》中的 “了解任务状态”。
类型：字符串
有效值：
AVAILABLE | CREATING | QUEUED | RUNNING | UNAVAILABLE - 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
-
当AWS DataSync服务中发生错误时，会引发此异常。
HTTP 状态代码：500
- InvalidRequestException
-
当客户端提交格式错误的请求时，会引发此异常。
HTTP 状态代码：400
示例
示例
以下示例返回有关示例请求中指定的任务的信息。
示例请求
{
"TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026"
}示例
此示例说明了的一种用法DescribeTask。
示例响应
{
"CloudWatchLogGroupArn": "arn:aws:logs:us-east-2:111222333444:log-group"
"CreationTime": 1532660733.39,
"CurrentTaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f",
"Options": {
"Atime": "BEST_EFFORT",
"BytesPerSecond": 1000,
"Gid": "NONE",
"Mtime": "PRESERVE",
"PosixPermissions": "PRESERVE",
"PreserveDevices": "NONE",
"PreserveDeletedFiles": "PRESERVE",
"Uid": "NONE",
"VerifyMode": "POINT_IN_TIME_CONSISTENT"
},
"DestinationLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50fb",
"ErrorCode": "???????",
"ErrorDetail": "??????",
"Name": "MyTask",
"SourceLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50aa",
"Status": "CREATING",
"TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026"
}另请参阅
有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息，请参阅以下内容：
