Use DescribeTaskAttribute to query asynchronous task details - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Queries the details of an asynchronous task. Currently, the asynchronous tasks that can be queried include ImportImage, ExportImage, and ModifyDiskSpec.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeTaskAttribute

get

*All Resource

*

None

Request parameters

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

Response elements

Element	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 (CancelTask). Valid values: true: The task can be canceled. false: The task cannot be canceled.	true
TotalCount	integer	The total number of tasks.	1
SuccessCount	integer	The number of successful tasks.	1
RegionId	string	The region ID.	cn-hangzhou
TaskAction	string	The name of the API operation associated with the task.	ExportImage
FailedCount	integer	The number of failed tasks.	0
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TaskStatus	string	The task status.	Finished
TaskProcess	string	The task progress.	100%
FinishedTime	string	The time when the task was completed.	2015-11-23T02:19Z
TaskId	string	The task ID.	t-ce946ntx4wr****
OperationProgressSet	object
OperationProgress	array<object>	The information about the task, including the status and related information of each subtask.
	array<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	object
RelatedItem	array<object>	The type of resource information.
	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

Success response

JSON format

{
  "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.
400	MissingParameter	An input parameter "RegionId" 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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.