文档首页> 内容分发网络 CDN> API参考> API> 域名配置> 修改域名全量配置接口
更新时间:2022-05-18 GMT+08:00
分享

修改域名全量配置接口

功能介绍

修改域名全量配置接口,支持配置回源请求头、http header配置、url鉴权

调试

您可以在API Explorer中调试该接口。

URI

PUT /v1.1/cdn/configuration/domains/{domain_name}/configs

表1 路径参数

参数

是否必选

参数类型

描述

domain_name

String

加速域名

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

当用户开启企业项目功能时,该参数生效,表示查询资源所属项目,不传表示查询默认项目。注意:当使用子账号调用接口时,该参数必传。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表4 请求Body参数

参数

是否必选

参数类型

描述

configs

Configs object

配置项。

表5 Configs

参数

是否必选

参数类型

描述

origin_request_header

Array of OriginRequestHeader objects

回源请求头配置

http_response_header

Array of HttpResponseHeader objects

http header配置

url_auth

UrlAuth object

url鉴权

https

HttpPutBody object

证书设置

sources

Array of SourcesConfig objects

源站配置。

origin_protocol

String

回源协议(follow:协议跟随回源,http:HTTP回源(默认),https:https回源)。

force_redirect

ForceRedirectConfig object

强制重定向。

compress

Compress object

智能压缩。

表6 OriginRequestHeader

参数

是否必选

参数类型

描述

name

String

设置回源请求头参数。格式要求:长度1~64,由数字,大小写字母,中划线-组成。

value

String

设置回源请求头参数的值。当为删除动作时,可不填。格式要求:长度1~512。不支持中文,不支持变量配置,如:$client_ip,$remote_port等。

action

String

回源请求头设置类型。delete:删除,set:设置。同一个请求头字段只允许删除或者设置。设置:若原始回源请求中不存在该字段,先执行新增再执行设置。

表7 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代表删除。

表8 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单位为秒。

表9 HttpPutBody

参数

是否必选

参数类型

描述

https_status

String

HTTPS证书是否启用。(on:开启,off:关闭)

certificate_name

String

证书名字。(长度限制为3-32字符)。当证书开启时必传。

certificate_value

String

HTTPS协议使用的证书内容,当证书开启时必传。取值范围:PEM编码格式。

private_key

String

HTTPS协议使用的私钥,当证书开启时必传。取值范围:PEM编码格式。

certificate_source

Integer

证书来源。1:代表华为云托管证书;0:表示自有证书。 默认值0。当证书开启时必传。

http2_status

String

是否使用HTTP2.0。(on:是,off:否。),默认关闭,https_status=off时,该值不生效。

表10 SourcesConfig

参数

是否必选

参数类型

描述

origin_addr

String

源站IP或者域名。

origin_type

String

源站类型("ipaddr":"IP源站","domain":"域名源站","obs_bucket":"OBS Bucket源站")。

priority

Integer

源站优先级(70:主,30:备)。

obs_web_hosting_status

String

是否开启Obs静态网站托管,源站类型为obs_bucket时传递(off:关闭,on:开启)。

http_port

Integer

HTTP端口,默认80。

https_port

Integer

HTTPS端口,默认443。

host_name

String

回源HOST,默认加速域名。

表11 ForceRedirectConfig

参数

是否必选

参数类型

描述

status

String

强制跳转开关(on:打开,off:关闭)。

type

String

强制跳转类型(http:强制跳转HTTP,https:强制跳转HTTPS)。

表12 Compress

参数

是否必选

参数类型

描述

status

String

智能压缩开关(on:开启,off:关闭)。

type

String

智能压缩类型(gzip:gzip压缩,br:br压缩)。

响应参数

请求示例

{
  "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" : {
      "status" : "off"
    },
    "compress" : {
      "status" : "off"
    },
    "force_redirect" : {
      "status" : "on",
      "type" : "http"
    },
    "origin_protocol" : "follow",
    "sources" : [ {
      "origin_addr" : "1.1.1.1",
      "origin_type" : "ipaddr",
      "priority" : 70,
      "weight" : 50,
      "http_port" : 80,
      "https_port" : 443
    } ]
  }
}

响应示例

状态码

状态码

描述

204

请求成功

错误码

请参见错误码

分享:

    相关文档

    相关产品

close