API名称：UpdateDomainConfig。 API域名：open.volcengineapi.com。 API描述：变更域名配置。 ## 请求说明 - 请求方式：**POST** - 请求地址：**https://open.volcengineapi.com?Action=UpdateDomainConfig&Version=2023-01-01** ## 请求参数 ### Query ```mixin-react const columns = [ { "title": "参数名称", "dataIndex": "name", "width": "20%" }, { "title": "数据类型", "dataIndex": "type", "width": "10%" }, { "title": "是否必选", "dataIndex": "required", "width": "10%" }, { "title": "参数说明", "dataIndex": "description", "width": "60%", "render": (val) => } ]; const data = [ { "name": "Action", "type": "String", "required": "是", "description": "接口名称。当前 API 的名称为 UpdateDomainConfig。", "key": "Action" }, { "name": "Version", "type": "String", "required": "是", "description": "接口版本。当前 API 的版本为 2023-01-01。", "key": "Version" } ]; return (); ``` ### Body ```mixin-react const columns = [ { "title": "参数名称", "dataIndex": "name", "width": "23%" }, { "title": "数据类型", "dataIndex": "type", "width": "10%" }, { "title": "是否必选", "dataIndex": "required", "width": "10%" }, { "title": "参数说明", "dataIndex": "title", "render": (val) => }, { "title": "示例", "dataIndex": "example", "width": "12%", "render": (val) => } ]; const data = [ { "name": "Domain", "key": "0-0", "title": "指定变更的域名", "example": "www.test.com", "required": "是", "type": "String" }, { "name": "Origin", "key": "0-1", "title": "源站配置。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "Origins", "key": "0-1-0", "title": "主源站列表，允许同时包含 IP 类与域名类的源站。最多配置 50 条记录。", "example": "", "required": "是", "type": "Object[]", "children": [ { "name": "Name", "key": "0-1-0-0", "title": "源站地址，需要与您设置的源站类型一致。", "example": "www.test.com", "required": "是", "type": "String" }, { "name": "Weight", "key": "0-1-0-1", "title": "权重，您可为源站设置权重，有效范围为 0 - 100。且所有源站的权重之和不为 0。", "example": "1", "required": "是", "type": "Integer" }, { "name": "Port", "key": "0-1-0-2", "title": "

您可自定义源站端口。如果您不指定端口，系统会自动根据您的回源协议选择默认端口。

回源协议为 HTTP 时：回源端口为 80。
回源协议为 HTTPS 时：回源端口为 443。

", "example": "80", "required": "否", "type": "Integer" }, { "name": "Type", "key": "0-1-0-3", "title": "

当您的源站列表同时存在 IP 类和域名类地址时（OriginType 为IP_Domain），需要设置该值为此源站地址对应的类型。

IP: IP 类源站
Domain: 域名类源站

", "example": "Domain", "required": "否", "type": "String" }, { "name": "Strategy", "key": "0-1-0-4", "title": "

当源站为域名时，您可自定义单源站策略。不填默认为轮询。

wrr：加权轮询。
optimum：择优。

", "example": "wrr", "required": "否", "type": "String" } ] }, { "name": "OriginSni", "key": "0-1-1", "title": "对于源站单 IP 多域名的场景，当回源协议为 HTTPS 时，需要指定源站 SNI 来指定具体访问的域名。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "Enable", "key": "0-1-1-0", "title": "

是否启用源站 SNI，默认不启用，取值：

true：启用。
false：不启用。

", "example": "false", "required": "是", "type": "Boolean" }, { "name": "SniInfo", "key": "0-1-1-1", "title": "SNI 地址。当 Enable 字段为 true 时，此选项必填。对于单 IP 多域名的场景，当回源协议为 HTTPS 时，需要指定回源 SNI 来指定具体访问的域名。", "example": "www.test.com", "required": "是", "type": "String" } ] }, { "name": "OriginRange", "key": "0-1-2", "title": "源站在收到全站加速节点回源请求时，根据 HTTP 请求头中的 Range 信息返回指定范围的数据给全站加速节点，提高大文件分发效率。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "Enable", "key": "0-1-2-0", "title": "

是否启用 Range 回源，默认不启用，取值：

true：启用。
false：不启用。

", "example": "false", "required": "是", "type": "Boolean" } ] }, { "name": "RequestHeader", "key": "0-1-3", "title": "回源请求头相关配置。全站加速回源时，会透传用户的请求头。该配置允许您自定义回源请求头设置，比如删除、添加、修改已有请求头的值。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "Enable", "key": "0-1-3-0", "title": "

是否启用，默认不启用，取值：

true：启用。
false：不启用。

", "example": "false", "required": "是", "type": "Boolean" }, { "name": "HeaderInfo", "key": "0-1-3-1", "title": "

作为响应头时：
\n当Enable字段为true时，此选项必填。当用户请求资源时，全站加速会在返回的响应数据中添加配置的头部，影响客户端程序（如浏览器）的响应行为。

\n作为请求头时：
\n回源请求头相关配置。当Enable字段为true时，此选项必填。全站加速回源时，会透传用户的请求头。该配置允许您自定义回源请求头设置，比如删除、添加、修改已有请求头的字段。", "example": "", "required": "是", "type": "Object[]", "children": [ { "name": "HeaderMode", "key": "0-1-3-1-0", "title": "

作为响应头时：
\n修改响应头的方式，支持参数：

0：ADD，添加响应头。
1：SET，设置已有的响应头。
2：DELETE，删除对应的响应头。

作为请求头时：
\n修改请求头的方式，支持参数：

0：ADD，添加请求头。
1：SET，设置已有的请求头。
2：DELETE，删除对应的请求头。

", "example": "2", "required": "是", "type": "Integer" }, { "name": "HeaderName", "key": "0-1-3-1-1", "title": "

作为响应头时：
\nResponseHeader 名称，具体规则如下：

名称不能重复。自定义头部名称值长度默认为1 - 100个字符，由数字0 - 9、字符a - z、A - Z，及特殊符 - 组成，连字符（-）不能出现在字符串的头部或者尾部。不能使用（x-bd）、（x-tt）作为开头。
ResponseHeader 忽略大小写后不能匹配（date）、（content-encoding）、（content-length）、（last-modified）、（content-range）、（set-cookie）、（vary）。

作为请求头时：
\nRequestHeader 名称，具体规则如下：

名称不能重复。自定义头部名称值长度默认为1 - 100个字符，由数字0 - 9、字符a - z、A - Z，及特殊符 - 组成，连字符（-）不能出现在字符串的头部或者尾部。不能使用（x-bd）、（x-tt）作为开头。
RequestHeader 忽略大小写后不能匹配（x-real-ip）、（x-forwarded-for）。

", "example": "Content-Type", "required": "是", "type": "String" }, { "name": "HeaderValue", "key": "0-1-3-1-2", "title": "

作为响应头时：
\nResponseHeader 取值。当修改响应头的方式为DELETE 时不生效，具体规则如下：

取值长度为1 - 1000个字符，不支持中文。
在变量模式下，HeaderValue只能在固定范围内填写：["uri", "request_uri", "remote_addr", "remote_port", "http_host", "args", "msec", "scheme"]。

作为请求头时：
\nRequestHeader 取值。当修改请求头的方式为DELETE 时不生效，具体规则如下：

取值长度为1 - 1000个字符，不支持中文。
在变量模式下，HeaderValue只能在固定范围内填写：["uri", "request_uri", "http_host", "args", "msec", "scheme", "args_string", "host", "client_ip", "remote_addr", "remote_port"]。

", "example": "image", "required": "是", "type": "String" }, { "name": "HeaderValueType", "key": "0-1-3-1-3", "title": "

