CDN加速

文档中心 API文档 域名配置 修改查询串设置配置

修改查询串设置配置

更新时间:2021-02-05 10:38:28
适用产品:网页加速、下载加速、全站加速、点播加速、直播加速、移动加速

接口描述

通过接口自助实现查询串设置功能

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

请求参数

参数名称类型必填描述
query-string-settingsComplex查询串设置配置,父标签 1.需要设置查询串配置时,此项必填 2.为<query-string-settings/>时清空查询串设置的配置
query-string-settingComplex查询串设置,父标签,可配置多条规则
path-patternStringurl匹配模式,支持正则,如果是全部匹配,入参可以配置为:.* 注:url匹配模式、文件类型(自定义文件类型)、常用类型、指定url、目录,有且仅有一项必填
file-typesString文件类型:指定文件类型进行防盗链设置。可选文件类型包括:gif png bmp jpeg jpg html htm shtml mp3 wma flv mp4 wmv zip exe rar css txt ico js swf m3u8 xml f4m bootstarp ts 如果需要全部类型,则直接传all。多个以分号隔开,all和具体文件类型不能同时配置
custom-file-typesString自定义文件类型:在指定文件类型外根据自身需求,填写适当的可识别文件类型。可以搭配file-type使用。如果file-type也有配置,实际生效的文件类型是两个入参的总和
custom-patternString常用类型:可选值为homepage和all all:全部文件 homepage:首页
specify-url-patternString指定url,非http(s):// 开头,多个以换行分隔
directoriesString目录,可输入合法的目录格式。以/开头和结尾,多个以分号隔开。
priorityInt优先级,表示客户多组配置的优先执行顺序。数字越大,优先级越高。不传默认为10,不可清空。
ignore-letter-caseBoolean是否忽略大小写:允许值为true和false,默认为忽略
ignore-query-stringBoolean缓存是否忽略查询串,允许值为true和false。 true表示忽略查询串,相同拷贝;false表示不忽略,分别缓存,即带全部参数缓存。
query-string-keptString缓存保留参数,指定保留的参数值相同,则缓存一份。 注: 1.query-string-kept和query-string-removed两者互斥,只能一个有值。 2.query-string-kept和ignore-query-string两者互斥,只能一个有值。
query-string-removedString缓存删除参数,删除指定的参数后,其余参数值相同,则缓存一份。 1.query-string-kept和query-string-removed两者互斥,只能一个有值。 2.query-string-removed和ignore-query-string两者互斥,只能一个有值。
source-with-queryBoolean是否用原始url回源,允许值为true和false。 ignore-query-string为true或未设置时,source-with-query为true表示按原始请求回源;为false表示去问号回源。 ignore-query-string为false时,此项默认设置为空(输入无效)。
data-idInt配置多组配置时,具体某组配置的id。data-id可以通过查询接口获取。 注意: a、如果有传data-id,说明指定修改其中一组配置项内容,不需求修改其他组配置内容不需要入参; b、如果入参多组配置,其中有些组配置有传data-id,有些没有传,则有传data-id的表示修改具体某组配置,没有传data-id的表示在原来基础上新增一组配置; c、如果入参都没有传data-id,表示用本次的配置全量覆盖原先配置; d、如果入参没有传任何配置项参数,只传了域名和二级标签,表示清空这个接口对应域名二级服务所有配置; e、如果一组配置没有具体的配置项,则data-id必填,且值为实际存在的data-id,表示清空这个data-id对应配置项的值;不允许一组配置没有具体的配置项也没有data-id。

返回参数

参数名称类型描述
http status codeinthttpstatus=202;   表示成功调用新增域名接口,可使用header中的x-cnc-request-id查看当前新增域名的部署情况
x-cnc-request-idString唯一标示的id,用于查询每次请求的任务 (适用全部接口)
codeString错误代码,当HTTPStatus不为202时出现,表示当前请求调用的错误类型
messageString响应信息,成功时为success

示例

示例说明
请求示例
复制
#!/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/querystring/123344" \
-X "PUT" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-H "Content-Type:application/json" \
-d '
{
 "query-string-settings":[
 {
 "path-pattern":"/test1/.*",
 "ignore-letter-case":"true",
 "ignore-query-string":"true",
 "source-with-query":"true"
 },{
 "specify-url-pattern":"/test2/specifyurl",
 "ignore-letter-case":"true",
 "query-string-kept":"lang"
}
]
}'
返回示例
复制
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"}