DescribeTasks - API Reference| Alibaba Cloud Documentation Center

Description

Query the progress of a specified asynchronous request.

Request parameters

Name	Type	Required	Description
Action	String	Yes	The name of this interface. Value: DescribeTasks.
RegionId	String	Yes	Region ID. See Regions and zones for region IDs.
TaskAction	String	No	The specified action to be queried. Optional values: ImportImage: Query the task of importing an image ExportImage: Query the task of exporting an image
TaskIds	String	No	Task ID; up to 100 task IDs are supported, and they are separated by comma.
TaskStatus	String	No	Task status. Optional values: Finished Processing Pending Deleted Paused Default value: None Currently, you can query the task in the `Finished` and `Processing` status, and other value is ignored in the request.
StartTime	String	No	Query by creation time, start time of the creation time period. The time is displayed in the format specified in the ISO8601 standard, and the UTC time is used. It is in the format of YYYY-MM-DDThh:mmZ.
EndTime	String	No	Query by creation time, end time of the creation time period. The time is displayed in the format specified in the ISO8601 standard, and the UTC time is used. It is in the format of YYYY-MM-DDThh:mmZ.
PageNumber	Integer	No	Page number of the query result. Initial value: 1 Default value: 1
PageSize	Integer	No	Number of lines on each page, set for pagination query. Maximum value: 100 Default value: 10

Response parameters

Name	Type	Description
TaskSet	TaskType	Task set
RegionId	String	Region ID. See Regions and zones for region IDs.
TotalCount	Integer	Number of items in the list
PageNumber	Integer	Current page number
PageSize	Integer	Number of items included in the current page

Examples

Request example

https://ecs.aliyuncs.com/?Action=DescribeTasks
&RegionId=cn-hangzhou
&<Common Request Parameters>

Response example

XML format

<DescribeTasksResponse>
  <PageNumber>1</PageNumber>
  <TotalCount>2</TotalCount>
  <PageSize>2</PageSize>
  <RegionId>cn-hangzhou</RegionId>
  <RequestId>E5C82807-5588-4661-9A96-350B206A7623</RequestId>
  <TaskSet>
    <Task>
      <CreationTime>2015-11-24T12:50Z</CreationTime>
      <FinishedTime>2015-11-24T12:50Z</FinishedTime>
      <SupportCancel>true</SupportCancel>
      <TaskAction>IMPORT_IMAGE</TaskAction>
      <TaskStatus>Finished</TaskStatus>
      <TaskId>t-23mo8zf9w</TaskId>
    </Task>
    <Task>
      <CreationTime>2015-11-23T15:10Z</CreationTime>
      <FinishedTime>2015-11-23T15:16Z</FinishedTime>
      <SupportCancel>true</SupportCancel>
      <TaskAction>IMPORT_IMAGE</TaskAction>
      <TaskStatus>Finished</TaskStatus>
      <TaskId>t-23sgu0dyj</TaskId>
    </Task>
  </TaskSet>
</DescribeTasksResponse>

JSON format

{
    "PageNumber": 1,
    "TotalCount": 2,
    "PageSize": 2,
    "RegionId": "cn-hangzhou",
    "RequestId": "F746C690-D9EA-4F87-AF31-8E1910FAB541",
    "TaskSet": {
        "Task": [
            {
                "CreationTime": "2015-11-24T12:50Z",
                "FinishedTime": "2015-11-24T12:50Z",
                "SupportCancel": true,
                "TaskAction": "ImportImage",
                "TaskStatus": "Finished",
                "TaskId": "t-23mo8zf9w"
            },
            {
                "CreationTime": "2015-11-23T15:10Z",
                "FinishedTime": "2015-11-23T15:16Z",
                "SupportCancel": true,
                "TaskAction": "ImportImage",
                "TaskStatus": "Finished",
                "TaskId": "t-23sgu0dyj"
            }
        ]
    }
}

Error codes

Error code	Error message	HTTP status code	Meaning
MissingParameter	An input parameter RegionId that is mandatory for processing the request is not supplied.	400	The required parameter RegionId is missing. See Regions and zones for region IDs.
InvalidRegionId.NotFound	The specified region not found.	400	The specified RegionID does not exist. See Regions and zones for region IDs.