作为响应头时：
\nheader填写HeaderValue中的值类型，支持取值：

v：变量，此模式下，HeaderValue只能在固定范围内填写变量名：["uri", "request_uri", "remote_addr", "remote_port", "http_host", "args", "msec", "scheme"]。
s或空值：表征字符固定值。

作为请求头时：
\nheader填写HeaderValue中的值类型，支持取值：

v：变量，此模式下，HeaderValue只能在固定范围内填写变量名：["uri", "request_uri", "http_host", "args", "msec", "scheme", "args_string", "host", "client_ip", "remote_addr", "remote_port"]。
s或空值：表征字符固定值。

", "example": "v", "required": "否", "type": "String" }, { "name": "AccessOriginControl", "key": "0-1-3-1-4", "title": "

表示在全站加速响应用户请求时，是否校验请求头中的 Origin 字段。
\n取值:

true: 表示全站加速会校验 Origin 字段。如果校验成功,内容分发网络会在响应头中包含Access-Control-Allow-Origin字段。字段值与Origin字段值相同。如果校验失败,响应头中不会包含Access-Control-Allow-Origin字段。
false: 表示全站加速不会校验Origin字段。在响应头中，全站加速会包含 Access-Control-Allow-Origin 字段。字段值是您配置的 Access-Control-Allow-Origin 的内容。

该参数的默认值是 false。
\n该参数仅在以下条件都满足的情况下有效:

HeaderMode: 0 或 1。
HeaderName: Access-Control-Allow-Origin。
HeaderValueType: s 或空值。

", "example": "true", "required": "否", "type": "Boolean" } ] } ] }, { "name": "OriginType", "key": "0-1-4", "title": "

主源站类型，取值：

IP：IP 源站。
Domain：域名源站。
IP_Domain：域名IP混合源站。
TOS：对象存储源站。
GA：GA源站。

", "example": "IP", "required": "是", "type": "String" }, { "name": "TosPrivateAccess", "key": "0-1-5", "title": "

OriginType 为 TOS 时，您可以设置源站是否为私有存储桶。您需要先授权 DCDN 访问该私有存储桶的权限后，才可开启此配置。取值：

true：启用。
false：不启用。

", "example": "false", "required": "否", "type": "Boolean" }, { "name": "OriginProtocolType", "key": "0-1-6", "title": "

回源协议，支持参数：

http：忽略客户端的请求方式，DCDN 会强制采用 HTTP 回源。
https：忽略客户端的请求方式，DCDN 会强制采用 HTTPS 回源。
follow：边缘节点的回源方式与客户端的请求协议保持一致。

", "example": "http", "required": "是", "type": "String" }, { "name": "BackupOrigins", "key": "0-1-7", "title": "备源站列表，支持同时包含 IP 类与域名类的源站，开启主备容灾时必填。最多配置 50 条记录。源站类型为 TOS 时，不支持备源站设置。", "example": "", "required": "否", "type": "Object[]", "children": [ { "name": "Name", "key": "0-1-7-0", "title": "源站地址，需要与您设置的源站类型一致。", "example": "www.test.com", "required": "是", "type": "String" }, { "name": "Weight", "key": "0-1-7-1", "title": "权重，您可为源站设置权重，有效范围为 0 - 100。且所有源站的权重之和不为0。", "example": "1", "required": "是", "type": "Integer" }, { "name": "Port", "key": "0-1-7-2", "title": "

您可自定义回源端口。不填时系统会自动根据您的回源协议填充。

回源协议为 HTTP 时：回源端口为80。
回源协议为 HTTPS 时：回源端口为443。

", "example": "80", "required": "否", "type": "Integer" }, { "name": "Type", "key": "0-1-7-3", "title": "当您的源站地址同时存在IP类型和域名类型时，需要设置该值为此源站地址对应的类型。", "example": "Domain", "required": "否", "type": "String" }, { "name": "Strategy", "key": "0-1-7-4", "title": "

当源站为域名时，您可自定义单源站策略。不填默认为轮询

wrr：加权轮询。
optimum：择优。

", "example": "wrr", "required": "否", "type": "String" } ] }, { "name": "BackupOriginType", "key": "0-1-8", "title": "

备源站类型，开启主备容灾时必填，支持参数：

IP：IP 源站。
Domain：域名源站。

", "example": "IP", "required": "否", "type": "String" }, { "name": "ResponseTimeout", "key": "0-1-9", "title": "回源超时时间，单位为秒，最大值为900。默认值为10。", "example": "10", "required": "否", "type": "Integer" }, { "name": "ResponseHeader", "key": "0-1-10", "title": "HTTP 相应头相关配置。当用户请求资源时，全站加速会在返回的响应数据中添加配置的头部字段，影响客户端程序（如浏览器）的响应行为。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "Enable", "key": "0-1-10-0", "title": "

是否启用，默认不启用，支持取值：

true：启用。
false：不启用。

", "example": "false", "required": "是", "type": "Boolean" }, { "name": "HeaderInfo", "key": "0-1-10-1", "title": "

作为响应头时：
\n当Enable字段为true时，此选项必填。当用户请求资源时，全站加速会在返回的响应数据中添加配置的头部，影响客户程序（如浏览器）的响应行为。

\n作为请求头时：
\n回源请求头相关配置。当Enable字段为true时，此选项必填。全站加速回源时，会透传用户的请求头。该配置允许您自定义回源请求头设置，比如删除，添加，或者修改已有请求头的值。", "example": "", "required": "是", "type": "Object[]", "children": [ { "name": "HeaderMode", "key": "0-1-10-1-0", "title": "

作为响应头时：
\n修改响应头的方式，支持参数：

0：ADD，添加响应头。
1：SET，设置已有的响应头。
2：DELETE，删除对应的响应头。

作为请求头时：
\n修改请求头的方式，支持参数：

0：ADD，添加请求头。
1：SET，设置已有的请求头。
2：DELETE，删除对应的请求头。

", "example": "2", "required": "是", "type": "Integer" }, { "name": "HeaderName", "key": "0-1-10-1-1", "title": "

作为响应头时：
\nResponseHeader 名称，具体规则如下：

名称不能重复。自定义头部名称值长度默认为1 - 100个字符，由数字0 - 9、字符a - z、A - Z，及特殊符 - 组成，连字符（-）不能出现在字符串的头部或者尾部。不能使用（x-bd）、（x-tt）作为开头。
ResponseHeader 忽略大小写后不能匹配（date）、（content-encoding）、（content-length）、（last-modified）、（content-range）、（set-cookie）、（vary）。

作为请求头时：
\nRequestHeader 名称，具体规则如下：

名称不能重复。自定义头部名称值长度默认为1 - 100个字符，由数字0 - 9、字符a - z、A - Z，及特殊符 - 组成，连字符（-）不能出现在字符串的头部或者尾部。不能使用（x-bd）、（x-tt）作为开头。
RequestHeader 忽略大小写后不能匹配（x-real-ip）、（x-forwarded-for）。

", "example": "Content-Type", "required": "是", "type": "String" }, { "name": "HeaderValue", "key": "0-1-10-1-2", "title": "

作为响应头时：
\nResponseHeader 取值。当修改响应头的方式为DELETE 时不生效，具体规则如下：

取值长度为1 - 1000个字符，不支持中文。
在变量模式下，HeaderValue只能是在固定范围内的变量名：["uri", "request_uri", "remote_addr", "remote_port", "http_host", "args", "msec", "scheme"]。

作为请求头时：
\nRequestHeader 取值。当修改请求头的方式为DELETE 时不生效，具体规则如下：

取值长度为1 - 1000个字符，不支持中文。
在变量模式下，HeaderValue只能是在固定范围内的变量名：["uri", "request_uri", "http_host", "args", "msec", "scheme", "args_string", "host", "client_ip", "remote_addr", "remote_port"]。

