Queries details about asynchronous export tasks, such as the task IDs, start time, end time, task status, task parameters, and task results.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeAsyncTasks |
The operation that you want to perform. Set the value to DescribeAsyncTasks. |
PageNumber | Integer | Yes | 1 |
The number of the page to return. For example, to query the returned results on the first page, set the value to 1. |
PageSize | Integer | Yes | 10 |
The number of entries to return on each page. Maximum value: 20. |
RegionId | String | No | cn-hangzhou |
The region ID of the instance. Valid values:
|
ResourceGroupId | String | No | default |
The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates that the instance belongs to the default resource group. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
AsyncTasks | Array |
Details about the asynchronous export task. |
|
EndTime | Long | 157927362000 |
The end time of the task. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC. |
StartTime | Long | 156927362000 |
The start time of the task. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC. |
TaskId | Long | 1 |
The ID of the task. |
TaskParams | String | {"instanceId": "ddoscoo-cn-mp91j1ao****"} |
Details about the asynchronous export task. The parameter is a JSON string. The returned field in the value varies with TaskType. If the value of TaskType is 1, 3, 4, 5, or 6, the returned fields in the value are described as follows:
If the value of TaskType is 2, the returned field in the value is described as follows:
|
TaskResult | String | {"instanceId": "ddoscoo-cn-mp91j1ao****","url": "https://****.oss-cn-beijing.aliyuncs.com/heap.bin?Expires=1584785140&OSSAccessKeyId=TMP.3KfzD82FyRJevJdEkRX6JEFHhbvRBBb75PZJnyJmksA2QkMm47xFAFDgMhEV8Nm6Vxr8xExMfiy9LsUFAcLcTBrN3rDu3v&Signature=Sj8BNcsxJLE8l5qm4cjNlDt8gv****"} |
The task result. This parameter is a JSON string. The returned fields vary with TaskType. If the value of TaskType is 1, 3, 4, 5, or 6, the returned fields in the value are described as follows:
If the value of TaskType is 2, the returned fields in the value are described as follows:
|
TaskStatus | Integer | 2 |
The status of the task. Valid values:
|
TaskType | Integer | 5 |
The type of the task. Valid values:
|
RequestId | String | 0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc |
The ID of the request. |
TotalCount | Integer | 1 |
The total number of returned asynchronous export tasks. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeAsyncTasks
&PageNumber=1
&PageSize=10
&<Common request parameters>
Sample success responses
XML
format
<DescribeAsyncTasksResponse>
<TotalCount>1</TotalCount>
<RequestId>0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc</RequestId>
<AsyncTasks>
<TaskId>1</TaskId>
<TaskType>5</TaskType>
<TaskStatus>2</TaskStatus>
<StartTime>156927362</StartTime>
<EndTime>157927362</EndTime>
<TaskParams>
<instanceId>ddoscoo-cn-mp91j1ao****</instanceId>
</TaskParams>
<TaskResult>
<instanceId>ddoscoo-cn-mp91j1ao****</instanceId>
<url>https://****.oss-cn-beijing.aliyuncs.com/heap.bin?Expires=1584785140&OSSAccessKeyId=TMP.3KfzD82FyRJevJdEkRX6JEFHhbvRBBb75PZJnyJmksA2QkMm47xFAFDgMhEV8Nm6Vxr8xExMfiy9LsUFAcLcTBrN3rDu3v&Signature=Sj8BNcsxJLE8l5qm4cjNlDt8gv****</url>
</TaskResult>
</AsyncTasks>
</DescribeAsyncTasksResponse>
JSON
format
{
"TotalCount": 1,
"RequestId": "0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc",
"AsyncTasks": [
{
"TaskId": 1,
"TaskType": 5,
"TaskStatus": 2,
"StartTime": 156927362,
"EndTime": 157927362,
"TaskParams": {
"instanceId": "ddoscoo-cn-mp91j1ao****"
},
"TaskResult": {
"instanceId": "ddoscoo-cn-mp91j1ao****",
"url": "https://****.oss-cn-beijing.aliyuncs.com/heap.bin?Expires=1584785140&OSSAccessKeyId=TMP.3KfzD82FyRJevJdEkRX6JEFHhbvRBBb75PZJnyJmksA2QkMm47xFAFDgMhEV8Nm6Vxr8xExMfiy9LsUFAcLcTBrN3rDu3v&Signature=Sj8BNcsxJLE8l5qm4cjNlDt8gv****"
}
}
]
}
Error codes
For a list of error codes, visit the API Error Center.