推荐-预取文件
更新时间：2023-06-14 10:58:40
适用产品
内容管理
接口描述
将源站的内容主动预取到CDN节点，用户首次访问可直接命中缓存，即提升首次访问速度，又能有效缓解源站压力。
- 调用URL： https://open.chinanetcenter.com/ccm/fetch/ItemIdReceiver
- 调用方法：POST,GET
调用频率
单用户调用频率：10/5min
推荐使用 Open API在线调试
Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试
请求参数
Body 参数
| 参数名称 | 描述 |
|---|---|
*urlsList | 要预取到CDN节点的url集合，url格式说明：
1、URL 必须以 http:// 或 https:// 开头，输入示例：http://www.a.com/image/test.png。
2、每个url最大长度 2000 字符。
3、每个url所在的域名必须是在我司加速的域名且有预取权限。
4、url中如果包含中文字符，则提交的url需要是中文转义后的url，采用utf-8方式转义。
5、每日不超过20000条，不超过200G文件大小（账号粒度可调，联系技术支持人员调整）。
6、每次接口调用url的总数不超过400条。 |
isRangeInteger | 是否需要预取range段。
1、默认为0，表示预取完整的文件；
2、1表示预取文件0~512KB的range段（账号粒度可调，联系技术支持人员调整）。 |
返回参数
Body 参数
| 参数名称 | 描述 |
|---|---|
CodeInteger | 表示任务创建结果的状态码，1表示任务提交成功，0表示任务提交失败 |
MessageString | 表示任务提交后，系统的响应消息 |
itemIdString | 调用一次接口并提交任务成功后，将返回一个itemId，是当次提交任务的唯一标识，通过itemId可批量查询任务的状态（成功/失败）。 |
错误码
| 错误代码（code） | 描述（message） | HTTP状态码 | 语义 |
|---|---|---|---|
| 1 | success | 200 | 任务已提交成功，内容管理系统已成功接收到预取任务 |
| 0 | parse json/xml error | 200 | Json或者xml解析出错 |
| 0 | urls must be array | 200 | 要预取的urls入参必须为json数组格式 |
| 0 | username is invalid | 200 | 您调用预取接口的用户不存在或用户未启用 |
| 0 | storage today has reached the limit | 200 | 您今日文件预取总存储量已超标 |
| 0 | urls can not be empty | 200 | 要预取的文件集合不允许为空，即入参urls不允许为空 |
| 0 | the remaining number of urls today can submit is [] | 200 | 您本次提交的任务数超过每日剩余可预取任务数 |
| 0 | the number of url out of limit | 200 | 您单次调用提交的url超过400条的数目限制 |
| 0 | urls submitted today has reached the limit [] | 200 | 您今日可预取的文件数量已用完 |
| 0 | these urls are wrong,[url1,url2,...] | 200 | 提交的部分url中域名不允许预取或url格式错误（例如不以http://、https://开头）或域名和用户无关联关系（此次提交的正确的url预取任务会正常执行） |
| 0 | all the urls are wrong | 200 | 提交的所有url中域名不允许预取或url格式错误（例如不以http://、https://开头）或域名和用户无关联关系 |
| 0 | system error | 200 | 未知错误 |
示例
JSON
- 请求示例 复制成功
#!/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/ItemIdReceiver" \ -X "POST" \ -u "$username:$password" \ -H "Date:$date" \ -H "Content-Type: application/json" \ -d '{ "urls": [ "https://www.testb.com/test/test1.txt", "https://www.testb.com/test/test2.txt" ], "isRange":0 }'- 返回示例 复制成功
HTTP/1.1 200 OK Date: Fri, 26 Oct 2012 06:33:26 GMT Content-Type: application/json;charset=UTF-8 x-cnc-request-id:{id string auto generated by cloud server} { "Code": 1, "Message": "success", "itemId": "a2cfcc6fe79c4a8abcab806578f9bada" }
本篇文档内容对您是否有帮助？
有帮助
我要反馈