本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。 # DescribeTask 提供*任务*的相关信息。任务定义了 Amazon DataSync 传输数据的位置和方式。 ## 请求语法 ``` { "TaskArn": "string" } ``` ## 请求参数 有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。 请求接受采用 JSON 格式的以下数据。 ** [TaskArn](#API_DescribeTask_RequestSyntax) ** 指定您想要了解的传输任务的 Amazon 资源名称（ARN）。 类型：字符串 长度限制：最大长度为 128。 模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|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" } ], "ManifestConfig": { "Action": "string", "Format": "string", "Source": { "S3": { "BucketAccessRoleArn": "string", "ManifestObjectPath": "string", "ManifestObjectVersionId": "string", "S3BucketArn": "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", "Status": "string" }, "ScheduleDetails": { "DisabledBy": "string", "DisabledReason": "string", "StatusUpdateTime": number }, "SourceLocationArn": "string", "SourceNetworkInterfaceArns": [ "string" ], "Status": "string", "TaskArn": "string", "TaskMode": "string", "TaskReportConfig": { "Destination": { "S3": { "BucketAccessRoleArn": "string", "S3BucketArn": "string", "Subdirectory": "string" } }, "ObjectVersionIds": "string", "OutputType": "string", "Overrides": { "Deleted": { "ReportLevel": "string" }, "Skipped": { "ReportLevel": "string" }, "Transferred": { "ReportLevel": "string" }, "Verified": { "ReportLevel": "string" } }, "ReportLevel": "string" } } ``` ## 响应元素 如果此操作成功，则该服务将会发送回 HTTP 200 响应。 服务以 JSON 格式返回以下数据。 ** [CloudWatchLogGroupArn](#API_DescribeTask_ResponseSyntax) ** 用于监控您的任务的亚马逊 CloudWatch 日志组的亚马逊资源名称 (ARN)。 有关更多信息，请参阅[使用 CloudWatch 日志监控数据传输](https://docs.amazonaws.cn/datasync/latest/userguide/configure-logging.html)。 类型：字符串 长度约束：最大长度为 562。 模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):logs:[a-z\-0-9]+:[0-9]{12}:log-group:([^:\*]*)(:\*)?$` ** [CreationTime](#API_DescribeTask_ResponseSyntax) ** 任务的创建时间。 类型：时间戳 ** [CurrentTaskExecutionArn](#API_DescribeTask_ResponseSyntax) ** 最近一次执行的任务的 ARN。 类型：字符串 长度限制：最大长度为 128。 模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|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](#API_DescribeTask_ResponseSyntax) ** 传输目标位置的 ARN。 类型：字符串 长度限制：最大长度为 128。 模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$` ** [DestinationNetworkInterfaceArns](#API_DescribeTask_ResponseSyntax) ** 为您的目标位置 DataSync 创建的[网络接口](https://docs.amazonaws.cn/datasync/latest/userguide/datasync-network.html#required-network-interfaces)。 ARNs 类型：字符串数组 长度限制：最大长度为 128。 模式：`^arn:aws[\-a-z]{0,}:ec2:[a-z\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$` ** [ErrorCode](#API_DescribeTask_ResponseSyntax) ** 如果任务出现问题，您可以使用错误代码来帮助排除故障。有关更多信息，请参阅[ DataSync 转移问题疑难解答](https://docs.amazonaws.cn/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html)。 类型：字符串 ** [ErrorDetail](#API_DescribeTask_ResponseSyntax) ** 如果任务出现问题，您可以使用错误详细信息来帮助排除故障。有关更多信息，请参阅[ DataSync 转移问题疑难解答](https://docs.amazonaws.cn/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html)。 类型：字符串 ** [Excludes](#API_DescribeTask_ResponseSyntax) ** 排除过滤器，用于定义源位置中您不想 DataSync 传输的文件、对象和文件夹。有关更多信息和示例，请参阅[使用过滤器指定 DataSync 传输的内容](https://docs.amazonaws.cn/datasync/latest/userguide/filtering.html)。 类型：[FilterRule](API_FilterRule.md) 对象数组 数组成员：最少 0 个物品。最多 1 项。 ** [Includes](#API_DescribeTask_ResponseSyntax) ** 包括过滤器，用于定义源位置中 DataSync 要传输的文件、对象和文件夹。有关更多信息和示例，请参阅[使用过滤器指定 DataSync 传输的内容](https://docs.amazonaws.cn/datasync/latest/userguide/filtering.html)。 类型：[FilterRule](API_FilterRule.md) 对象数组 数组成员：最少 0 个物品。最多 1 项。 ** [ManifestConfig](#API_DescribeTask_ResponseSyntax) ** 清单的配置，其中列出了您 DataSync 要传输的文件或对象。有关更多信息，请参阅[使用清单指定 DataSync 传输的内容](https://docs.amazonaws.cn/datasync/latest/userguide/transferring-with-manifest.html)。 类型：[ManifestConfig](API_ManifestConfig.md) 对象 ** [Name](#API_DescribeTask_ResponseSyntax) ** 任务的名称。 类型：字符串 长度限制：最小长度为 0。最大长度为 256。 模式：`^[a-zA-Z0-9\s+=._:@/-]+$` ** [Options](#API_DescribeTask_ResponseSyntax) ** 任务的设置。例如，保留哪些文件元数据、如何在传输结束时验证数据完整性，以及带宽限制等选项。 类型：[Options](API_Options.md) 对象 ** [Schedule](#API_DescribeTask_ResponseSyntax) ** 任务运行的时间计划。有关更多信息，请参阅[计划任务](https://docs.amazonaws.cn/datasync/latest/userguide/task-scheduling.html)。 类型：[TaskSchedule](API_TaskSchedule.md) 对象 ** [ScheduleDetails](#API_DescribeTask_ResponseSyntax) ** 有关[任务计划](https://docs.amazonaws.cn/datasync/latest/userguide/task-scheduling.html)的详细信息。 类型：[TaskScheduleDetails](API_TaskScheduleDetails.md) 对象 ** [SourceLocationArn](#API_DescribeTask_ResponseSyntax) ** 传输源位置的 ARN。 类型：字符串 长度限制：最大长度为 128。 模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$` ** [SourceNetworkInterfaceArns](#API_DescribeTask_ResponseSyntax) ** 为您的源位置 DataSync 创建的[网络接口](https://docs.amazonaws.cn/datasync/latest/userguide/datasync-network.html#required-network-interfaces)。 ARNs 类型：字符串数组 长度限制：最大长度为 128。 模式：`^arn:aws[\-a-z]{0,}:ec2:[a-z\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$` ** [Status](#API_DescribeTask_ResponseSyntax) ** 任务的状态。有关每种状态含义的信息，请参阅[任务状态](https://docs.amazonaws.cn/datasync/latest/userguide/create-task-how-to.html#understand-task-creation-statuses)。 类型：字符串 有效值：`AVAILABLE | CREATING | QUEUED | RUNNING | UNAVAILABLE` ** [TaskArn](#API_DescribeTask_ResponseSyntax) ** 任务的 ARN。 类型：字符串 长度限制：最大长度为 128。 模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:task/task-[0-9a-f]{17}$` ** [TaskMode](#API_DescribeTask_ResponseSyntax) ** 当前使用的任务模式。有关更多信息，请参阅[为数据传输选择任务模式](https://docs.amazonaws.cn/datasync/latest/userguide/choosing-task-mode.html)。 类型：字符串 有效值：`BASIC | ENHANCED` ** [TaskReportConfig](#API_DescribeTask_ResponseSyntax) ** 任务报告的配置，其中提供有关您的 DataSync 转移的详细信息。有关更多信息，请参阅[使用任务报告监控您的 DataSync转账](https://docs.amazonaws.cn/datasync/latest/userguide/task-reports.html)。 类型：[TaskReportConfig](API_TaskReportConfig.md) 对象 ## 错误 有关所有操作的常见错误信息，请参阅 [常见错误](CommonErrors.md)。 ** InternalException ** 当 Amazon DataSync 服务中发生错误时，会引发此异常。 HTTP 状态代码：500 ** InvalidRequestException ** 当客户端提交格式错误的请求时，会引发此异常。 HTTP 状态代码：400 ## 示例 ### 示例请求 以下示例指定要获取相关信息的 DataSync 任务的 ARN。 ``` { "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026" } ``` ### 示例响应 下面的示例介绍一个 `DescribeTask` 响应。 ``` { "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026", "Name": "MyTask", "TaskMode": "BASIC", "Status": "RUNNING", "SourceLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-1111aaaa2222bbbb3", "DestinationLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-0000zzzz1111yyyy2", "CurrentTaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f", "CreationTime": 1532660733.39, "Options": { "Atime": "BEST_EFFORT", "BytesPerSecond": 1000, "Gid": "NONE", "Mtime": "PRESERVE", "PosixPermissions": "PRESERVE", "PreserveDevices": "NONE", "PreserveDeletedFiles": "PRESERVE", "Uid": "NONE", "VerifyMode": "POINT_IN_TIME_CONSISTENT" }, "CloudWatchLogGroupArn": "arn:aws:logs:us-east-2:111222333444:log-group:/log-group-name:*" } ``` ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 Amazon SDKs，请参阅以下内容： + [Amazon 命令行界面 V2](https://docs.amazonaws.cn/goto/cli2/datasync-2018-11-09/DescribeTask) + [Amazon 适用于.NET 的 SDK V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/datasync-2018-11-09/DescribeTask) + [Amazon 适用于 C\$1\$1 的 SDK](https://docs.amazonaws.cn/goto/SdkForCpp/datasync-2018-11-09/DescribeTask) + [Amazon 适用于 Go v2 的 SDK](https://docs.amazonaws.cn/goto/SdkForGoV2/datasync-2018-11-09/DescribeTask) + [Amazon 适用于 Java 的 SDK V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/datasync-2018-11-09/DescribeTask) + [Amazon JavaScript V3 版软件开发工具包](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeTask) + [Amazon 适用于 Kotlin 的 SDK](https://docs.amazonaws.cn/goto/SdkForKotlin/datasync-2018-11-09/DescribeTask) + [Amazon 适用于 PHP 的 SDK V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/datasync-2018-11-09/DescribeTask) + [Amazon Python 软件开发工具包](https://docs.amazonaws.cn/goto/boto3/datasync-2018-11-09/DescribeTask) + [Amazon 适用于 Ruby V3 的 SDK](https://docs.amazonaws.cn/goto/SdkForRubyV3/datasync-2018-11-09/DescribeTask)