正则URL刷新
更新时间：2022-12-13 14:14:41
适用产品
内容管理
接口描述
根据正则url方式清理CDN节点上缓存的文件内容
- 调用URL： https://open.chinanetcenter.com/api/content/regular-url/purge
- 调用方法：POST
- 限制说明：数据格式：请求和响应都仅支持json 使用建议：如果是相同的正则url请等待前一个清理缓存完成后才允许提交。过高的刷新频率会影响内容管理系统的性能。 每日(东八区的时间）使用量：默认500。
推荐使用 Open API在线调试
Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试
请求参数
Body 参数
| 参数名称 | 描述 |
|---|---|
urlRegularsList | 要清理缓存的正则url集合，正则url的格式要求：
1）URL 符合正则表达式，输入示例：http://www.a.com/(.*).png。如要推送 http://www.abc.com/test/.*\.txt 正则表达式，在使用接口需要对反斜杠进行转义，即 http://www.abc.com/test/.*\.txt。
2）每个正则url所在的域名必须是在我司加速的域名。
3）每个正则url最大长度 2000 字符。
4）正则url中如果包含特殊字符，需要进行转义，采用utf-8方式转义
5) 相同的正则URL，系统会去重后提交。
6）默认500条/天。 |
返回参数
Body 参数
| 参数名称 | 描述 |
|---|---|
CodeString | 表示任务创建结果的状态码 |
MessageString | 表示任务提交后，系统的响应消息 |
itemIdString | 调用一次接口并提交任务成功后，将返回一个iteamId，是当次提交任务的唯一标识，通过itemId可批量查询任务的状态（成功/失败）。 |
错误码
| 错误代码（code） | 描述（message） | HTTP状态码 | 语义 |
|---|---|---|---|
| Success | handle success | 200 | 任务提交成功 |
| UserNameInvalid | username is invalid | 400 | 用户名为空或用户未启用 |
| ParseParameterError | parse parameter json error | 400 | 解析json出错 |
| UrlRegularEmpty | url regular must not be empty | 400 | 正则url表达式不允许为空 |
| OnceSubmitLessThan500 | you can't submit more than 500 url regulars at a time | 400 | 一次提交url个数不能超过500个 |
| NumberOutOfLimit | the number of url regular out of today limit(500) | 400 | 正则url数目总和超过每日上限（500） |
| NumberOutOfLimit | the number of url regular out of today limit(500) | 400 | 若传入的头部带时区，那么提示包含对应时区的时间区间，例如 the number of url regular out of 2018-10-17 01:00:00GMT+09:00~2018-10-18 00:59:59GMT+09:00 limit(500) |
| NumberPartlyOutOfLimit | [userName]: url regular can only purge [{1}] count this time. Today has purge the number of url regular: [{2}] | 400 | 提交的url正则部分超过上限了，未超过的可以正常执行，若传入的头部带时区，那么提示包含对应时区的时间区间，例如 [userName]: url regular can only purge [1] count this time. 2018-10-17 01:00:00GMT+09:00~2018-10-18 00:59:59GMT+09:00 has purge the number of url regular: [2]. |
| RepeatUrlRegular | running url regular[xxx], please try again after one minute. | 400 | 正在运行url正则[xxx]，请一分钟后再试. |
| UserNotAllowedPush | user not allowed push | 400 | 用户不允许推送 |
| ErrorChannel | error channel [xxx,xxx]. | 400 | 错误的频道，（部分错误，正确的正则url仍会执行） |
| InvalidUrlRegular | invalid url regular [url1,url2]. | 400 | 错误的url，（部分错误，正确的正则url仍会执行） |
| SystemException | system exception | 500 | 系统内部异常 |
示例
JSON
- 请求示例 复制成功
#!/bin/bash username="username_exmaple" apiKey='apiKey_exmaple' 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/content/regular-url/purge" \ -X "POST" \ -u "$username:$password" \ -H "Date:$date" \ -H "Content-Type: application/json" \ -d'{ "urlRegulars":[ "http://www.abc.com/test/.*\.txt", "http://www.abc.com/test/.*\.png" ] }'- 返回示例 复制成功
{ "Code":Success, "Message":"handle success", "itemId":"64ec364dd81d4052a3534c1e86167950" }
本篇文档内容对您是否有帮助？
有帮助
我要反馈