全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

刷新预热进度查询接口

最近更新时间:2022-03-17 17:10:28

GetRefreshOrPreloadTask

描述

本接口用于获取URL刷新、目录刷新和预热任务进度百分比及状态,查看任务是否在全网生效。

  • 支持根据任务ID、域名、URL获取数据

  • 支持按指定的起止时间查询,两者需要同时指定

  • 所有参数都不指定,默认查今天第一页的数据(20条)

  • 单次查询任务最大返回500w条,超过10w条,TotalCount返回为100000,但可通过指定PageNumber去查看10w条以外的数据

  • 起止时间、TaskId、域名、Url可以同时指定,逻辑与的关系

  • 最多可获取4天内的数据,例如您当前的查询时间为2016-08-04-16:00,则您获取的数据起始时间最早为2016-08-01-00:00

  • 使用场景

    • 查询用户URL刷新、目录刷新或预热URL进度百分比及状态,查看是否在全网生效,用于在控制台展示
    • 客户通过API获取URL刷新、目录刷新或预热任务或URL进度百分比及状态,查看是否在全网生效
  • 注意:

    • 接口仅支持POST请求格式

请求语法

本接口请求需要包含指定目录/2016-09-01/content/GetRefreshOrPreloadTask、公共请求header和该接口所特有的请求参数,具体请求语句参照下文请求示例。

请求参数

参数名 必选 类型及范围 说明
StartTime String 获取数据起始时间点,不能超出可查询范围的起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800
TaskId String 支持按任务ID查询,只允许输入单个任务ID
DomainName String 支持按域名查询,只允许输入单个域名
Urls Url[] Url组成的数组,支持按Url路径查询,准确匹配
PageSize Long 分页大小,取值为1-50,最大50,默认20
PageNumber Long 取得第几页,取值为:1-100000,最大100000,默认1

Url

参数名 必选 类型及范围 说明
Url String 需要查询的Url路径

返回参数

参数名 类型及范围 说明
StartTime String 开始时间
EndTime String 结束时间
Urls Url[] 查询的URL列表
PageSize Long 整页大小
PageNumber Long 页码
TotalCount Long Url总条数
Datas UrlData[] 刷新或预热任务进度百分比及状态信息

Url

参数名 类型及范围 说明
Url String 需要查询进度的url

UrlData

参数名 类型及范围 说明
Type String 任务类别,取值为:refresh,刷新任务;取值为:preload,预热任务
Url String 刷新或预热的Url地址
Progress Double 刷新或预热任务进度百分比数值
Status String 刷新或预热状态信息,取值分别是success(成功)、progressing(进行中)、failed(刷新失败)
TaskId String 任务ID,按照任务ID查询刷新或预热任务进度百分比及状态信息
CreateTime String 任务创建时间

示例

请求示例

POST方式

POST /2016-09-01/content/GetRefreshOrPreloadTask
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: RefreshCaches
x-version: 2016-09-01
Content-Type: application/json

{
    "TaskId": "8108f920-088d-468d-b093-dbbe94dc1c7c"
}

返回示例

{
    "StartTime": "2022-03-14T17:09+0800",
    "EndTime": "2022-03-15T17:09+0800",
    "PageSize": 20,
    "PageNumber": 1,
    "TotalCount": 2,
    "Datas": [
        {
            "Type": "preload",
            "SubType": "PRELOAD_FILE",
            "Url": "http://wcdn-20220304-1.ksc-test.com/abc.txt",
            "Progress": 100.0,
            "Status": "success",
            "TaskId": "8108f920-088d-468d-b093-dbbe94dc1c7c",
            "CreateTime": "2022-03-15T17:05+0800"
        },
        {
            "Type": "preload",
            "SubType": "PRELOAD_FILE",
            "Url": "http://wcdn-20220304-1.ksc-test.com/test",
            "Progress": 0.0,
            "Status": "failed",
            "TaskId": "8108f920-088d-468d-b093-dbbe94dc1c7c",
            "CreateTime": "2022-03-15T17:05+0800"
        }
    ]
}

错误码

为了帮您快速定位问题,WCDN将错误码集中归类,请到【使用须知】查看详情。

文档导读
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