预部署缓存时间配置接口
更新时间：2022-12-05 14:52:37
适用产品
区块链安全加速解决方案、IPv6安全加速解决方案、点播分发、直播分发、移动加速、网页加速、下载分发、全站加速、应用安全加速解决方案、IPv6一体化解决方案、电商安全加速解决方案、金融安全加速解决方案、政企安全加速解决方案、应用安全解决方案
接口描述
通过接口自助查询节点缓存配置配置
- 调用URL： https://open.chinanetcenter.com/api/predeploy/cachetime/*
- 调用方法：PUT
- 限制说明：·在中国 加速域名必须已备案完成。 · 加速域名必须不包含如下信息：出售药物和管制刀具类，含有不法言论、信息。 · 视频类加速域名必须有视听许可证；博客论坛或社区类加速域名必须有BBS专项审批资质。 · 接口请求和返回结果接受xml和json格式。
推荐使用 Open API在线调试
Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试
请求参数
Path 参数
| 参数名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
domain-name | String | 是 | 需要查询配置的域名或域名id |
Body 参数
| 参数名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
cache-time-behaviors | List | 是 | 缓存时间配置
注意：
1. 需要取消缓存时间配置设置时，可以传入空节点 |
data-id | Long | 否 | 添加grid类型标识，表示客户多组配置时，具体某组配置 如果是新增一组配置项的值时，不需要传。如果指定修改具体data-id的配置项值时，需要传入对应配置项对应的data-id.可以通过查询接口获取 |
path-pattern | String | 是 | url匹配模式，支持正则，如果是全部匹配，入参可以配置为：* |
except-path-pattern | String | 否 | 例外的url匹配模式，某些URL除外：如abc.jpg，不做内容重定向 客户入参参考：^https?://[^/]+/.*\.m3u8 |
custom-pattern | String | 否 | 指定常用类型：选择缓存域名的是全部文件还是首页。入参参考值： all：全部文件 homepage：首页 |
file-type | String | 否 | 文件类型：指定需要缓存的文件类型。 文件类型包括：gif png bmp jpeg jpg html htm shtml mp3 wma flv mp4 wmv zip exe rar css txt ico js swf 如果需要全部类型，则直接传all。多个以分号隔开，all和具体文件类型不能同时配置。 |
custom-file-type | String | 否 | 自定义文件类型：在指定文件类型外根据自身需求，填写适当的可识别文件类型。可以搭配file-type使用。如果file-type也有配置，实际生效的文件类型是两个入参的总和 |
specify-url-pattern | String | 否 | 指定URL缓存：根据需求指定url进行缓存 入参不支持含http(s):// 开头的URI格式 |
directory | String | 否 | 目录：指定目录缓存。 输入合法的目录格式。多个以英文分号隔开 |
cache-ttl | String | 是 | 缓存时间：设置缓存对象对应的时间 入参格式：整数加单位，比如20s、30m、1h、2d，不缓存设置为0。不输入单位默认是秒 缓存时间理论上没有上限限制，这个时间根据客户自身的需求设定，如果客户觉得其中一些文件，变更不频繁，那么就设置长一点。例如，文本类的js，css，html等可以设置得短一些，图片、视频音频类的可以设置的长一点（因为缓存时间会因文件热度算法，旧文件会被新文件替换掉，最长建议不要超过一个月） |
ignore-cache-control | String | 否 | 忽略源站不缓存头。可选值为true和false，用于忽略请求头中cache-control的两种配置（private，no-cache）和客户端设置的Authorization。 ture表示会忽略掉源站对于这三者的设定。使得资源能够以cache-control: public的方式缓存在服务节点上，然后我们的节点才能缓存这种类型的资源，提供加速服务。 false表示当源站对某种资源设定了cache-control: private,cache-control:no-cache或指定根据authorization进行缓存时，我们的服务节点将不会对此类文件进行缓存。 |
is-respect-server | String | 否 | 尊重服务端：加速是否要按源站缓存时间优先。 可选值：true和false true：表示重服务端时间优先 false:CDN配置的缓存时间优先 |
ignore-letter-case | String | 否 | 忽略大小写，可选值为true或false，true表示忽略大小写；false表示不忽略大小写； 新增配置项时，不传默认为 true |
reload-manage | String | 否 | reload处理规则，可选项：ignore或者if-modified-since if-modified-since：表示要转成if-modified-since ignore:表示忽略客户端刷新 |
priority | String | 是 | 表示客户多组重定向内容的优先执行顺序。数字越大，优先级越高。 新增配置项时，不传默认为 10 如果传了值，不能为空 |
ignore-authentication-header | String | 否 | 忽略鉴权头部Authentication，可选值为true和false。默认为不忽略。 |
返回参数
Body 参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
preDeployId | String | 预部署任务的id，可以根据这个id查询预部署的进展和结果 |
示例
JSON
- 请求示例 复制成功
#!/bin/bash username="example_username" apiKey="example_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/api/predeploy/cachetime/123344" \ -X "PUT" \ -u "$username:$password" \ -H "Date: $date" \ -H "Accept: application/json" \ -H "Content-Type:application/json" \ -d '{ "cache-time-behaviors": [ { "path-pattern": ".*", "cache-ttl": "30s", "ignore-cache-control": "true", "is-respect-server": "false", "ignore-letter-case": "true", "reload-manage": "ignore", "priority": "10" }, { "path-pattern": ".*", "cache-ttl": "30s", "ignore-cache-control": "false", "is-respect-server": "true", "ignore-letter-case": "true", "reload-manage": "if-modified-since", "priority": "10" } ] }'- 返回示例 复制成功
HTTP/1.1 202 Accepted Server: openresty/1.11.2.2 Date: Mon, 27 May 2019 10:45:36 GMT Content-Type: application/json;charset=utf-8 Content-Length: 50 Connection: keep-alive App-Name: service_confApi x-cnc-request-id: c348cb81-dbef-459d {"preDeployId":"66201667e7424820b9e359671178757c"}
本篇文档内容对您是否有帮助？
有帮助
我要反馈