文档中心 API文档 修改忽略协议缓存和推送配置

修改忽略协议缓存和推送配置

更新时间:2022-09-06 17:04:52

适用产品

应用安全加速解决方案、IPv6一体化解决方案、电商安全加速解决方案、金融安全加速解决方案、政企安全加速解决方案、应用安全解决方案、区块链安全加速解决方案、IPv6安全加速解决方案、点播分发、直播分发、移动加速、网页加速、下载分发、全站加速

接口描述

通过接口自助修改忽略协议缓存和推送配置

  • 调用URL: https://open.chinanetcenter.com/api/config/ignoreprotocol/*
  • 调用方法:PUT
  • 限制说明:· 加速域名必须已备案完成。 · 加速域名必须不包含如下信息:出售药物和管制刀具类,含有不法言论、信息。 · 视频类加速域名必须有视听许可证;博客论坛或社区类加速域名必须有BBS专项审批资质。 · 接口请求和返回结果接受xml和json格式。

请求参数

Body 参数

XML
参数名称类型必填描述
ignore-protocol-rules
Complex忽略协议缓存和推送配置,父标签 1.需要设置忽略协议缓存和推送配置时,此项必填 2.为时清空忽略协议缓存和推送的配置
ignore-protocol-rule
Complex忽略协议缓存和推送配置,父标签,可配置多条规则
path-pattern
Stringurl匹配模式,支持正则,如果是全部匹配,入参可以配置为:.*
except-path-pattern
String例外的url匹配模式,格式同path-pattern
cache-ignore-protocol
Boolean是否忽略协议缓存,允许值为true和false。为true则开启http/https共用缓存。默认不开启。
purge-ignore-protocol
Boolean是否忽略协议推送,允许值为true和false。为true则推送时忽略协议;为false则区分协议推送。 建议和cache-ignore-protocol配套使用,避免推送失效。 注意: 1.一旦配置,则全局生效,不针对匹配的path-pattern生效。 2.目录推送不区分协议,url推送可区分协议 3、如果【是否忽略协议缓存】为true,【是否忽略协议推送】必须为true
data-id
Int配置多组配置时,具体某组配置的id

返回参数

Body 参数

XML&JSON
参数名称类型描述
http status code
Inthttpstatus=202;   表示成功调用新增域名接口,可使用header中的x-cnc-request-id查看当前新增域名的部署情况
x-cnc-request-id
String唯一标示的id,用于查询每次请求的任务 (适用全部接口)
Location
String用于访问该域名信息的URL,其中domain-id为我司云平台为该域名生成的唯一标示,其值为字符串。
code
String错误代码,当HTTPStatus不为202时出现,表示当前请求调用的错误类型
message
String响应信息,成功时为success

示例

JSON
XML
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/config/ignoreprotocol/123344" \
-X "PUT" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-H "Content-Type:application/json" \
-d '
{
 "ignore-protocol-rules":[
 {
 "path-pattern":".*",
 "except-path-pattern":"",
 "cache-ignore-protocol":"true",
 "purge-ignore-protocol":"true"
 }
]
}'
返回示例
复制代码 复制成功
HTTP/1.1 202 Accepted
Date: Sun, 05 May 2019 09:08:53 GMT
Content-Type: application/json;charset=utf-8
x-cnc-request-id: 83bbebc7-2c95-47d7
{"message":"success","code":""}
本篇文档内容对您是否有帮助?
有帮助
没帮助
提交成功!非常感谢您的反馈,我们会继续努力做到更好!