DescribeTaskAttribute - Elastic Compute Service - Alibaba Cloud Documentation Center

Queries the details of an asynchronous task. The asynchronous tasks that you can query by calling this operation are the tasks generated by the ImportImage, ExportImage, and ModifyDiskSpec operations.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the task. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
TaskId	string	Yes	The ID of the task. You can call the DescribeTasks operation to query the list of task IDs.	t-ce946ntx4wr****

Response parameters

Parameter	Type	Description	Example
	object
CreationTime	string	The time when the task was created.	2015-11-23T02:13Z
SupportCancel	string	Indicates whether the task can be canceled by calling the CancelTask operation. Valid values: true false	true
TotalCount	integer	The total number of tasks.	1
SuccessCount	integer	The number of completed tasks.	1
RegionId	string	The region ID of the task.	cn-hangzhou
TaskAction	string	The name of the operation that generated the task.	ExportImage
FailedCount	integer	The number of failed tasks.	0
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TaskStatus	string	The status of the task.	Finished
TaskProcess	string	The progress of the task.	100%
FinishedTime	string	The time when the task was completed.	2015-11-23T02:19Z
TaskId	string	The ID of the task.	t-ce946ntx4wr****
OperationProgressSet	array<object>	The return data of the task.
OperationProgress	object
ErrorMsg	string	The error message.	The specified RegionId parameter is invalid.
ErrorCode	string	The error code.	ParameterInvalid
OperationStatus	string	The status of the operation.	Success
RelatedItemSet	array<object>	The type of resource information.
RelatedItem	object
Name	string	The name of the related item.	OSSObject
Value	string	The value of the related item.	MYOSSPRE_m-23f8tcp*_t-23ym6mv*.vhd

Examples

Sample success responses

JSONformat

{
  "CreationTime": "2015-11-23T02:13Z",
  "SupportCancel": true,
  "TotalCount": 1,
  "SuccessCount": 1,
  "RegionId": "cn-hangzhou",
  "TaskAction": "ExportImage",
  "FailedCount": 0,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TaskStatus": "Finished",
  "TaskProcess": "100%",
  "FinishedTime": "2015-11-23T02:19Z",
  "TaskId": "t-ce946ntx4wr****",
  "OperationProgressSet": {
    "OperationProgress": [
      {
        "ErrorMsg": "The specified RegionId parameter is invalid.",
        "ErrorCode": "ParameterInvalid",
        "OperationStatus": "Success",
        "RelatedItemSet": {
          "RelatedItem": [
            {
              "Name": "OSSObject",
              "Value": "MYOSSPRE_m-23f8tcp***_t-23ym6mv***.vhd"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidRegionId.NotFound	The specified RegionId does not exist.	The specified region ID does not exist.
400	MissingParameter	An input parameter "RegionId" that is mandatory for processing the request is not supplied.	-
400	MissingParameter	An input parameter "TaskId" that is mandatory for processing the request is not supplied.	-
400	InvalidTaskId.NotFound	The specified "TaskId" is not found.	The specified task does not exist

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history