全部产品
存储与CDN 数据库 域名与网站(万网) 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 钉钉智能硬件
CDN

查询刷新、预热状态

更新时间:2018-01-12 17:45:52

DescribeRefreshTasks

描述

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

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

请求参数

参数 类型 必要 描述
Action String 操作接口名,系统规定参数
取值:DescribeRefreshTasks
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 TaskItem组成的Task任务列表。
PageSize Integer 整页大小
PageNumber Integer 页码
TotalCount Integer 总条数

TaskItem 子节点

名称 类型 描述
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”

特定错误码

ErrorCode 错误码 Message 错误信息 HTTP 状态
Throttling Request was denied due to request throttling. 503 请求被流量控制限制
OperationDenied Your account does not open CDN service yet. 403 未开通CDN服务
OperationDenied Your CDN service is suspended. 403 CDN服务已被停止
InvalidTaskId.Malformed Specified TaskId is malformed. 400 TaskId格式错误

公共错误码请查看

示例

请求示例:

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

返回示例:

JSON格式:

  1. {
  2. "Tasks" : {
  3. "CDNTask" : [{
  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. }

XML格式:

  1. <?xml version="1.0" encoding="utf-8"?>
  2. <DescribeRefreshTasksResponse>
  3. <Tasks>
  4. <CDNTask>
  5. <CreationTime>2014-11-27T08:23:22Z</CreationTime>
  6. <ObjectPath>http://aaa.com/1.txt</ObjectPath>
  7. <Status>Complete</Status>
  8. <TaskId>704225667</TaskId>
  9. <ObjectType>file</ObjectType>
  10. <Process>100%</Process>
  11. </CDNTask>
  12. <CDNTask>
  13. <CreationTime>2014-11-27T08:18:38Z</CreationTime>
  14. <ObjectPath>http://bbb.com/1.txt</ObjectPath>
  15. <Status>Complete</Status>
  16. <TaskId>704222904</TaskId>
  17. <ObjectType>file</ObjectType>
  18. <Process>100%</Process>
  19. </CDNTask>
  20. </Tasks>
  21. <PageNumber>1</PageNumber>
  22. <PageSize>10</PageSize>
  23. <TotalCount>2</TotalCount>
  24. <RequestId>13DF2E2F-FBF8-4E1C-9222-98141795443D</RequestId>
  25. </DescribeRefreshTasksResponse>
本文导读目录