", "example": "image", "required": "是", "type": "String" }, { "name": "HeaderValueType", "key": "0-1-10-1-3", "title": "

作为响应头时：
\nheader填写HeaderValue中的值类型，支持取值：

v：变量，此模式下，HeaderValue只能在固定范围内填写：["uri", "request_uri", "remote_addr", "remote_port", "http_host", "args", "msec", "scheme"]。
s或空值：表征字符固定值。

作为请求头时：
\nheader填写HeaderValue中的值类型，支持取值：

v：变量，此模式下，HeaderValue只能在固定范围内填写：["uri", "request_uri", "http_host", "args", "msec", "scheme", "args_string", "host", "client_ip", "remote_addr", "remote_port"]。
s或空值：表征字符固定值。

", "example": "v", "required": "否", "type": "String" }, { "name": "AccessOriginControl", "key": "0-1-10-1-4", "title": "

表示在内容分发网络响应用户请求时,是否校验请求头中的Origin字段。
\n该参数有以下取值:

true: 表示内容分发网络会校验Origin字段。如果校验成功,内容分发网络会在响应头中包含Access-Control-Allow-Origin字段。字段值与Origin字段值相同。如果校验失败,响应头中不会包含Access-Control-Allow-Origin字段。
false: 表示内容分发网络不会校验Origin字段。在响应头中,内容分发网络会包含Access-Control-Allow-Origin字段。字段值是您配置的Access-Control-Allow-Origin的内容。

该参数的默认值是false。
\n该参数仅在以下条件都满足的情况下有效:

HeaderMode:0或1。
HeaderName: Access-Control-Allow-Origin。
HeaderValueType:s或空值。

", "example": "true", "required": "否", "type": "Boolean" } ] } ] }, { "name": "OriginHost", "key": "0-1-11", "title": "自定义回源访问的具体站点域名。源站获取资源的站点与加速域名的名称不一致时，您可以通过指定源站 HOST 来指明资源所在站点。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "Enable", "key": "0-1-11-0", "title": "

是否启用回源Host，默认不启用，但是源站类型为 TOS 时，默认启用。支持取值：

true：启用。
false：不启用。

", "example": "false", "required": "是", "type": "Boolean" }, { "name": "HostInfo", "key": "0-1-11-1", "title": "Host 地址。当Enable字段为true时，此选项必填。如果源站获取资源的站点与加速域名的站点不一致，您可以通过配置回源 HOST 指明资源所在站点。源站类型为 TOS 时，Host 地址默认为回源地址。", "example": "www.test.com", "required": "是", "type": "String" } ] }, { "name": "ConditionalOrigins", "key": "0-1-12", "title": "条件源站配置。", "example": "", "required": "否", "type": "Object[]", "children": [ { "name": "Name", "key": "0-1-12-0", "title": "必填，条件源站名称，同域名下需要不能重复，长度不能超过50。
\n条件源站名称标识着一组源站，修改时，需要携带该标识。", "example": "", "required": "是", "type": "String" }, { "name": "Origins", "key": "0-1-12-1", "title": "主源站列表，全站加速支持 IP 与域名源站混填，最多配置50条记录。", "example": "", "required": "是", "type": "Object[]", "children": [ { "name": "Name", "key": "0-1-12-1-0", "title": "回源地址，需要与您设置的源站类型一致。", "example": "www.test.com", "required": "是", "type": "String" }, { "name": "Weight", "key": "0-1-12-1-1", "title": "权重，您可为源站设置权重，有效范围为 0 - 100。且所有源站的权重之和不为0。", "example": "1", "required": "是", "type": "Integer" }, { "name": "Port", "key": "0-1-12-1-2", "title": "

您可自定义回源端口。不填时系统会自动根据您的回源协议填充。

回源协议为 HTTP 时：回源端口为80。
回源协议为 HTTPS 时：回源端口为443。

", "example": "80", "required": "否", "type": "Integer" }, { "name": "Type", "key": "0-1-12-1-3", "title": "当您的回源地址同时存在IP类型和域名类型时，需要设置该值为此回源地址对应的类型。", "example": "Domain", "required": "否", "type": "String" }, { "name": "Strategy", "key": "0-1-12-1-4", "title": "当源站为域名时，您可自定义单源站策略。不填默认为轮询", "example": "", "required": "否", "type": "String" } ] }, { "name": "BackupOrigins", "key": "0-1-12-2", "title": "备源站列表，全站加速支持 IP 与域名源站混填，开启主备容灾时必填。最多配置50条记录。源站类型为TOS时，不支持备源站设置。", "example": "", "required": "否", "type": "Object[]", "children": [ { "name": "Name", "key": "0-1-12-2-0", "title": "回源地址，需要与您设置的源站类型一致。", "example": "www.test.com", "required": "是", "type": "String" }, { "name": "Weight", "key": "0-1-12-2-1", "title": "权重，您可为源站设置权重，有效范围为 0 - 100。且所有源站的权重之和不为0。", "example": "1", "required": "是", "type": "Integer" }, { "name": "Port", "key": "0-1-12-2-2", "title": "

您可自定义回源端口。不填时系统会自动根据您的回源协议填充。

回源协议为 HTTP 时：回源端口为80。
Domain：回源协议为 HTTPS 时：回源端口为443。

", "example": "80", "required": "否", "type": "Integer" }, { "name": "Type", "key": "0-1-12-2-3", "title": "当您的回源地址同时存在IP类型和域名类型时，需要设置该值为此回源地址对应的类型。", "example": "Domain", "required": "否", "type": "String" }, { "name": "Strategy", "key": "0-1-12-2-4", "title": "

当源站为域名时，您可自定义单源站策略。不填默认为轮询。

wrr：加权轮询。
optimum：择优。

", "example": "", "required": "否", "type": "String" } ] }, { "name": "MatchingRuleGroup", "key": "0-1-12-3", "title": "匹配条件列表。", "example": "", "required": "是", "type": "Object", "children": [ { "name": "Logic", "key": "0-1-12-3-0", "title": "匹配条件间的关系，非必填，支持and(与关系)和or(或关系)，默认为and，在填写CriteriaGroup有效。", "example": "", "required": "否", "type": "String" }, { "name": "Criteria", "key": "0-1-12-3-1", "title": "匹配到该回源配置的详细条件配置，和CriteriaGroup互斥，二者只能填写一个。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "ArgType", "key": "0-1-12-3-1-0", "title": "

匹配类型，支持以下配置：

path：访问URL。
header：请求Header。
protocol_type：协议类型。
query：请求URL中的查询字符串。
file_suf：文件后缀。
file_name：文件名称。
cookie：请求携带的 Cookie。
client_ip：客户端 IP。
client_loc_province：客户端 IP 地理位置(支持选择国内省份)。
client_loc_country：客户端 IP 地理位置(支持选择国家)。
client_ip_version：客户端 IP 版本。
client_isp：客户端网络运行商。

", "example": "", "required": "是", "type": "String" }, { "name": "MatchType", "key": "0-1-12-3-1-1", "title": "匹配规则，必填，取值范围为：a(等于)、n_a(不等于)、c(包含任意一个)、n_c(不包含任意一个)、r(正则匹配到任意一个)、e(存在)、n_e(不存在)、gt(大于)、gte(大于等于)，lt(小于)、lte(小于等于)", "example": "", "required": "是", "type": "String" }, { "name": "IgnoreCase", "key": "0-1-12-3-1-2", "title": "

匹配时是否忽略大小写，默认不忽略，取值：

true：忽略。
false：不忽略。
\n只有在ArgType为path、header、protocol_type、query、file_suf、file_name、cookie时生效。

