All Products
Search
Document Center

Elastic Compute Service:DescribeTaskAttribute

Last Updated:Mar 19, 2024

You can call this operation to query the details of an asynchronous task. You can query the asynchronous tasks including importing images, exporting images, and modifying disk categories. The asynchronous tasks are generated by the ImportImage, ExportImage, and ModifyDiskSpec operations.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the task. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
TaskIdstringYes

The ID of the task. You can call the DescribeTasks operation to query the list of task IDs.

t-ce946ntx4wr****

Response parameters

ParameterTypeDescriptionExample
object
CreationTimestring

The time when the task was created.

2015-11-23T02:13Z
SupportCancelstring

Indicates whether the task can be canceled ( CancelTask ). Valid values:

  • true: The task can be canceled.
  • false: The task cannot be canceled.
true
TotalCountinteger

The total number of tasks.

1
SuccessCountinteger

The number of completed tasks.

1
RegionIdstring

The region ID of the task.

cn-hangzhou
TaskActionstring

The operation name of the task.

ExportImage
FailedCountinteger

The number of failed tasks.

0
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TaskStatusstring

The status of the task.

Finished
TaskProcessstring

The progress of the task.

100%
FinishedTimestring

The time when the task was complete.

2015-11-23T02:19Z
TaskIdstring

The ID of the task.

t-ce946ntx4wr****
OperationProgressSetobject []

An array consisting of OperationProgress data of each subtask.

ErrorMsgstring

The error message.

The specified RegionId parameter is invalid.
ErrorCodestring

The error code.

ParameterInvalid
OperationStatusstring

The status of the operation.

Success
RelatedItemSetobject []

An array consisting of RelatedItem data.

Namestring

The name of the related item.

OSSObject
Valuestring

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 codeError codeError messageDescription
400InvalidRegionId.NotFoundThe specified RegionId does not exist.The specified region ID does not exist.
400MissingParameterAn input parameter "RegionId" that is mandatory for processing the request is not supplied.-
400MissingParameterAn input parameter "TaskId" that is mandatory for processing the request is not supplied.-
400InvalidTaskId.NotFoundThe specified "TaskId" is not found.-

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