Query task attributes

Last Updated: Jul 25, 2017

Description

Query detail information about a task.

Request parameters

Name Type Required Description
Action String Yes Operation interface name; value: DescribeTaskAttribute.
RegionId String Yes Region ID
TaskId String No Task ID

Return parameters

Name Type Description
TaskId String Task status
TaskAction String Operation API name
RegionId String Region ID
TaskStatus String Task status
Progress String Task progress
SupportCancel String Whether the task can be cancelled
Optional values:
  • True
  • False
SuccessCount Integer Number of tasks that have been successfully executed
FailedCount Integer Number of failed tasks
CreationTime String Task creation time, which follows the ISO8601 standard and uses UTC time. It is in the format of YYYY-MM-DDThh:mmZ.
FinishedTime String Task completion time, which follows the ISO8601 standard and uses UTC time. It is in the format of YYYY-MM-DDThh:mmZ.

Error Codes

No error codes.

Example

Request example

  1. https://ecs.aliyuncs.com/?Action=DescribeTaskAttribute
  2. &RegionId=cn-hangzhou
  3. &TaskId=t-23ym6mvro& <Public Request Parameters>

Return Example

XML format

  1. <DescribeTaskAttributeResponse>
  2. <CreationTime>2015-11-23T02:13Z</CreationTime>
  3. <OperationProgressSet>
  4. <OperationProgress>
  5. <RelatedItemSet>
  6. <RelatedItem>
  7. <Name>OSSBucket</Name>
  8. <Value>image-temp</Value>
  9. </RelatedItem>
  10. <RelatedItem>
  11. <Name>OSSObject</Name>
  12. <Value>MYOSSPRE_m-23f8tcp8y_t-23ym6mvro.vhd</Value>
  13. </RelatedItem>
  14. <RelatedItem>
  15. <Name>ImageFormat</Name>
  16. <Value>vhd</Value>
  17. </RelatedItem>
  18. </RelatedItemSet>
  19. <ErrorMsg/>
  20. <ErrorCode/>
  21. <OperationStatus>Success</OperationStatus>
  22. </OperationProgress>
  23. </OperationProgressSet>
  24. <FinishedTime>2015-11-23T02:19Z</FinishedTime>
  25. <FailedCount>0</FailedCount>
  26. <SupportCancel>true</SupportCancel>
  27. <TotalCount>1</TotalCount>
  28. <SuccessCount>1</SuccessCount>
  29. <RequestId>EF0C5969-279B-49C8-AD83-BACCC74DD38C</RequestId>
  30. <RegionId>cn-hangzhou</RegionId>
  31. <TaskAction>ExportImage</TaskAction>
  32. <TaskStatus>Finished</TaskStatus>
  33. <TaskProcess>100%</TaskProcess>
  34. <TaskId>t-23ym6mvro</TaskId>
  35. </DescribeTaskAttributeResponse>

JSON format

  1. {
  2. "CreationTime": "2015-11-23T02:13Z",
  3. "OperationProgressSet": {
  4. "OperationProgress": [
  5. {
  6. "RelatedItemSet": {
  7. "RelatedItem": [
  8. {
  9. "Name": "OSSBucket",
  10. "Value": "image-temp"
  11. },
  12. {
  13. "Name": "OSSObject",
  14. "Value": "MYOSSPRE_m-23f8tcp8y_t-23ym6mvro.vhd"
  15. },
  16. {
  17. "Name": "ImageFormat",
  18. "Value": "vhd"
  19. }
  20. ]
  21. },
  22. "ErrorMsg": "",
  23. "ErrorCode": "",
  24. "OperationStatus": "Success"
  25. }
  26. ]
  27. },
  28. "FinishedTime": "2015-11-23T02:19Z",
  29. "FailedCount": 0,
  30. "SupportCancel": true,
  31. "TotalCount": 1,
  32. "SuccessCount": 1,
  33. "RequestId": "4BE2C7FE-C7A4-4675-A153-174E032AABFB",
  34. "RegionId": "cn-hangzhou",
  35. "TaskAction": "ExportImage",
  36. "TaskStatus": "Finished",
  37. "TaskProcess": "100%",
  38. "TaskId": "t-23ym6mvro"
  39. }
Thank you! We've received your feedback.