CDN

刷新预热进度查询接口

最近更新时间:2017-12-21 21:20:06

GetRefreshOrPreloadTask

描述

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

  • 支持根据任务ID、URL获取数据
  • 支持按指定的起止时间查询,两者需要同时指定
  • 所有参数都不指定,默认查7天内,第一页的数据(20条)
  • 起止时间、TaskId、Url可以同时指定,逻辑与的关系
  • 最多可获取7天内的数据
  • 使用场景

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

    • 接口仅支持POST请求格式

请求参数

参数名 必选 类型及范围 说明
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
Urls Url[] Url组成的数组,支持按Url路径查询,准确匹配
PageSize Long 分页大小,取值为1-50,最大50,默认20
PageNumber Long 取得第几页,取值为:1-100000,最大100000,默认1

Url

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

返回参数

参数名 类型及范围 说明
PageSize Long 整页大小
PageNumber Long 页码
TotalCount Long Url总条数
Datas UrlData[] 刷新或预热任务进度百分比及状态信息

UrlData

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

示例

请求示例

POST JSON方式:

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

{    
    "PageSize":1,
    "PageNumber":1,
    "Urls":[
        {"Url": "http://test.dxz.ksyun.8686c.com/l/"},
        {"Url": "http://test.dxz.ksyun.8686c.com/abc.txt"}
    ]
}

POST XML方式:

POST /2016-09-01/content/GetRefreshOrPreloadTask 1.1
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
Content-Type:application/xml
Accept:application/xml
X-Action: RefreshCaches
X-Version: 2016-09-01

<RefreshCaches>
    <Urls>
        <Url>http://test.dxz.ksyun.8686c.com/abc.txt</Url>
        <Url>http://test.dxz.ksyun.8686c.com/abcd.txt</Url>
    </Urls>
</RefreshCaches>

返回示例

JSON格式:

{"Urls":
    [
        {"Url":"http://www.superb.6.baidu.com/b2"},
        {"Url":"http://www.superb.6.baidu.com/b1"}
    ], "EndTime":"2017-02-17T17:04+0800", "PageNumber":"1", "PageSize": "2", "StartTime": "2017-02-14T01:14+0800", "TaskId": "ee4d382ce6044d76881420c774a41020"}

    {
  "StartTime": "2017-02-14T01:14+0800",
  "EndTime": "2017-02-17T17:04+0800",
  "TaskId": "ee4d382ce6044d76881420c774a41020",
  "Urls": [
    {
      "Url": "http://www.superb.6.baidu.com/b2"
    },
    {
      "Url": "http://www.superb.6.baidu.com/b1"
    }
  ],
  "PageSize": 2,
  "PageNumber": 1,
  "TotalCount": 2,
  "Datas": [
    {
      "Type": "refresh",
      "Url": "http://www.superb.6.baidu.com/b1",
      "Progress": 100,
      "Status": "success",
      "TaskId": "ee4d382ce6044d76881420c774a41020",
      "CreateTime": "2017-02-16T14:41+0800"
    },
    {
      "Type": "refresh",
      "Url": "http://www.superb.6.baidu.com/b2",
      "Progress": 100,
      "Status": "success",
      "TaskId": "ee4d382ce6044d76881420c774a41020",
      "CreateTime": "2017-02-16T14:41+0800"
    }
  ]
}

XML格式:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ReSetProgressRequest>
    <StartTime>2017-02-14T01:14+0800</StartTime>
    <EndTime>2017-02-17T17:04+0800</EndTime>
    <TaskId>ee4d382ce6044d76881420c774a41020</TaskId>
    <Urls>
        <Url>http://www.superb.6.baidu.com/b2</Url>
    </Urls>
    <Urls>
        <Url>http://www.superb.6.baidu.com/b1</Url>
    </Urls>
    <PageSize>2</PageSize>
    <PageNumber>1</PageNumber>
    <TotalCount>2</TotalCount>
    <Datas>
        <Type>refresh</Type>
        <Url>http://www.superb.6.baidu.com/b1</Url>
        <Progress>100.0</Progress>
        <Status>success</Status>
        <TaskId>ee4d382ce6044d76881420c774a41020</TaskId>
        <CreateTime/>
    </Datas>
    <Datas>
        <Type>refresh</Type>
        <Url>http://www.superb.6.baidu.com/b2</Url>
        <Progress>100.0</Progress>
        <Status>success</Status>
        <TaskId>ee4d382ce6044d76881420c774a41020</TaskId>
        <CreateTime/>
    </Datas>
</ReSetProgressRequest>

金山云,开启您的云计算之旅

立即注册