全部产品
云市场

查询刷新和预热状态

更新时间:2019-01-18 20:27:30

描述

查询刷新和预热状态是否生效。

注意:

  • 支持根据任务ID或URL查询。
  • 若Taskid与Objectpath都不指定,则默认查询3天内第一页的数据(20条)。
  • Taskid与Objectpath可以同时指定。
  • 只能查询3天内的数据。

请求参数

参数 类型 是否必需 描述
Action String 操作接口名,系统规定参数。取值:DescribeRefreshTasks
TaskId String 按任务Id查询刷新状态
ObjectPath String 按路径查询,准确匹配
DomainName String 域名
ObjectType String 任务类型。取值范围:
  • file
  • path
  • preload
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

示例

请求示例:
  1. https://vod.cn-shanghai.aliyuncs.com?&Action=DescribeRefreshTasks&DomainName=a.com&ObjectType=file&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. }

XML格式

  1. <?xml version="1.0" encoding="utf-8"?>
  2. <DescribeRefreshTasksResponse>
  3. <Tasks>
  4. <Task>
  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. </Task>
  12. <Task>
  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. </Task>
  20. </Tasks>
  21. <PageNumber>1</PageNumber>
  22. <PageSize>10</PageSize>
  23. <TotalCount>2</TotalCount>
  24. <RequestId>13DF2E2F-FBF8-4E1C-9222-98141795443D</RequestId>
  25. </DescribeRefreshTasksResponse>

错误码

错误代码 错误信息 HTTP 状态 说明
Throttling Request was denied due to request throttling. 503 请求被流量控制限制。
OperationDenied Your account does not open VOD service yet. 403 账号未开通视频点播服务。
OperationDenied.Suspended Your VOD service is suspended. 403 账号已欠费,请充值。
InvalidTaskId.Malformed Specified TaskId is malformed. 400 TaskId格式错误。