CDN加速

文档中心 API文档 内容管理 推荐-查询刷新操作记录

推荐-查询刷新操作记录

更新时间:2021-06-02 14:20:08

适用产品:通用功能

接口描述

查询刷新缓存任务的执行状态,可查看是否已经全网执行生效。

请求参数

JSON
参数名称类型必填描述
startTimeString任务创建开始时间, 格式为yyyy-MM-dd HH:mm:ss;例如 2017-01-10 06:33:26, 只能查询3天之内的刷新任务。
endTimeString任务创建结束时间, 格式为yyyy-MM-dd HH:mm:ss;例如 2017-01-10 06:33:26,
itemIdString表示任务单次提交多个url时任务的唯一标识。 按批次查询任务,如单次提交10条url刷新,提交成功后内容管理系统将返回一个itemId在响应消息里。 itemId 和 查询起止时间不能同时为空。
urlString需要刷新缓存的url(支持目录、正则、tag、文件),单次调用只允许输入一条url
statusString任务状态,允许指定任务状态过滤,支持查询的状态有: 1)success 2)failure 3)wait 4)run
pageNoInt请求页数,缺省情况下,默认为1
pageSizeInt每页显示的条数,缺省情况下,默认值为20

返回参数

JSON
参数名称类型描述
x-cnc-request-idString本次请求的唯一标识,当接口调用异常时,可将requestID提供给我司技术支持,便于排查接口的访问日志。
countInt本次查询结果的数量,如有10个任务符合查询条件,则count的值为10
CodeInt任务提交后,系统的响应码,0表示失败,1表示成功
MessageString任务提交后,系统的响应消息
pageNoInt任务查询结果的总页数
pageSizeInt每页显示多少条刷新任务数据
resultDetailList任务结果的集合
beginTimeString内容管理系统开始执行缓存刷新任务的时间
createTimeString内容管理系统创建缓存刷新任务的时间
finishTimeString内容管理系统执行并汇总缓存刷新任务的完成时间
rateString执行缓存刷新任务的成功率,如98%,则值为98
statusString缓存刷新任务执行的状态,有以下几种状态: success:表示刷新文件缓存的任务执行成功 failure:表示刷新文件缓存的任务执行失败 wait:表示刷新缓存的任务正在排队中 run:表示刷新缓存的任务正在执行中
urlString执行缓存刷新的具体文件或目录
isDirInt刷新任务的操作类型: 0:刷新某个具体文件 1:正则文件 2:刷新某个目录下的所有文件 3:刷新某个tag

错误码

错误代码(code)描述(message)HTTP状态码语义
0endTime should not before startTime200查询的结束时间不能早于开始时间
0page no error200页码不能为负
0page size error200页面大小不能为负或者大于1000
0parse json error200解析json出错
0query create time should not before 3 days200不允许查询3天之前的任务
0query time error200时间格式出错
0startTime or endTime must not be empty200开始时间或结束时间不允许为空
1success200查询成功
0task status error,eg: init wait run success failure200查询的状态出错
0username is invalid200用户名无效(用户名为空或者用户名不允许推送)

示例

JSON
XML
示例说明
请求示例
复制
#!/bin/bash
username="username"
apiKey="apiKey"
date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"`
password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64`
curl -i --url "https://open.chinanetcenter.com/ccm/purge/ItemIdQuery" \
-X "POST" \
-u "$username:$password" \
-H "Date:$date" \
-H "Content-Type: application/json" \
-d '{
    "startTime":"2017-05-01 00:00:00",
    "endTime":"2017-05-02 23:59:59",
    "itemId":"3ff59d129a2c40a39b9be8c9de9975d6",
    "url":"https://www.test.com/test/test.jpg",
    "status":"success",
    "pageNo":1,
    "pageSize":20
}'
返回示例
复制
HTTP/1.1 200 OK
Content-Type: charset=utf-8; charset=UTF-8
x-cnc-request-id: 23f9abf8-1f4a-498c_1493668625478
Server: xxx
Content-Length: 1355
{
   "count": 282,
   "Code": 1,
   "Message":"success",
   "pageNo": 1,
   "pageSize": 20,
   "resultDetail": [
                    {
                    "beginTime": "2017-01-11 16:17:03",
                    "createTime": "2017-01-11 16:17:03",
                    "finishTime": "2017-01-11 16:17:04",
                    "isDir":0,
                    "rate": "100",
                    "status": "success",
                    "url": "http: //www.abc.com/testdsfsdf1"
                    },
                    {
                    "beginTime": "2017-01-11 16:17:03",
                    "createTime": "2017-01-11 16:17:03",
                    "finishTime": "2017-01-11 16:17:04",
                    "isDir":1,
                    "rate": "100",
                    "status": "success",
                    "url": "http: //www.abc.com/test/"
                    }
                   ]
}