", "example": "", "required": "否", "type": "Boolean" }, { "name": "Name", "key": "0-1-12-3-1-3", "title": "需要匹配的名称，具体填写限制参考ArgType字段，长度不能超过200。", "example": "", "required": "否", "type": "String" }, { "name": "Values", "key": "0-1-12-3-1-4", "title": "需要匹配的值列表，必填，具体填写限制参考ArgType字段，长度不能超过200。", "example": "", "required": "是", "type": "String[]", "children": [] } ] }, { "name": "CriteriaGroup", "key": "0-1-12-3-2", "title": "匹配到该回源配置的嵌套条件配置，和Criteria互斥，二者只能填写一个。", "example": "", "required": "否", "type": "Object[]", "children": [ { "name": "Logic", "key": "0-1-12-3-2-0", "title": "匹配条件间的关系，非必填，支持and(与关系)和or(或关系)，默认为and，在填写CriteriaGroup有效。", "example": "", "required": "否", "type": "String" }, { "name": "Criteria", "key": "0-1-12-3-2-1", "title": "匹配到该回源配置的详细条件配置，和CriteriaGroup互斥，二者只能填写一个。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "ArgType", "key": "0-1-12-3-2-1-0", "title": "

匹配类型，支持以下配置：

path：访问URL。
header：请求Header。
protocol_type：协议类型。
query：请求URL中的查询字符串。
file_suf：文件后缀。
file_name：文件名称。
cookie：请求携带的 Cookie。
client_ip：客户端 IP。
client_loc_province：客户端 IP 地理位置(支持选择国内省份)。
client_loc_country：客户端 IP 地理位置(支持选择国家)。
client_ip_version：客户端 IP 版本。
client_isp：客户端网络运行商。

", "example": "", "required": "是", "type": "String" }, { "name": "MatchType", "key": "0-1-12-3-2-1-1", "title": "匹配规则，必填，取值范围为:a(等于),n_a(不等于), c(包含任意一个),n_c(不包含任意一个),r(正则匹配到任意一个),e(存在)，n_e(不存在),gt(大于)，gte(大于等于)，lt(小于)，lte(小于等于)", "example": "", "required": "是", "type": "String" }, { "name": "IgnoreCase", "key": "0-1-12-3-2-1-2", "title": "

匹配时是否忽略大小写，默认不忽略，取值：

true：忽略。
false：不忽略。
\n只有在ArgType为path、header、protocol_type、query、file_suf、file_name、cookie时生效。

", "example": "", "required": "否", "type": "Boolean" }, { "name": "Name", "key": "0-1-12-3-2-1-3", "title": "需要匹配的名称，具体填写限制参考ArgType字段，长度不能超过200。", "example": "", "required": "否", "type": "String" }, { "name": "Values", "key": "0-1-12-3-2-1-4", "title": "需要匹配的值列表，必填，具体填写限制参考ArgType字段，长度不能超过200。", "example": "", "required": "是", "type": "String[]", "children": [] } ] } ] } ] } ] }, { "name": "FollowRedirect", "key": "0-1-13", "title": "回源重定向跟随配置。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "Enable", "key": "0-1-13-0", "title": "

跟随重定向功能开关，默认不启用，支持取值：

true：启用。
false：不启用。

", "example": "true", "required": "是", "type": "Boolean" }, { "name": "MaxTries", "key": "0-1-13-1", "title": "当Enable字段为true时，此选项必填。重定向最大跟随次数，取值范围为1～5。默认值为3。", "example": "3", "required": "否", "type": "Integer" } ] }, { "name": "GAOriginProbe", "key": "0-1-14", "title": "

OriginType 为 GA 时，GA源站探测配置信息。

说明

GA 加速器作为源站时，全站加速允许开启 HTTP（S）可用性探测功能。开启此功能后，全站加速会探测您配置的域名地址，可及时感知到源站的异常，在源站异常时切换源站。同时还可以保证数据传输链路的性能最优。

", "example": "", "required": "否", "type": "Object", "children": [ { "name": "Enable", "key": "0-1-14-0", "title": "

OriginType 为 GA 时必填。仅在OriginType 为 GA 时生效。表示是否开启 GA 回源健康度探测配置，支持取值：

true：开启
false：不开启。

", "example": "false", "required": "否", "type": "Boolean" }, { "name": "Host", "key": "0-1-14-1", "title": "当Enable字段为true时，此选项必填。表示 GA 源站 URL 的域名部分，不允许填写特殊符号。", "example": "www.test.com", "required": "否", "type": "String" }, { "name": "Url", "key": "0-1-14-2", "title": "当Enable字段为true时，此选项必填。表示 GA 源站用来健康度检查的目标 URL 路径（不包含域名部分），不能填写特殊符号，必须使用/开头。", "example": "/dcdn", "required": "否", "type": "String" } ] }, { "name": "OriginIPv6", "key": "0-1-15", "title": "

IPv6 回源配置。

说明

您成功添加一个加速域名后，全站加速默认的回源方式是仅使用 IPv4 协议访问源站。
源站类型全部为 IP 地址时，至少有一个源站支持 IPv4 协议。
您必须开启 IPv6回源 功能后，选择一个回源方式，全站加速按照您配置的回源方式使用 IPv6 协议访问源站。

", "example": "", "required": "否", "type": "Object", "children": [ { "name": "Enable", "key": "0-1-15-0", "title": "

回源 IPv6 开关，默认不开启，取值：

true：开启。
false：不开启。

", "example": "", "required": "否", "type": "Boolean" }, { "name": "Strategy", "key": "0-1-15-1", "title": "

当Enable字段为true时，此选项必填。表示回源 IPv6 策略，取值：

ipv6_first：IPv6优先，边缘节点优先使用 IPv6 协议访问 IPv6 源站。如果没有 IPv6 源站，则访问 IPv4 源站。
ipv4_first：IPv4优先，边缘节点优先使用 IPv4 协议访问 IPv4 源站。如果没有 IPv4 源站，则访问 IPv6 源站。
ipv4v6_lb：IPv4和IPv6负载均衡模式，边缘节点以轮询的方式访问源站（IPv4 源站、IPv6 源站）。如果 IPv4 源站、IPv6 源站设置了权重，那么边缘节点会按照权重的比例访问源站。
followclient：跟随客户端协议模式。边缘节点使用的 IP 协议与客户端请求使用的 IP 协议相同。\n
- 客户端请求使用 IPv6 协议，边缘节点优先使用 IPv6 协议访问 IPv6 源站。如果没有 IPv6 源站，则访问 IPv4 源站。
- 客户端请求使用 IPv4 协议，边缘节点优先使用 IPv4 协议访问 IPv4 源站。如果没有 IPv4 源站，则访问 IPv6 源站。
\n

", "example": "", "required": "否", "type": "String" } ] }, { "name": "PrivateBucketAuth", "key": "0-1-16", "title": "表示访问第三方云厂商的对象存储服务的权限设置。该对象仅当 OriginType 为 TOS 时有效。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "Switch", "key": "0-1-16-0", "title": "

对象存储服务是否是第三方云厂商的。

true: 表示对象存储服务是第三方云厂商的。
false（默认值）: 表示对象存储服务不是第三方云厂商的。

", "example": "true", "required": "是", "type": "Boolean" }, { "name": "AuthType", "key": "0-1-16-1", "title": "

表示对象存储源站域名所在的云厂商。当 Switch 为 true 时，该参数为必填。取值:

cos: 腾讯云。
oss: 阿里云。
aws: AWS。
obs: 华为云。

