本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。 # DescribeTask 提供*任務*的相關資訊，定義 AWS DataSync 資料傳輸的位置和方式。 ## 請求語法 ``` { "TaskArn": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [TaskArn](#API_DescribeTask_RequestSyntax) ** 指定您要取得相關資訊之傳輸任務的 Amazon Resource Name (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) ** 用於監控任務的 Amazon CloudWatch 日誌群組的 Amazon Resource Name (ARN)。如需詳細資訊，請參閱[使用 CloudWatch Logs 監控資料傳輸](https://docs.aws.amazon.com/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) ** 建立任務的時間。類型：Timestamp ** [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.aws.amazon.com/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.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html)。類型：字串 ** [ErrorDetail](#API_DescribeTask_ResponseSyntax) ** 如果您的任務發生問題，您可以使用錯誤詳細資訊來協助您疑難排解問題。如需詳細資訊，請參閱[針對 DataSync 傳輸的問題進行故障診斷](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html)。類型：字串 ** [Excludes](#API_DescribeTask_ResponseSyntax) ** 排除篩選條件，以定義您不希望 DataSync 傳輸之來源位置中的檔案、物件和資料夾。如需詳細資訊和範例，請參閱[使用篩選條件指定 DataSync 傳輸的內容](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)。類型：[FilterRule](API_FilterRule.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 1。 ** [Includes](#API_DescribeTask_ResponseSyntax) ** 包含篩選條件，可定義您要 DataSync 傳輸之來源位置中的檔案、物件和資料夾。如需詳細資訊和範例，請參閱[使用篩選條件指定 DataSync 傳輸的內容](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)。類型：[FilterRule](API_FilterRule.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 1。 ** [ManifestConfig](#API_DescribeTask_ResponseSyntax) ** 列出您希望 DataSync 傳輸之檔案或物件的資訊清單組態。如需詳細資訊，請參閱[使用資訊清單指定 DataSync 傳輸的內容](https://docs.aws.amazon.com/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.aws.amazon.com/datasync/latest/userguide/task-scheduling.html)。類型：[TaskSchedule](API_TaskSchedule.md) 物件 ** [ScheduleDetails](#API_DescribeTask_ResponseSyntax) ** [任務排程](https://docs.aws.amazon.com/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.aws.amazon.com/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.aws.amazon.com/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.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)。類型：字串有效值:`BASIC | ENHANCED` ** [TaskReportConfig](#API_DescribeTask_ResponseSyntax) ** 任務報告的組態，提供 DataSync 傳輸的詳細資訊。如需詳細資訊，請參閱[使用任務報告監控 DataSync 傳輸](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html)。類型：[TaskReportConfig](API_TaskReportConfig.md) 物件 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS 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:*" } ``` ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeTask) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeTask) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeTask) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeTask) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeTask) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeTask) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeTask) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeTask) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeTask) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeTask)