CDN加速

文档中心 API文档 内容管理 推荐-查询文件预取操作记录

推荐-查询文件预取操作记录

更新时间:2020-10-27 13:51:47
适用产品:通用功能

接口描述

查询预取任务的执行状态,可查看是否已经全网执行生效。

请求参数

参数名称类型必填描述
startTimeString查询的任务创建开始时间,如 2017-01-10 06:33:26,不允许查询3天之前的任务
endTimeString查询的任务创建结束时间,如 2017-01-10 23:33:26 1)查询跨度不能超过1天;
itemIdString表示任务单次提交多个url时任务的唯一标识。 按批次查询任务,如单次提交10条url文件预取,提交成功后内容管理系统将返回一个itemId在响应消息里。 itemId 和 查询起止时间不能同时为空。
urlString需要预取的文件完整访问路径(url),单次查询只允许输入一条url
statusString任务状态,允许执行任务状态过滤查询结果,支持查询的状态有: 1)success 2)failure
pageNoString请求页数,缺省情况下,默认为1
pageSizeString每页显示的条数,缺省情况下,默认值为20

返回参数

参数名称类型描述
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要预取的文件url

错误码

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

示例

示例说明
请求示例
复制
#!/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/fetch/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",
                    "rate": "100",
                    "status": "success",
                    "url": "http: //vodtest.lxdns.com/testdsfsdf1"
                    },
                    {
                    "beginTime": "2017-01-11 16:17:03",
                    "createTime": "2017-01-11 16:17:03",
                    "finishTime": "2017-01-11 16:17:04",
                    "rate": "100",
                    "status": "success",
                    "url": "https://vodtest.lxdns.com/testdsfsdf1"
                    }
                   ]
}