全部产品
阿里云办公

查询刷新预热状态

更新时间:2018-11-13 20:49:52

概述

查询刷新、预热状态是否在全网生效。

注意:

  • 支持根据任务ID或URL查询。
  • Taskid与Objectpath都不指定,默认查3天内、第一页的数据(20条)。
  • Taskid与Objectpath可以同时指定。
  • 当指定DomainName或TaskStatus时,必须填写ObjectType。
  • 只可查询3天内的数据。

请求参数

参数 类型 是否必需 描述
Action String 操作接口名。系统规定参数。取值:DescribeDcdnRefreshTasks
TaskId String 按任务ID查询刷新状态 。
ObjectPath String 按路径查询,准确匹配。
DomainName String 域名。
ObjectType String 任务类型。取值范围:
  • file
  • path
  • preload
当指定DomainName或TaskStatus时,此项必填。
Status String 任务状态。
  • Complete:完成
  • Refreshing:刷新中
  • Failed:刷新失败
StartTime String 开始时间。格式例如:2017-01-01T12:12:20Z
EndTime String 结束时间。格式例如:2017-01-01T12:12:20Z
PageSize Integer 分页大小。默认值:20,最大值:50,取值范围:1~50之前的任意整数
PageNumber Integer 取得页数。取值范围为:1~100000

返回参数

名称 类型 描述
Tasks Struct Task组成的Task任务列表
PageSize Integer 整页大小
PageNumber Integer 页码
TotalCount Integer 总条数

Task 子节点

名称 类型 描述
TaskId String 任务ID。
ObjectPath String 刷新对象路径。
Status String 状态。取值范围:
  • Complete:完成
  • Refreshing:刷新中
  • Failed:刷新失败
  • Pending:等待刷新
Process String 进度百分比。
ObjectType String 任务类型。取值范围:
  • file
  • path
  • preload
CreationTime DateTime 任务对象创建时间。为UTC时间。
Description String 刷新预热失败返回错误描述。取值范围:
  • Internal Error
  • Origin Timeout
  • Origin Return StatusCode 5XX

示例

请求示例

  1. https://dcdn.aliyuncs.com?&Action=DescribeDcdnRefreshTasks&ObjectPath=&PageNumber=1&PageSize=10&<公共请求参数>

返回示例

JSON格式:

  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. }

错误码

错误代码 错误信息 HTTP 状态码
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