CDN加速

文档中心 API文档 域名配置 查询http头配置接口

查询http头配置接口

更新时间:2020-11-16 16:51:42
适用产品:网页加速、下载加速、全站加速、点播加速、直播加速、移动加速、云存储

接口描述

通过接口自助查询http头部配置。接口url的*可为域名名称或域名id。

请求参数

参数名称类型必填描述
domain-name/domain-idString需要查询配置的域名或域名id

返回参数

参数名称类型描述
header-modify-rulescomplexhttp头设置 注意: 1、需要取消http头设置时,可以传入空节点<header-modify-rules></header-modify-rules>。 2、表示需要设置http头,此项必填
header-modify-rulecomplexhttp头设置 注意: 1、表示一组http头设置 2、当其他配置项都是没有入参时,data-id必填,且值为实际存在的data-id,表示清空这个data-id对应配置项的值
data-idInt添加grid类型标识,表示客户多组配置时,具体某组配置
path-patternStringurl匹配模式,支持正则,如果是全部匹配,入参可以配置为:.*
header-directionStringhttp头的控制方向,可选值为cache2visitor/cache2origin/visitor2cache/origin2cache,单选。  cache2origin是指回源方向---对应配置项回源请求;  cache2visitor是指回客户端方向—对应配置项回客户端应答; visitor2cache是指接收客户端请求 origin2cache是指接收源应答
actionStringhttp头的控制类型,支持http头部值的增改删,可选值为add|delete|set,单选。对应header-name、header-value参数 add:新增头部 set:修改头部 delete:删除头部 注意:优先级顺序为delete>set>add
allow-regexpStringhttp头正则匹配,可选值:true/false。 true:表示对header-name的值按正则匹配方式处理 false:表示对header-name的值按实际入参处理,不做正则匹配。 不传默认是false
header-nameStringhttp头名称,新增或修改http头,只允许输入一个;删除http头允许输入多个,以分号“;”隔开。 注意:对特殊http头的操作是受限的,允许操作的http头及操作类型参看 此项为必填项,不能为空 当action为add:表示新增这个header-name头部 当action为set:修改这个header-name头部 当action为delete:删除这个header-name头部
header-valueStringhttp头域对应的值,例如:mytest.example.com 注意: 1、当action为add或set时,该入参必须传值 2、当action为delete时,该入参不用传 支持通过关键字获取指定变量值,如客户端ip,包含如下: 关键字:含义 #timestamp :当前时间,时间戳如1559124945 #request-host:请求头中的HOST #request-url :请求url,包含协议域名等的全路径,如http://aaa.aa.com/a.html #request-uri :请求uri,相对路径格式,如/index.html #origin-ip :回源IP #cache-ip :边缘节点IP #server-ip :对外服务IP #client-ip :客户端IP,即访客IP #response-header{xxx}:获取响应头中的值,如#response-header{etag},获取response-header中的etag值 #header{xxx}:获取请求的http header中的值,如#header{User-Agent},是获取header中的User-Agent值 #cookie{xxx}:获取cookie中的值,如#cookie{account},是获取cookie中设置的account的值  
request-headerString匹配请求头,头部值支持正则,头和头部值用空格隔开,如:Range bytes=[0-9]{9,}

示例

示例说明
请求示例
复制
#!/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/headermodify/www.example.com" \
-X "GET" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-H "Content-Type:application/json"
返回示例
复制
HTTP/1.1 200 OK
Date: Sun, 05 May 2019 09:08:53 GMT
Content-Type: application/json;charset=utf-8
x-cnc-request-id: 83bbebc7-2c95-47d7
{
    "domain-id":"123344",
    "domain-name":"www.example.com",
    "header-modify-rules":[
                    {
                    "path-pattern": ".*",
                    "request-header": "My-Http-Header .",
                    "header-direction": "cache2visitor",
                    "action": "add",
                    "header-name": "My-Http-Header",
                    "header-value": "#header{My-Http-Header}"
          },
                    {
                    "path-pattern": "/def",
                    "header-direction": "cache2visitor",
                    "action": "set",
                    "header-name": "Server",
                    "header-value": "my_new_value"
          },
                    {
                    "path-pattern": "/abc",
                    "header-direction": "cache2visitor",
                    "action": "delete",
                    "header-name": "Via"
          }
]
}