设置HttpHeader
更新时间:2024-06-04
本接口用于指定加速域名添加或者删除http header。此域名必须是本用户的,否则会返回403失败。
注意:此接口为全量接口,设置时需要将已有的Header设置也要一并写入,否则原有配置会被覆盖。
Method | Path | 说明 |
---|---|---|
PUT | /v2/domain/{domain}/config?httpHeader | 修改或删除加速域名对应的回源Header或响应Header |
请求体(Request Body)
参数 | 可选 | 类型 | 说明 |
---|---|---|---|
httpHeader | 必选 | HttpHeader | 设置的回源或响应Header |
HttpHeader结构如下:
参数 | 可选 | 类型 | 说明 |
---|---|---|---|
type | 必选 | String | "origin"表示此header 回源生效,"response"表示给用户响应时生效 |
header | 必选 | String | header为http头字段,一般为HTTP的标准Header,也可以是用户自定义的;如x-bce-authoriztion |
value | 必选 | String | 指定header的值。可支持有限个数的变量,字符$开始的子串一定要有其一符合 ${x} 的模式,且x必须与以下字符串之一相等:uri、host、scheme、request_uri、request_id 和 bd_cache_status。典型非法值:1、变量不符合限制要求,如"X-REQ-${url}",我们定义的合法变量里没有url;2、包含$字符但不符合${x}模式,如:"X-REQ-$uri"。 注意:value不支持$纯字符的传递,如果您希望响应客户端一个包含$符号的响应头将不被允许,如"X-$"是非法的。 其中,bd_cache_status 表示请求是否命中CDN缓存,其值为 "HIT" 或者 "MISS"。 |
action | 可选 | String | 表示是删除还是添加,可选remove/add,默认是add |
describe | 可选 | String | 描述,可选,可以是中文,统一使用Unicode统码;长度不能超过100个字符 |
说明:
add origin header: 回源时在用户的请求中自动加上指定的http header
remove origin header: 回源时从用户的请求中自动删除指定的http header
add response header: 响应用户的请求时自动加上指定的http header
remove response header: 响应用户的请求时自动删除指定的http header
响应码 (Http Status Code)
Http Status Code | 说明 |
---|---|
200 | 成功 |
响应体 (Response Body)
参数 | 类型 | 说明 |
---|---|---|
status | String | 因更新动作是异步调用,故成功后返回的status是OPERATING,目标状态为RUNNING |
请求示例
PUT /v2/domain/myself.baidu.com/config?httpHeader HTTP/1.1
Host: myself.baidu.com
Content-Length: 145
Content-Type: application/json
{
"httpHeader":
[
{"type": "origin", "header": "x-auth-cn", "value":"xxxxxxxxx", "action": "add"},
{"type": "response", "header": "content-type", "value":"application/octet-stream", "action": "add"}
]
}
响应示例
HTTP/1.1 200 OK
Content-Length: 31
Content-Type: application/json;utf-8
{
"status": "OPERATING|RUNNING"
}