Queries the status of refresh or prefetch tasks under an accelerated domain name.
- You can query the status of tasks by task ID or URL.
- If you do not specify the TaskId or ObjectPath parameter, data collected within the last three days on the first page is returned. By default, a maximum of 20 entries are returned on each page.
- You can specify both the Taskid and Objectpath parameters.
- If you specify the DomainName or TaskStatus parameter, you must also specify the ObjectType parameter.
- You can query data collected within the last three days.
- The maximum number of times that each user can call this operation per second is 10.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeRefreshTasks |
The operation that you want to perform. Set the value to DescribeRefreshTasks. |
TaskId | String | No | 1234321 |
The task ID by which the task status is queried. |
ObjectPath | String | No | http://aaa.com/1.txt |
The path by which the task status is queried. Only exact match is supported. |
PageNumber | Integer | No | 1 |
The number of the page to return. Valid values: 1 to 100000. |
ObjectType | String | No | file |
The type of the task. Valid values:
If you set the DomainName or TaskStatus parameter, you mus also set this parameter. |
DomainName | String | No | www.yourdomain.com |
The accelerated domain name. You can specify only one domain name. By default, this operation queries the status of tasks under all accelerated domain names. |
Status | String | No | Complete |
The status of the task. Valid values:
|
PageSize | Integer | No | 20 |
The number of entries to be returned on each page. Default value: 20. Maximum value: 100. Valid values: 1 to 100. |
StartTime | String | No | 2017-12-21T08:00:00Z |
The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. |
EndTime | String | No | 2017-12-22T08:00:00Z |
The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The end time must be later than the start time. |
ResourceGroupId | String | No | your resourceGroupId |
The ID of the resource group. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Tasks | Array of CDNTask |
The detailed information about the tasks that were queried. |
|
CDNTask | |||
TaskId | String | 704225667 |
The ID of the task. |
ObjectPath | String | http://aaa.com/1.txt |
The path of the object that was refreshed by the task. |
Status | String | Complete |
The status of the task. Valid values:
|
Process | String | 100% |
The progress of the task. Unit: percentage. |
ObjectType | String | file |
The type of the task. Valid values:
|
CreationTime | String | 2014-11-27T08:23:22Z |
The time when the task was created. The time is displayed in UTC. |
Description | String | Internal Error |
The type of the error returned when the refresh or prefetch task failed.
|
PageSize | Long | 1 |
The number of entries returned per page. |
PageNumber | Long | 10 |
The page number of the returned page. |
TotalCount | Long | 2 |
The total number of entries returned. |
RequestId | String | 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8 |
The ID of the request. |
Examples
Sample requests
https://cdn.aliyuncs.com?&Action=DescribeRefreshTasks
&ObjectPath=http://aaa.com/1.txt
&PageNumber=1
&PageSize=10
&<Common request parameters>
Sample success responses
XML
format
<DescribeRefreshTasksResponse>
<Tasks>
<CDNTask>
<CreationTime>2014-11-27T08:23:22Z</CreationTime>
<ObjectPath>http://aaa.com/1.txt</ObjectPath>
<Status>Complete</Status>
<TaskId>704225667</TaskId>
<ObjectType>file</ObjectType>
<Process>100%</Process>
</CDNTask>
<CDNTask>
<CreationTime>2014-11-27T08:18:38Z</CreationTime>
<ObjectPath>http://bbb.com/1.txt</ObjectPath>
<Status>Complete</Status>
<TaskId>704222904</TaskId>
<ObjectType>file</ObjectType>
<Process>100%</Process>
</CDNTask>
</Tasks>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<TotalCount>2</TotalCount>
<RequestId>174F6032-AA26-470D-B90E-36F0EB205BEE</RequestId>
</DescribeRefreshTasksResponse>
JSON
format
{
"Tasks": {
"CDNTask": [
{
"CreationTime": "2014-11-27T08:23:22Z",
"ObjectPath": "http://aaa.com/1.txt",
"Status": "Complete",
"TaskId": "704225667",
"ObjectType": "file",
"Process": "100%"
}, {
"CreationTime": "2014-11-27T08:18:38Z",
"ObjectPath": "http://bbb.com/1.txt",
"Status": "Complete",
"TaskId": "704222904",
"ObjectType": "file",
"Process": "100%"
}
]
},
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 2,
"RequestId": "174F6032-AA26-470D-B90E-36F0EB205BEE"
}
Error codes
For a list of error codes, visit the API Error Center.