4.2 域名配置
4.2.20 修改域名全量配置接口
"http2" : 0,
"cert_name" : "cdn_test",
"certificate" : "---BEGIN CERTIFICATE---XX---END CERTIFICATE---", "private_key" : null,
"certificate_type" : 0,
"expiration_time" : 1606187416000, "domain_id" : "3e****************************63", "domain_name" : "www.example.com"
} ] }
状态码
状态码 描述
200 OK
错误码
请参见错误码。
4.2.20 修改域名全量配置接口
功能介绍
修改域名全量配置接口,支持配置回源请求头、http header配置、url鉴权
调试
您可以在API Explorer中调试该接口。
URI
PUT /v1.1/cdn/configuration/domains/{domain_name}/configs
表4-166 路径参数
参数 是否必选 参数类型 描述
domain_name 是 String 加速域名
表4-167 Query 参数
参数 是否必选 参数类型 描述
enterprise_pro
ject_id 否 String 当用户开启企业项目功能时,该
参数生效,表示查询资源所属项 目,不传表示查询默认项目。注 意:当使用子账号调用接口时,
该参数必传。
请求参数
表4-168 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。
通过调用IAM服务获取用户 Token接口获取(响应消息头中 X-Subject-Token的值)。
表4-169 请求 Body 参数
参数 是否必选 参数类型 描述
configs 否 Configs
object 配置项。
表4-170 Configs
参数 是否必选 参数类型 描述
origin_request
_header 否 Array of OriginReques tHeader objects
回源请求头配置
http_response
_header 否 Array of HttpRespons eHeader objects
http header配置
url_auth 否 UrlAuth
object url鉴权 https 否 HttpPutBody
object 证书设置
表4-171 OriginRequestHeader
参数 是否必选 参数类型 描述
name 是 String 设置回源请求头参数。格式要
求:长度1~64,由数字,大小 写字母,中划线-组成。
value 否 String 设置回源请求头参数的值。当为
删除动作时,可不填。格式要 求:长度1~512。不支持中文,
不支持变量配置,如:
$client_ip,$remote_port等。
action 是 String 回源请求头设置类型。delete:
删除,set:设置。同一个请求 头字段只允许删除或者设置。设 置:若原始回源请求中不存在该 字段,先执行新增再执行设置。
表4-172 HttpResponseHeader
参数 是否必选 参数类型 描述
name 是 String 设置HTTP响应头参数。取值:
"Content-Disposition",
"Content-Language", "Access- Control-Allow-Origin","Access-Control-Allow-Methods",
"Access-Control-Max-Age",
"Access-Control-Expose-Headers"或自定义头部。格式 要求:长度1~100,以字母开 头,可以使用字母、数字和短横 杠。
value 否 String 设置HTTP响应头参数的值。自
定义HTTP响应头参数长度范围 1~256,支持字母、数字和特定 字符(.-_*#!%&+|
^~'"/:;,=@?)。
action 是 String 设置http响应头操作类型,取值
“set/delete”。set代表设置,
delete代表删除。
表4-173 UrlAuth
参数 是否必选 参数类型 描述
status 是 String A/B/C类防盗链开关
("off"/"on")。
type 否 String 鉴权方式 type_a:鉴权方式A
type_b:鉴权方式B type_c1:
鉴权方式C1 type_c2:鉴权方式 C2
key 否 String 鉴权密钥由6 - 32位大小写字
母、数字构成。
time_format 否 String 时间格式 dec:十进制 hex:十 六进制 鉴权方式A:只支持十进 制 鉴权方式B:只支持十进制 鉴权方式C1:只支持十六进制 鉴权方式 鉴权方式C2:支持十 进制/十六进制
expire_time 否 Integer 过期时间:范围:0-31536000 单位为秒。
表4-174 HttpPutBody
参数 是否必选 参数类型 描述
https_status 否 String HTTPS证书是否启用。(on:
开启,off:关闭)
certificate_na
me 否 String 证书名字。(长度限制为3-32字
符)。当证书开启时必传。
certificate_val
ue 否 String HTTPS协议使用的证书内容,当
证书开启时必传。取值范围:
PEM编码格式。
private_key 否 String HTTPS协议使用的私钥,当证书 开启时必传。取值范围:PEM编
http2_status 否 String 是否使用HTTP2.0。(on:是,
off:否。),默认关闭,
https_status=off时,该值不生 效。
响应参数
无
请求示例
{ "configs" : {
"origin_request_header" : [ { "name" : "test_name", "value" : "test_value", "action" : "set"
} ],
"http_response_header" : [ { "name" : "test_name", "value" : "test_value", "action" : "set"
} ],
"url_auth" : { "stauts" : "off"
} }}
响应示例
无
状态码
状态码 描述
204 请求成功
错误码
请参见错误码。