本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
DescribeTask
傳回任務的中繼資料。
請求語法
{
"TaskArn": "string"
}請求參數
如需所有動作共用參數的相關資訊，請參閱一般參數。
請求接受採用 JSON 格式的下列資料。
- 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}$必要：是
回應語法
{
"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 Resource Name (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
-
建立任務的時間。
類型：Timestamp
- CurrentTaskExecutionArn
-
傳輸檔案之任務執行的 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}/execution/exec-[0-9a-f]{17}$ - DestinationLocationArn
-
AWS儲存資源位置的 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}:location/loc-[0-9a-z]{17}$ - DestinationNetworkInterfaceArns
-
為您的目的地位置建立之 Amazon Resource Name (ARN)。如需詳細資訊，請參閱 Network 介面需求。
類型：字串陣列
長度限制：長度上限為 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
-
在傳輸期間排除特定資料的篩選規則清單。如需詳細資訊和範例，請參閱篩選傳輸者DataSync。
類型：FilterRule 物件陣列
陣列成員：項目數下限為 0。項目數上限為 1。
- Includes
-
在傳輸期間包含特定資料的篩選規則清單。如需詳細資訊和範例，請參閱篩選傳輸者DataSync。
類型：FilterRule 物件陣列
陣列成員：項目數下限為 0。項目數上限為 1。
- Name
-
所描述之任務的名稱。
類型：字串
長度限制：長度下限為 1。長度上限為 256。
模式：
^[a-zA-Z0-9\s+=._:@/-]+$ - Options
-
控制作業行為的組態選
StartTaskExecution項。某些選項包括保留檔案或物件中繼資料以及驗證資料完整性。您可以針對每個工作執行覆寫這些選項。如需詳細資訊，請參閱StartTaskExecution。
類型：Options 物件
- Schedule
-
用於定期將檔案從來源傳輸到目的地位置的排程。
類型：TaskSchedule 物件
- SourceLocationArn
-
來源檔案系統位置的 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}:location/loc-[0-9a-z]{17}$ - SourceNetworkInterfaceArns
-
為來源位置建立的 Amazon Resource Name (ARN)。如需詳細資訊，請參閱 Network 介面需求。
類型：字串陣列
長度限制：長度上限為 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 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}$
錯誤
如需所有動作常見的錯誤相關資訊，請參閱常見錯誤。
- 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 的詳細資訊，請參閱下列說明：