", "example": "cos", "required": "否", "type": "String" }, { "name": "TosAuthInformation", "key": "0-1-16-2", "title": "表示访问第三方云厂商所需要的访问密钥。当 TosPrivateAccess 是 true 时，此参数为必填。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "AccessKeyId", "key": "0-1-16-2-0", "title": "表示具有相应权限的云厂商账号的 AccessKey ID", "example": "ak", "required": "是", "type": "String" }, { "name": "AccessKeySecret", "key": "0-1-16-2-1", "title": "表示具有相应权限的云厂商账号的 AccessKey Secret", "example": "sk", "required": "是", "type": "String" } ] } ] } ] }, { "name": "StrategyType", "key": "0-2", "title": "

回源策略，源站类型为 TOS 时，不支持修改。取值：

wrr：加权轮询。
optimum：根据源服务器健康度选择最优的源站服务器。

", "example": "", "required": "否", "type": "String" }, { "name": "Scope", "key": "0-3", "title": "

加速区域（访问用户所在的区域），当前仅对白名单用户开放。详细信息，请见修改基础配置。
\n取值：

domestic（默认值）：中国大陆。
overseas：中国大陆以外区域。
global：全球。

", "example": "global", "required": "否", "type": "String" }, { "name": "Https", "key": "0-4", "title": "HTTPS 加速配置。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "EnableHttps", "key": "0-4-0", "title": "

是否启用 HTTPS，默认根据证书的绑定自动打开，如果绑定证书时不想启用 HTTPS，需要将该参数设置为 false。取值：

true：启用。
false：不启用。

", "example": "true", "required": "否", "type": "Boolean" }, { "name": "Http2", "key": "0-4-1", "title": "

是否启用 HTTP2，默认不启用，开启前需要先开启 HTTPS 设置。取值：

true：启用。
false：不启用。

", "example": "false", "required": "否", "type": "Boolean" }, { "name": "Hsts", "key": "0-4-2", "title": "HSTS 配置。开启前需要先开启 HTTPS 设置。开启后，全站加速响应增加 Strict-Transport-Security 头部，减少被劫持的风险。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "Enable", "key": "0-4-2-0", "title": "

是否启用 HSTS，默认不启用。启用 HSTS 前，必须先启用 HTTPS。开启后，全站加速响应增加 Strict-Transport-Security 头部，在用户第一次成功建立 HTTPS 访问后，减少后续被被劫持的风险。取值：

true：启用。
false：不启用。

注意

为保证 HSTS 功能的成功生效，要求客户端支持 HSTS 机制，同时客户端应该完成过一次 HTTPS 请求。因此，开启 HSTS 时系统将同时为您开启强制跳转功能，将 HTTP 请求重定向为 HTTPS 请求。后续在您指定的时间内，客户端对所有的请求都会只使用 HTTPS 协议。

", "example": "", "required": "否", "type": "Boolean" }, { "name": "IncludeSubDomain", "key": "0-4-2-1", "title": "

是否包含该域名的子域名。默认不包含。开启前请确保所有子域名已开启 HTTPS，EnableHttps 必须设置为 true。取值：

true：包含。HSTS 启用对该域名的子域名同样生效。
false：不包含。HSTS 启用对该域名的子域名不生效。

", "example": "", "required": "否", "type": "Boolean" }, { "name": "MaxAge", "key": "0-4-2-2", "title": "开启 HSTS 功能后，您可以指定 HSTS 的过期时间。如果客户端成功完成了一次 HTTPS 请求，客户端会记住响应头中的 Strict-Transport-Security 字段。在您指定时间内，对接下来的全部请求，客户端都会强制使用 HTTPS 协议。单位：秒。支持取值：0-63072000。", "example": "", "required": "否", "type": "Integer" } ] }, { "name": "TlsVersions", "key": "0-4-3", "title": "TLS 版本配置。支持选择 TLS V1.0-V1.3 版本。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "Enable", "key": "0-4-3-0", "title": "

是否启用 TLS 协议版本强制要求，默认不启用，取值：

true：启用。
false：不启用。

", "example": "false", "required": "是", "type": "Boolean" }, { "name": "TlsVersion", "key": "0-4-3-1", "title": "TLS 版本，输入版本需要连续，支持TLSv1、TLSv1.1、TLSv1.2、TLSv1.3。当 Enable 字段为 true 时，此选项必填。", "example": "["TLSv1", "TLSv1.1"]", "required": "是", "type": "String[]", "children": [] } ] }, { "name": "CertBind", "key": "0-4-4", "title": "HTTPS 证书配置（服务器证书），绑定证书的情况下，HTTPS、HSTS、ForceRedirect等功能才能开启。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "CertSource", "key": "0-4-4-0", "title": "

证书托管位置。取值：

volc：证书托管在火山引擎证书中心。如果您的证书还未在证书中心，您需要先将证书上传到证书中心。
self：证书托管在 DCDN。（该功能仅对白名单用户开放。如需使用，请提交工单。）

", "example": "volc", "required": "是", "type": "String" }, { "name": "CertId", "key": "0-4-4-1", "title": "在火山证书中心上托管的证书 ID。", "example": "cert-rvAQ*****3tDseHQ3KGyA", "required": "是", "type": "String" }, { "name": "CertName", "key": "0-4-4-2", "title": "证书名称。", "example": "example.com证书", "required": "否", "type": "String" }, { "name": "DomainId", "key": "0-4-4-4", "title": "绑定的加速域名 ID。", "example": "accdomain-xxx", "required": "否", "type": "String" }, { "name": "DomainName", "key": "0-4-4-5", "title": "绑定的加速域名名称。", "example": "www.xxx.com", "required": "否", "type": "String" }, { "name": "Expire", "key": "0-4-4-6", "title": "过期时间。", "example": "2023-08-20T07:59:59Z", "required": "否", "type": "String" } ] }, { "name": "ForceRedirect", "key": "0-4-5", "title": "强制跳转配置。开启前请先配置 HTTPS 证书，将客户端到全站加速的请求方式强制重定向为 HTTP 或 HTTPS，默认通过返回状态码 301 跳转。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "Enable", "key": "0-4-5-0", "title": "

是否启用强制跳转，默认不启用，支持取值：

true：启用。
false：不启用。

", "example": "false", "required": "是", "type": "Boolean" }, { "name": "RedirectType", "key": "0-4-5-1", "title": "

强制跳转访问协议类型，当 Enable 字段为 true 时，此选项必填。支持取值：

http：访问协议强制跳转为 HTTP 协议。
https：访问协议强制跳转为 HTTPS 协议。

", "example": "http", "required": "是", "type": "String" }, { "name": "RedirectCode", "key": "0-4-5-2", "title": "

强制跳转使用的状态码，默认使用 301。取值：301，302，307，308。

注意

对于 301 和 302 状态码，即使原用户请求使用的方法不是 GET，某些早期浏览器可能会使用 GET 方法发送重定向请求。

", "example": "302", "required": "否", "type": "Integer" } ] }, { "name": "QUICSwitch", "key": "0-4-6", "title": "

是否开启 QUIC 协议支持，开启前需要先开启 HTTPS 设置，开启后支持客户端以 QUIC 协议访问服务，开启 QUIC 前，请确认域名已完成证书配置。默认不启用，取值：

true：启用。
false：不启用。

", "example": "false", "required": "否", "type": "Boolean" }, { "name": "HTTPSClientCert", "key": "0-4-7", "title": "边缘双向认证的相关配置。在启用了 HTTPS 之后，允许边缘节点与客户端建立安全通信的时候，启用双向认证（同时认证客户端证书）以获得更高的安全性。
\n此功能仅向特定用户开放，如需使用该功能，请提交工单。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "Enable", "key": "0-4-7-0", "title": "

是否开启边缘双向认证。默认不开启。取值：

true：表示边缘双向认证已启用。
false：表示边缘双向认证已禁用。

", "example": "true", "required": "是", "type": "Boolean" }, { "name": "CertBindClient", "key": "0-4-7-1", "title": "客户端验证的证书配置。当 Enable 为 true 时，此选项为必需。", "example": "", "required": "是", "type": "Object", "children": [ { "name": "CertSource", "key": "0-4-7-1-0", "title": "

证书托管的位置。取值：

self：证书托管在 DCDN 上。目前边缘双向认证只支持托管在 DCDN 中的 CA 证书。

", "example": "self", "required": "是", "type": "String" }, { "name": "CertId", "key": "0-4-7-1-1", "title": "用于验证客户端证书的 CA 证书 ID。", "example": "cert-rvAQ*****3tDseHQ3KGyA", "required": "是", "type": "String" } ] } ] }, { "name": "OCSPStapling", "key": "0-4-8", "title": "OCSP Stapling 配置，启用该配置后，可提高客户端 TLS 握手效率，节省了在 TLS 握手阶段客户端通过 OCSP 验证证书的时间。", "example": "false", "required": "否", "type": "Boolean" } ] }, { "name": "EnableFailOver", "key": "0-5", "title": "

是否开启主备容灾功能，默认不启用，源站类型为火山引擎 TOS 时，不支持修改。支持取值：

true：启用。
false：不启用。

", "example": "false", "required": "否", "type": "Boolean" }, { "name": "IPv6Switch", "key": "0-6", "title": "

是否开启 IPv6 功能，默认不启用，支持取值：

true：启用。
false：不启用。

", "example": "false", "required": "否", "type": "Boolean" }, { "name": "Cache", "key": "0-7", "title": "缓存配置。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "Enable", "key": "0-7-0", "title": "

是否启用缓存功能，默认不启用，支持取值：

true：启用。
false：不启用。

", "example": "false", "required": "是", "type": "Boolean" }, { "name": "AdaptCache", "key": "0-7-1", "title": "

是否启用自适应缓存功能，默认不启用。取值：

true：启用。开启自适应缓存后，边缘节点将按照源站的缓存规则对源站返回的静态内容进行缓存。
false：不启用。

", "example": "false", "required": "否", "type": "Boolean" }, { "name": "CacheRules", "key": "0-7-2", "title": "

缓存规则配置，启用缓存功能且未开启自适应缓存时必选。
指您可以设置源站静态内容在边缘节点的缓存过期时间。这样可以设定边缘节点缓存的内容在多长时间后过期。过期后，节点需要重新回源获取该内容。

", "example": "", "required": "否", "type": "Object[]", "children": [ { "name": "Type", "key": "0-7-2-0", "title": "

缓存规则类型。您可以按照文件后缀、目录、文件全路径、首页、全路径正则表达式等方式来指定源站返回的数据内容，并对这部分数据设置缓存过期时间。取值：

file：按文件名后缀匹配缓存。
dir：按目录匹配缓存。
all：按文件全路径匹配缓存。
index：按首页匹配缓存。
pcre：按全路径正则表达式匹配缓存。

", "example": "dir", "required": "是", "type": "String" }, { "name": "Contents", "key": "0-7-2-1", "title": "

缓存规则内容主体，不同的缓存类型对应的缓存规则不同，详见配置缓存规则文档。

注意

如果您开启了自适应缓存功能、同时设置了缓存规则，当源站返回的静态内容同时匹配自适应缓存规则、缓存规则时，那么边缘节点会优先按照缓存规则来缓存静态内容。更多关于不同缓存规则优先级的问题，请参见缓存规则的优先级。

", "example": "/www/dir/aaa/", "required": "是", "type": "String" }, { "name": "Policy", "key": "0-7-2-2", "title": "

缓存策略，取值：

default：默认策略，表示本规则优先遵循源站不缓存的响应头信息（Cache-Control:no-store 和 Cache-Control:private），然后再遵循全站加速的缓存配置规则。
force：强制缓存，表示本规则完全遵循全站加速的缓存配置，忽略源站不缓存响应头信息（Cache-Control:no-store 和 Cache-Control:private）的情况。
origin：源站优先，表示本规则优先遵循源站响应头信息（Cache-Control 以及 Expires）进行缓存和不缓存判断，再遵循全站加速的缓存策略。

", "example": "default", "required": "否", "type": "String" }, { "name": "CacheTime", "key": "0-7-2-3", "title": "

缓存的过期时间的取值。

当达到设置的过期时间时，边缘节点上缓存的静态内容失效。此时客户端向边缘节点请求这一内容时，全站加速会在源站获取最新内容并按照规则将内容缓存在边缘节点中。\n
- 图片类型、应用下载类型等不经常更新的静态内容：建议您将缓存时间设置成30天以上。
- JS、CSS等频繁更新的静态内容：建议您根据实际需求设定缓存时间。
- PHP、JSP、ASP等动态内容：建议您将缓存时间设置成0秒，即边缘节点回源获取这些内容。
\n

", "example": "10", "required": "是", "type": "Float" }, { "name": "CacheTimeUnit", "key": "0-7-2-4", "title": "

缓存时间单位，取值：

second：秒。
minute：分。
hour：小时。
day：天。
month：月。
year：年。

", "example": "second", "required": "是", "type": "String" }, { "name": "IgnoreCase", "key": "0-7-2-5", "title": "

表示 DCDN 在使用该规则匹配用户请求 URL 时是否忽略大小写，默认不忽略，取值：

true：忽略。
false：不忽略。

", "example": "false", "required": "否", "type": "Boolean" }, { "name": "ParamsReserveList", "key": "0-7-2-6", "title": "缓存参数列表，缓存键参数规则ParamsFilterType为part和excl时必选，不同参数用分号 ; 相隔。", "example": "parama;paramb", "required": "是", "type": "String" }, { "name": "IgnoreSetCookie", "key": "0-7-2-7", "title": "

当源站返回Set-Cookie头部字段时，节点是否缓存该头部及body，默认为false。

true：遵循用户自定义的节点缓存规则，命中后删除Set-Cookie头部字段
false：关闭，遵循用户自定义的节点缓存规则
\n建议用户开启该功能，不缓存set-cookie头部。

", "example": "false", "required": "否", "type": "Boolean" } ] }, { "name": "CacheKeyRules", "key": "0-7-3", "title": "

缓存键配置规则。指示边缘节点在缓存静态内容时，是否会去除请求 URL 中的参数。

说明

缓存键规则定义了全站加速生成和匹配缓存键的方法。
当请求 URL 中的查询参数不影响文件内容的获取时，建议您将缓存键规则中的参数规则设置为忽略全部。这样可提高请求的命中率，减少边缘节点的回源次数。
全站加速默认有一条根目录缓存键规则，您不能修改规则类型和内容。

", "example": "", "required": "否", "type": "Object[]", "children": [ { "name": "Type", "key": "0-7-3-0", "title": "

缓存键规则类型，支持取值：

file：文件名后缀。
dir：目录。
all：文件全路径。
index：首页。
pcre：全路径正则表达式。

", "example": "dir", "required": "是", "type": "String" }, { "name": "Contents", "key": "0-7-3-1", "title": "缓存键规则主体，不同的缓存键类型对应的缓存键规则不同，详见配置缓存键文档。", "example": "/www/dir/aaa/", "required": "是", "type": "String" }, { "name": "ParamsFilterType", "key": "0-7-3-2", "title": "

生成缓存键时 URL 中“?”之后的参数的缓存规则，默认保留全部，支持取值：

ignore：忽略全部参数（过滤）。
reserve：保留所有参数（不过滤）。
part：保留部分参数。
excl：去除部分参数。

", "example": "reserve", "required": "否", "type": "String" }, { "name": "IgnoreCase", "key": "0-7-3-3", "title": "

表示配置的规则在匹配请求 URL 及生成缓存键时，是否忽略大小写，默认不忽略。取值：

true：忽略。
false：不忽略。

", "example": "false", "required": "否", "type": "Boolean" }, { "name": "ParamsReserveList", "key": "0-7-3-4", "title": "参数规则 ParamsFilterType 为 part（保留部分参数）或 excl（去除部分参数）时必选。表示缓存规则中需要排除或者需要保留的具体参数列表，以分号相隔。", "example": "parama;paramb", "required": "否", "type": "String" } ] }, { "name": "StatusCodeCacheRule", "key": "0-7-4", "title": "

状态码缓存配置。

说明

为了减轻源站处理请求的压力，您可以配置状态码缓存规则。这样边缘节点可以缓存特定的响应状态码，避免每次都返回源站获取相同的响应状态码。配置状态码缓存规则只在您配置了静态缓存规则时才会生效，未配置静态缓存规则时，状态码缓存规则不生效。

", "example": "", "required": "否", "type": "Object", "children": [ { "name": "Enable", "key": "0-7-4-0", "title": "

是否启用状态码缓存功能，默认不启用，支持取值：

true：启用。
false：不启用。

", "example": "false", "required": "是", "type": "Boolean" }, { "name": "Rules", "key": "0-7-4-1", "title": "状态码缓存规则。当 Enable 字段为 true 时，此选项必填。", "example": "", "required": "是", "type": "Object[]", "children": [ { "name": "Status", "key": "0-7-4-1-0", "title": "

当 Enable 字段为 true 时，此选项必填。
状态码支持取值：\n
- 4xx：400、403、404、405、414、416。
- 5xx：500、501、502、503、504。
\n

", "example": "404", "required": "是", "type": "String" }, { "name": "CacheTime", "key": "0-7-4-1-1", "title": "当 Enable 字段为 true 时，此选项必填。表示状态码缓存过期时间的取值。", "example": "10", "required": "是", "type": "Float" }, { "name": "CacheTimeUnit", "key": "0-7-4-1-2", "title": "

当 Enable 字段为 true 时，此选项必填。表示状态码缓存过期时间的单位，取值：

second：秒。
minute：分。
hour：小时。
day：天。
month：月。
year：年。

", "example": "second", "required": "是", "type": "String" }, { "name": "RespUrl", "key": "0-7-4-1-3", "title": "

自定义响应界面 URL ，当 Enable 字段为 true 时，此选项必填。具体规则如下：

仅支持完整的URL或者path。
完整URL必须以http/https开始，path必须以/开始。

", "example": "http://www.test.com", "required": "是", "type": "String" }, { "name": "RespCode", "key": "0-7-4-1-4", "title": "", "example": "", "required": "否", "type": "String" } ] } ] } ] }, { "name": "UrlRedirect", "key": "0-8", "title": "URL 重定向相关配置。当客户端请求资源的 URL 和全站加速节点上缓存的 URL 不一致时，您可以进行 URL 重定向。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "Enable", "key": "0-8-0", "title": "

是否启用 URL 重定向功能，默认不启用，取值：

true：启用。
false：不启用。

", "example": "false", "required": "是", "type": "Boolean" }, { "name": "Rules", "key": "0-8-1", "title": "URL 重定向相关配置。当 Enable 字段为 true 时，此选项必填。", "example": "", "required": "是", "type": "Object[]", "children": [ { "name": "Match", "key": "0-8-1-0", "title": "

待重写的 URL，当 Enable 字段为 true 时，此选项必填。具体规则如下：

以正斜线“/”开头的 URL 路径，不含 http:// 头及域名。
支持 PCRE 正则表达式，不包含前后“/”。

", "example": "/test1.html", "required": "是", "type": "String" }, { "name": "Replacement", "key": "0-8-1-1", "title": "

目标 URL，当 Enable 字段为 true 时，此选项必填。具体规则如下：

以正斜线“/”开头的 URL，不含 http:// 头及域名。

", "example": "/test2.html", "required": "是", "type": "String" } ] } ] }, { "name": "IpAccess", "key": "0-9", "title": "基于客户端源 IP 地址的访问黑/白名单。为了解决来自某些特定 IP 的恶意盗刷、攻击等问题，需要对访问来源进行限制，您可以配置 IP 黑白名单。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "Enable", "key": "0-9-0", "title": "

是否启用 IP 黑/白名单功能，默认不启用。取值：

true：启用。
false：不启用。

", "example": "false", "required": "是", "type": "Boolean" }, { "name": "FilterType", "key": "0-9-1", "title": "

表示过滤行为为黑名单或白名单，当 Enable 字段为 true 时，此选项必填。取值：

WhiteList：白名单列表，只有添加在白名单内的 IP 能访问加速域名下的资源。
BlackList：黑名单列表，添加在黑名单内的 IP 无法访问加速域名下的资源。

", "example": "WhiteList", "required": "是", "type": "String" }, { "name": "FilterList", "key": "0-9-2", "title": "IP 列表，支持配置 IP 地址和网段输入，多个 IP 通过换行分隔，最多输入100个。当 Enable 字段为 true 时，此选项必填。", "example": "["203.0.113.5"]", "required": "是", "type": "String[]", "children": [] } ] }, { "name": "UserAgentAccess", "key": "0-10", "title": "基于客户端 UserAgent 的访问黑/白名单。如果您希望通过对用户 HTTP 请求头中的 User-Agent 字段进行规则判断，从而基于客户端类型进行过滤，您可以配置 User-Agent 黑白名单。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "Enable", "key": "0-10-0", "title": "

是否启用 UserAgent 黑/白名单，默认不启用，取值：

true：启用。
false：不启用。

", "example": "false", "required": "是", "type": "Boolean" }, { "name": "FilterType", "key": "0-10-1", "title": "

表示过滤行为为黑名单或白名单，当 Enable 字段为 true 时，此选项必填。选项：

WhiteList：白名单列表，只有 HTTP 请求中的 User-Agent 字段匹配到白名单内的字段，用户才可以访问当前请求的资源。
BlackList：黑名单列表，如果 HTTP 请求中的 User-Agent 字段匹配到黑名单内的字段，那么用户无法访问当前请求的资源。

", "example": "WhiteList", "required": "是", "type": "String" }, { "name": "FilterList", "key": "0-10-2", "title": "User-Agent 值列表，当 Enable 字段为 true 时，此选项必填，支持通配符号“*”，最多输入100个。", "example": "["*Linux*"]", "required": "是", "type": "String[]", "children": [] } ] }, { "name": "RefererAccess", "key": "0-11", "title": "基于 Referer 访问黑/白名单。为了防止网站资源被盗用，您可以配置 Referer 防盗链。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "Enable", "key": "0-11-0", "title": "

是否启用 Referer 黑/白名单，默认不启用，取值：

true：启用。
false：不启用。

", "example": "false", "required": "是", "type": "Boolean" }, { "name": "FilterType", "key": "0-11-1", "title": "

表示过滤行为为黑名单或白名单，当 Enable 字段为 true 时，此选项必填。选项：

WhiteList：白名单列表，只有 HTTP 请求中的 Referer 内容匹配到白名单内容，用户才可以访问当前请求的资源。
BlackList：黑名单列表，如果 HTTP 请求中的 Referer 内容匹配到黑名单内容，那么用户无法访问当前请求的资源。

", "example": "WhiteList", "required": "是", "type": "String" }, { "name": "AllowNone", "key": "0-11-2", "title": "

是否允许 Referer 字段为空，默认不允许，即便当 Enable 字段为 true 时，本字段也可不填。取值：

true：允许。
false：不允许。

", "example": "false", "required": "否", "type": "Boolean" }, { "name": "FilterList", "key": "0-11-3", "title": "

具体 Referer 列表，当 Enable 字段为 true 时，此选项必填。具体规则：

支持泛域名和通配符号 *，最多输入 100 个。
参数不应该带前缀（http://）或（https://）。
允许Filename配置，如允许您使用 referer 为 http://x.com，则 http://x.com/Filename 也符合规则。
前缀通配泛域名，如（*.b.baidu.com）需要加（.），则允许 referer 为（http://[xx].b.baidu.com）。
后缀通配泛域名，如（b.baidu.com.*），需要加（.），则允许 referer 为（http://b.baidu.com.[xx]）。
当（*）作为通配符时，不能满足泛域名的格式，此时将被认为是正则匹配。如（*.a.com）会被当作泛域名，（a.*b.com）则会用正则表达式的规则匹配，可以匹配上（a.cab.com.）。
开启白名单时，则默认白名单列表中存在此加速域名。

", "example": "["a.b.com"]", "required": "是", "type": "String[]", "children": [] } ] }, { "name": "UrlAccess", "key": "0-12", "title": "URL 鉴权。为了保护站点资源，避免资源被恶意下载盗用，您还可以通过配置 URL 鉴权，达到防止资源被非法下载盗用、提升内容安全性的目的。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "Enable", "key": "0-12-0", "title": "

是否开启 URL 鉴权，默认不启用，取值：

true：启用。
false：不启用。

", "example": "false", "required": "是", "type": "Boolean" }, { "name": "GenType", "key": "0-12-1", "title": "

鉴权类型，从系统内置的签名公式里选一种，当 Enable 字段为 true 时，此选项必填。详见配置 URL 鉴权，取值：

TypeA
TypeB
TypeC
TypeD

", "example": "TypeC", "required": "是", "type": "String" }, { "name": "GenKey", "key": "0-12-2", "title": "鉴权密钥，支持6-40位大/小写字母、数字。当 Enable 字段为 true 时，此选项必填。", "example": "XXM6KuY1p", "required": "是", "type": "String" }, { "name": "GenTTL", "key": "0-12-3", "title": "有效时间，单位为秒，范围为：0~31536000。当 Enable 字段为 true 时，此选项必填。", "example": "30", "required": "是", "type": "Integer" } ] }, { "name": "WebSocket", "key": "0-13", "title": "WebSockect 相关配置。当您处于服务端主动推送数据信息到客户端、实时通讯性要求高的业务场景时，可以选择开启 WebSocket 服务。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "Enable", "key": "0-13-0", "title": "

是否开启 WebSocket 协议，默认不启用，取值：

true：启用。
false：不启用。

", "example": "false", "required": "是", "type": "Boolean" }, { "name": "Timeout", "key": "0-13-1", "title": "超时时间，单位为秒。取值范围 [1，900]。当 Enable 字段为 true 时，此选项必填。", "example": "10", "required": "是", "type": "Integer" } ] }, { "name": "GzipCompress", "key": "0-14", "title": "Gzip 压缩。开启 Gzip 压缩后，全站加速在返回内容时会对资源进行 Gzip 压缩，缩减静态内容尺寸，从而缩短传输时间。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "Enable", "key": "0-14-0", "title": "

是否开启 Gzip 压缩配置，默认不启用，取值：

true：启用。
false：不启用。

", "example": "false", "required": "是", "type": "Boolean" } ] }, { "name": "BrCompress", "key": "0-15", "title": "Brotli 压缩。开启 Brotli 压缩后，全站加速在返回内容时会对资源进行 Brotli，缩减静态内容尺寸，从而缩短传输时间。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "Enable", "key": "0-15-0", "title": "

是否开启 Brotli 压缩配置，默认不启用，支持取值：

true：启用。
false：不启用。

", "example": "false", "required": "是", "type": "Boolean" } ] }, { "name": "StaticOptimization", "key": "0-16", "title": "页面性能优化。HTTP/2 协议多路复用场景下，通过调整缓冲区策略，控制静态资源请求优先级，实现静态页面加载性能优化。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "H2Priority", "key": "0-16-0", "title": "

是否开启页面性能优化，默认不启用，支持取值：

true：启用。
false：不启用。

", "example": "false", "required": "是", "type": "Boolean" } ] }, { "name": "UploadOptimize", "key": "0-17", "title": "上传协议优化。开启上传协议优化后，DCDN 服务通过自研协议栈优化策略，提升文件接收和传输性能", "example": "", "required": "否", "type": "Object", "children": [ { "name": "Enable", "key": "0-17-0", "title": "

是否开启上传协议优化配置，默认不启用，取值：

true：启用。
false：不启用。

", "example": "false", "required": "否", "type": "Boolean" } ] }, { "name": "PreConnect", "key": "0-18", "title": "预连接。开启后预连接后，DCDN服务主动与源站建立连接，维护连接池，提高回源连接复用率，缩短访问链路耗时。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "Enable", "key": "0-18-0", "title": "

是否开启预连接配置，默认不启用，取值：

true：启用。
false：不启用。

", "example": "", "required": "否", "type": "Boolean" } ] }, { "name": "RTTOptimize", "key": "0-19", "title": "回源链路择优。开启回源链路择优后，DCDN服务会选择最优的RTT链路回源，缩短访问链路耗时。", "example": "", "required": "否", "type": "Object", "children": [ { "name": "Enable", "key": "0-19-0", "title": "

是否开启回源链路择优，开启前需要先开启预连接，默认不启用，支持取值：

true：启用。
false：不启用。

", "example": "", "required": "否", "type": "Boolean" } ] }, { "name": "ResourceTags", "key": "0-20", "title": "绑定在该域名上的资源标签（Tag）信息。", "example": "", "required": "否", "type": "Object[]", "children": [ { "name": "Key", "key": "0-20-0", "title": "标签名称，支持大/小写字母、数字和中文组成，支持 +-=@/._ 等特殊字符，长度不超过 128 个字符，不允许以 volc 开头。", "example": "costcenter", "required": "是", "type": "String" }, { "name": "Value", "key": "0-20-1", "title": "标签名称对应的值，由大/小写字母、数字和中文组成，支持"+-=@/._"等特殊字符，长度不超过 256 个字符。", "example": "54321", "required": "是", "type": "String" } ] }, { "name": "ServiceType", "key": "0-21", "title": "

该加速域名关联的加速场景，取值：

upload：上传加速
page：页面加速
api：API 加速
other：其他

", "example": "api", "required": "否", "type": "String" } ]; return (

); ``` ## 返回参数变更域名配置的操作被正确执行时，无返回参数，执行时出错时会返回错误信息。 ## 请求示例 ```json POST https://open.volcengineapi.com?Action=UpdateDomainConfig&Version=2023-01-01 { "Domain": "www.test.com", "Origin": { "Origins": [ { "Name": "1.1.1.2", "Weight": 1, "Port": 12 } ], "OriginType": "IP", "OriginProtocolType": "http", "BackupOriginType": "IP", "ResponseTimeout": 10, "ResponseHeader": { "Enable": false, "HeaderInfo": [] }, "OriginHost": { "Enable": true, "HostInfo": "www.test1.com" }, "OriginSni": { "Enable": false, "SniInfo": "" }, "OriginRange": { "Enable": false, "Size": "" }, "RequestHeader": { "Enable": false, "HeaderInfo": [] }, "BackupOrigins": [] }, "EnableFailOver": true, "StrategyType": "wrr" } ``` ## 返回示例 ```json { "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "UpdateDomainConfig", "Version": "2023-01-01", "Service": "dcdn", "Region": "cn-north-1" } } ```