文档中心 API文档 修改缓存key配置

修改缓存key配置

更新时间:2020-11-16 18:07:30

适用产品

网页加速、下载分发、动态加速、全站加速、点播分发、直播分发、上传加速、移动加速、上网加速、S-P2P、PCDN、应用性能管理、Web应用防火墙、BotGuard爬虫管理、WSS、DMS、DDoS云清洗、IPv6一体化解决方案、电商安全加速解决方案、金融安全加速解决方案、政企安全加速解决方案、应用安全解决方案、区块链安全加速解决方案、IPv6安全加速解决方案

接口描述

修改缓存key配置。接口url的*可为域名名称或域名id。

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

请求参数

Body 参数

JSON/XML
参数名称类型必填描述
cacheKeyRules
complex配置自定义缓存key功能。 1.需要设置自定义缓存key配置时,此项必填 2.为时清空自定义缓存key配置
cacheKeyRule
complex配置自定义缓存key
pathPattern
Stringurl匹配模式,支持正则,如果是全部匹配,入参可以配置为:.*
specifyUrl
String指定具体的uri,如/test/specifyurl
fullMatch4SpecifyUrl
Boolean是否完全匹配specifyUrl,可选择为true和false。 为true则完全匹配;为false则模糊匹配,如指定/test/uri,请求/test/uri?p=1也会匹配
customPattern
String指定常用类型:选择缓存域名的是全部文件还是首页。入参参考值: all:全部文件 homepage:首页
fileType
String文件类型:指定需要缓存的文件类型。 文件类型包括:gif png bmp jpeg jpg html htm shtml mp3 wma flv mp4 wmv zip exe rar css txt ico js swf 如果需要全部类型,则直接传all。多个以分号隔开,all和具体文件类型不能同时配置。
customFileType
String自定义文件类型:在指定文件类型外根据自身需求,填写适当的可识别文件类型。可以搭配file-type使用。如果file-type也有配置,实际生效的文件类型是两个入参的总和
directory
String目录:指定目录缓存。 输入合法的目录格式。多个以英文分号隔开
ignoreCase
Boolean是否忽略大小写:允许值为true和false,默认为忽略
headerName
String头部名称 例如:指定头部lang,lang的值一致则缓存一份
parameterOfHeader
String头部值的参数名, 例如:指定头部Cookie,头部值的参数名为name。则name的值一致则缓存一份。
priority
Int优先级,表示客户多组配置的优先执行顺序。数字越大,优先级越高。不传默认为10,不可清空。
dataId
Int配置多组配置时,具体某组配置的id。本功能只支持一组配置。dataId可以通过查询接口获取。 注意: a、如果有传dataId,说明指定修改该组配置项内容; b、如果入参都没有传dataId,表示用本次的配置全量覆盖原先配置; c、如果一组配置没有具体的配置项,则dataId必填,且值为实际存在的dataId,表示清空这个dataId对应配置项的值;不允许一组配置没有具体的配置项也没有dataId。

返回参数

Body 参数

HEADER
JSON/XML
HEADER
参数名称类型描述
http status code
Inthttpstatus=202; 表示成功调用新增域名接口,可使用header中的x-cnc-request-id查看当前新增域名的部署情况
x-cnc-request-id
String唯一标示的id,用于查询每次请求的任务 (适用全部接口)

错误码

错误代码(code)描述(message)HTTP状态码语义
26939999We encountered an system error. Please try again.500系统内部异常,请稍后重试
26938016This operation requires a body. Ensure that the body is present and the Content-Type header is set.400body内容为空
26938017The body of your HTTP request does not match with the content-type [xml/json].400请求报文与Content-Type描述不一致
26932001The specified domain does not exist.404域名资源项不存在
26932002customer not own domain name[XXX]400域名不属于该客户
26938003The config {0} does not access.400某个配置无法访问
26938005example: 1. No domain was specified. 2.The {0} is invalid.400指定入参格式错误

示例

更新请求示例-XML格式
更新示例- JSON格式
更新请求示例-XML格式
请求示例
复制代码 复制成功
#!/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/cachekey/123344" \
-X "PUT" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/xml" \
-H "Content-Type:application/xml" \
-d '<?xml version="1.0" encoding="utf-8"?>
  
<domain>
<cacheKeyRules>
  <cacheKeyRule>
   <pathPattern>.*</pathPattern>
   <ignoreCase>true</ignoreCase>
   <headerName>Cookie</headerName>
   <parameterOfHeader>name</parameterOfHeader>
  </cacheKeyRule>
  <cacheKeyRule>
   <specifyUrl>/test/specifyurl</specifyUrl>
   <ignoreCase>true</ignoreCase>
   <headerName>lang</headerName>
  </cacheKeyRule>
</cacheKeyRules>
</domain>'
返回示例
复制代码 复制成功
HTTP/1.1 202 Accepted
Date: Sun, 05 May 2019 09:08:53 GMT
Content-Type: application/xml;charset=utf-8
x-cnc-request-id: 83bbebc7-2c95-47d7
<?xml version="1.0" encoding="UTF-8"?>
<response>
  <code>0</code>
  <message>success</message>
  <data></data>
</response>
本篇文档内容对您是否有帮助?
有帮助
没帮助
提交成功!非常感谢您的反馈,我们会继续努力做到更好!