All Products
Search
Document Center

DescribeDcdnRefreshTasks

Last Updated: Mar 01, 2019

Description

You can call this operation to check whether the latest data has been refreshed or pushed to all edge nodes.

Note:

  • You can check using task IDs or URLs.
  • By default, the last 20 tasks executed over the past three days are checked.
  • You can specify both the Taskid and Objectpath parameters.
  • If you specify DomainName or TaskStatus, you must also specify the ObjectType parameter.
  • You can only retrieve data within the last three days.

Request parameters

Name Type Required Description
Action String Yes The operation that you want to perform. Set the value to DescribeDcdnRefreshTasks.
TaskId String No The ID of the task.
ObjectPath String No The URL of the object, used as a condition of exact match.
DomainName String No The domain name.
ObjectType String No The type of the task. Valid values:
  • file
  • directory
  • preload
If you specify DomainName or TaskStatus, you must also specify the ObjectType parameter.
Status String No The status of the task. Valid values:
  • Complete
  • Refreshing
  • Failed
StartTime String No The time at which the task begins. For example, 2017-01-01T12:12:20Z.
EndTime String No The time at which the task ends. For example, 2017-01-01T12:12:20Z.
PageSize Integer No The number of task items displayed on the current page. Default: 20. Valid values: any integer from 1 to 50.
PageNumber Integer No The page number. Valid values: 1-10000.

Response parameters

Name Type Description
Tasks Struct The list of task items.
PageSize Integer The number of items displayed on the page.
PageNumber Integer The page number.
TotalCount Integer The total number of items found.

Task

Name Type Description
TaskId String The ID of the task.
ObjectPath String The URL of the object.
Status String The status of the task. Valid values:
  • Complete
  • Refreshing
  • Failed
  • Pending
Process String The progress, in percentage, of the task.
ObjectType String The type of the task. Valid values:
  • file
  • path
  • preload
CreationTime DateTime The time, in UTC, at which the task is created.
Description String The error message returned when the refresh or push task failed. Valid values:
  • Internal Error
  • Origin Timeout
  • Origin Return StatusCode 5XX

Examples

Sample requests

  1. https://dcdn.aliyuncs.com?&Action=DescribeDcdnRefreshTasks&ObjectPath=&PageNumber=1&PageSize=10&<Common request parameters>

Sample responses

JSON format

  1. {
  2. "Tasks" : {
  3. "Task" : [{
  4. "CreationTime" : "2014-11-27T08:23:22Z",
  5. "ObjectPath" : "http://aaa.com/1.txt",
  6. "Status" : "Complete",
  7. "TaskId" : "704225667",
  8. "ObjectType" : "file",
  9. "Process" : "100%"
  10. }, {
  11. "CreationTime" : "2014-11-27T08:18:38Z",
  12. "ObjectPath" : "http://bbb.com/1.txt",
  13. "Status" : "Complete",
  14. "TaskId" : "704222904",
  15. "ObjectType" : "file",
  16. "Process" : "100%"
  17. }
  18. ]
  19. },
  20. "PageNumber" : 1,
  21. "PageSize" : 10,
  22. "TotalCount" : 2,
  23. "RequestId" : "174F6032-AA26-470D-B90E-36F0EB205BEE"
  24. }

Error codes

Error code Error message HTTP status code
Throttling Request was denied due to request throttling. 503
OperationDenied Your account does not open CDN service yet. 403
OperationDenied Your CDN service is suspended. 403
InvalidTaskId.Malformed Specified TaskId is malformed. 400