## API说明 API名称：DescribeDomainConfig。 API域名：open.volcengineapi.com。 API描述：查询全站加速域名的详细配置。 ## URI参数 ### 公共参数 > Action和Version需要放在请求 URL 后方参数中。 ```mixin-react const columns = [ { title: '参数名称', dataIndex: 'name', }, { title: '是否必选', dataIndex: 'choose', }, { title: '参数类型', dataIndex: 'type', }, { title: '参数说明', dataIndex: 'note', }, ]; const data = [ { key: '1', name: 'Action', choose: '是', type: 'String', note:'API 名称，该参数的取值是 DescribeDomainConfig 。', }, { key: '2', name: 'Version', choose: '是', type: 'String', note:'API 版本，该参数的取值是 2021-04-01 。', }, ]; return (); ``` ## 请求正文在使用该 API 提交请求时，请求正文中可以包含的参数如下。 |

参数名称 |

是否必选 |

参数类型 |

参数说明 |

示例值 | | --- | --- | --- | --- | --- | | Domains | 是 | [ ]String | 待查询域名列表。 | `["www.test.com"] `| ## 响应正文 ```mixin-react const columns = [ { title: '参数名称', dataIndex: 'name', width:250 }, { title: '参数类型', dataIndex: 'type', width:190 }, { title: '参数说明', dataIndex: 'desc', render:(val)=>, }, { title: '示例', dataIndex: 'example', render:(val)=>, width:180 }, ]; const data = [ { key: '1', name: 'Domain', type: 'String', desc: '待查询的加速域名列表，匹配规则为模糊匹配，当域名匹配到其中任一个关键字时，就会返回对应数据。如域名列表[abc.com,abc.cn] ，关键词为abc，由于dabc.com 包含 abc.com，dabc.cn 包含 abc.cn，所以 dabc.com、dabc.cn会匹配到，返回对应数据。但是 abcd.com、abcd.cn不会匹配到。', example: '\["www.test1.com","www.test2.com"\]', }, { key: '3', name: 'ProjectName', type: 'String', desc: '当前创建域名所归属的项目。', example: 'default', }, { key: '4', name: 'StrategyType', type: 'String', desc: '

回源策略，支持取值：

wrr：加权轮询。

optimum：择优。
', example: 'wrr', }, { key: '5', name: 'Scope', type: 'String', desc: '
加速范围，当前仅对白名单用户开放。具体取值如下：
- domestic（默认值）：中国大陆。
- overseas：中国大陆以外区域。
- global：全球。
', example: 'domestic', }, { key: '6', name: 'Cname', type: 'String', desc: '为加速域名生成的 Cname 。', example: 'www.test.com.a.b.com', }, { key: '7', name: 'IsCNAMEResolved', type: 'Boolean', desc: '
加速域名是否被解析到CNAME，支持参数：
- true：已解析。
- false：未解析。
', example: 'false', }, { key: '8', name: 'RecordFiling', type: 'String', desc: '
当前域名备案状态，支持参数：
- success：域名备案状态有效。
- fail：域名备案状态失效。
- recovery：域名备案状态从有效转为失效。
', example: 'success', }, { key: '9', name: 'UserName', type: 'String', desc: '加速域名所属的用户 ID 。', example: '2000000191', }, { key: '10', name: 'Status', type: 'String', desc: '
加速域名所处的状态，具体包括：
- Started：运行中。
- Deploy：部署中。
- Stop：已停止。
', example: 'Started', }, { key: '11', name: 'CreateTime', type: 'String', desc: '创建加速域名的时间。时间格式遵循 RFC 3339 规范。', example: '2023-01-04 16:55:55', }, { key: '12', name: 'UpdateTime', type: 'String', desc: '最近更新加速域名的时间。时间格式遵循 RFC 3339 规范。', example: '2023-01-04 16:55:55', }, { key: '13', name: 'Origin', type: 'Origin', desc: '源站配置。', example: '-', children: [ { key: '14', name: 'Origins', type: '[ ]OriginInfo', desc: '主源站列表，IP 与域名源站不可混填。最多配置50条记录。', example: '-', children: [ { key: '15', name: 'Name', type: 'String', desc: '回源地址，需要与您设置的源站类型一致。', example: 'www.test.com', }, { key: '16', name: 'Weight', type: 'Integer', desc: '权重，您可为源站设置权重，有效范围为 0 - 100。且所有源站的权重之和不为0。', example: '1', }, { key: '17', name: 'Port', type: 'Integer', desc: '
您可自定义回源端口。不填时系统会自动根据您的回源协议填充。
- 回源协议为 HTTP 时：回源端口为80。
- Domain：回源协议为 HTTPS 时：回源端口为443。
  ', example: '80', }, ], }, { key: '18', name: 'OriginType', type: 'String', desc: '
  主源站类型，支持参数：
  - IP：IP 源站。
  - Domain：域名源站。
  - TOS：对象存储源站。
    ', example: 'IP', }, { key: '122', name: 'TosPrivateAccess', type: 'Boolean', desc: '
    是否允许访问私有 bucket，取值如下：
    true：启用。
    false：不启用。
    ', example: 'true', }, { key: '19', name: 'OriginProtocolType', type: 'String', desc: '
    回源方式，支持参数：
    http：忽略客户端的请求方式，边缘节点会强制采用 HTTP回源。
    https：忽略客户端的请求方式，边缘节点会强制 HTTPS 回源。
    follow：边缘节点的回源方式与客户端的请求协议保持一致。
    ', example: 'http', }, { key: '20', name: 'BackupOrigins', type: '[ ]OriginInfo', desc: '备源站列表，IP 与域名源站不可混填，开启主备容灾时必存在。最多配置50条记录。', example: '-', children: [ { key: '21', name: 'Name', type: 'String', desc: '回源地址。', example: 'www.test.com', }, { key: '22', name: 'Weight', type: 'Integer', desc: '权重，有效范围为 0 - 100。', example: '1', }, { key: '23', name: 'Port', type: 'Integer', desc: '自定义回源端口。', example: '80', }, ], }, { key: '24', name: 'BackupOriginType', type: 'String', desc: '
    备源站类型，开启主备容灾时必存在，支持参数：：
    IP：IP 源站。
    Domain：域名源站。
    ', example: 'IP', }, { key: '25', name: 'ResponseTimeout', type: 'Integer', desc: '回源超时时间，单位为秒，最大值为900。默认值为10。', example: '10', }, { key: '26', name: 'ResponseHeader', type: 'ResponseHeader', desc: 'HTTP Header 相关配置。当用户请求资源时，全站加速会在返回的响应数据中添加配置的头部，影响客户程序（如浏览器）的响应行为。', example: '-', children: [ { key: '27', name: 'Enable', type: 'Boolean', desc: '
    是否启用，默认不启用，支持取值：
    true：启用。
    false：不启用。
    ', example: 'false', }, { key: '28', name: 'HeaderInfo', type: '[ ]SingleHeaderInfo', desc: '当Enable字段为true时，此选项必存在。当用户请求资源时，全站加速会在返回的响应数据中添加配置的头部，影响客户程序（如浏览器）的响应行为。', example: '-', children: [ { key: '29', name: 'HeaderMode', type: 'Integer', desc: '
    修改响应头的方式，支持参数：
    0：ADD，添加响应头。
    1：SET，设置已有的响应头。
    2：DELETE，删除对应的响应头。
    ', example: '2', }, { key: '30', name: 'HeaderName', type: 'String', desc: '
    ResponseHeader 名称，具体规则如下：
    名称不能重复。自定义头部名称值长度默认为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）。
    ', example: 'Content-Type', }, { key: '31', name: 'HeaderValue', type: 'String', desc: '
    ResponseHeader 取值。当修改响应头的方式为DELETE 时不生效，具体规则如下：
    取值长度为1 - 1000个字符，不支持中文。
    在变量模式下，HeaderValue只能在固定范围内填写：[""uri"", ""request_uri"", ""remote_addr"", ""remote_port"", ""http_host"", ""args"", ""msec"", ""scheme""]。
    ', example: 'image', }, { key: '32', name: 'HeaderValueType', type: 'String', desc: '
    header填写HeaderValue中的值类型，支持取值：
    v：变量，此模式下，HeaderValue只能在固定范围内填写：[""uri"", ""request_uri"", ""remote_addr"", ""remote_port"", ""http_host"", ""args"", ""msec"", ""scheme""]。
    s或空值：表征字符固定值。
    ', example: 'v', }, ], }, ], }, { key: '33', name: 'OriginHost', type: 'OriginHost', desc: '自定义回源访问的具体站点域名。源站获取资源的站点与加速域名的站点不一致时，您可以通过配置回源 HOST 指明资源所在站点。', example: '-', children: [ { key: '34', name: 'Enable', type: 'Boolean', desc: '
    是否启用回源Host，默认不启用，支持取值：
    true：启用。
    false：不启用。
    ', example: 'false', }, { key: '35', name: 'HeaderInfo', type: 'String', desc: 'Host 地址。当Enable字段为true时，此选项必存在。源站获取资源的站点与加速域名的站点不一致，您可以通过配置回源 HOST 指明资源所在站点。', example: 'www.test.com', }, ], }, { key: '36', name: 'OriginSni', type: 'OriginSni', desc: '对于单 IP 多域名的场景，当回源协议为 https 时，需要指定回源 SNI 来指定具体访问的域名。', example: '-', children: [ { key: '37', name: 'Enable', type: 'Boolean', desc: '
    是否启用回源SNI，默认不启用，支持取值：
    true：启用。
    false：不启用。
    ', example: 'false', }, { key: '38', name: 'SniInfo', type: 'String', desc: 'SNI地址。当Enable字段为true时，此选项必存在。对于单 IP 多域名的场景，当回源协议为 https 时，需要指定回源 SNI 来指定具体访问的域名。', example: 'www.test.com', }, ], }, { key: '39', name: 'OriginRange', type: 'OriginRange', desc: '源站在收到全站加速节点回源请求时，根据 http 请求头中的 Range 信息返回指定范围的数据给全站加速节点,提高大文件分发效率。', example: '-', children: [ { key: '40', name: 'Enable', type: 'Boolean', desc: '
    是否启用回源Range，默认不启用，支持取值：
    true：启用。
    false：不启用。
    ', example: 'false', }, ], }, { key: '41', name: 'RequestHeader', type: 'RequestHeader', desc: '回源请求头相关配置。全站加速回源时，会透传用户的请求头。该配置允许您自定义回源请求头设置，比如删除，添加，或者修改已有请求头的值。', example: '-', children: [ { key: '42', name: 'Enable', type: 'Boolean', desc: '
    是否启用，默认不启用，支持取值：
    true：启用。
    false：不启用。
    ', example: 'false', }, { key: '43', name: 'HeaderInfo', type: '[ ]SingleHeaderInfo', desc: '回源请求头相关配置。当Enable字段为true时，此选项必存在。全站加速回源时，会透传用户的请求头。该配置允许您自定义回源请求头设置，比如删除，添加，或者修改已有请求头的值。', example: '-', children: [ { key: '44', name: 'HeaderMode', type: 'Integer', desc: '
    修改请求头的方式，支持参数：
    0：ADD，添加请求头。
    1：SET，设置已有请求头。
    2：DELETE，删除对应请求头。
    ', example: '2', }, { key: '45', name: 'HeaderName', type: 'String', desc: '
    RequestHeader 名称，具体规则如下：
    名称不能重复。自定义头部名称值长度默认为1 - 100个字符，由数字0 - 9、字符a - z、A - Z，及特殊符 - 组成，连字符（-）不能出现在字符串的头部或者尾部。不能使用（x-bd）、（x-tt）作为开头。
    RequestHeader 忽略大小写后不能匹配（x-real-ip）、（x-forwarded-for）。
    ', example: 'Content-Type', }, { key: '46', name: 'HeaderValue', type: 'String', desc: '
    RequestHeader 取值。当修改请求头的方式为DELETE 时不生效，具体规则如下：
    取值长度为1 - 1000个字符，不支持中文。
    在变量模式下，HeaderValue只能在固定范围内填写：[uri, request_uri, http_host, args,msec, scheme, query_string, host, client_ip, remote_addr, remote\_port]。
    ', example: 'image', }, { key: '47', name: 'HeaderValueType', type: 'String', desc: '
    header填写HeaderValue中的值类型，支持取值：
    v：变量，此模式下，HeaderValue只能在固定范围内填写：[uri, request_uri, http_host, args,msec, scheme, query_string, host, client_ip, remote_addr, remote\_port]。
    s或空值：表征字符固定值。
    ', example: 'v', }, ], }, ], }, ], }, { key: '48', name: 'Https', type: 'Https', desc: 'Https 加速配置。', example: '-', children: [ { key: '49', name: 'Http2', type: 'Boolean', desc: '
    是否启用Http2，默认不启用，开启前需要先开启 HTTPS 设置，支持取值：
    true：启用。
    false：不启用。
    ', example: 'false', }, { key: '50', name: 'Hsts', type: 'Hsts', desc: 'Hsts 配置。开启前需要先开启 HTTPS 设置，开启后，全站加速响应增加 Strict-Transport-Security 头部，减少第一次访问被劫持的风险。', example: '-', children: [ { key: '51', name: 'Enable', type: 'Boolean', desc: '
    是否启用Hsts，默认不启用，支持取值：
    true：启用。
    false：不启用。
    ', example: 'false', }, { key: '52', name: 'MaxAge', type: 'Integer', desc: 'MaxAge 数值，单位为秒。最大 63072000。当Enable字段为true时，此选项必存在。', example: '51800', }, { key: '53', name: 'IncludeSubDomain', type: 'Boolean', desc: '
    是否包含子域名，支持取值：
    true：启用。
    false：不启用。
    ', example: 'false', }, ], }, { key: '54', name: 'TlsVersions', type: 'TlsVersions', desc: 'TlS 版本配置。支持选择 TLS V1.0-V1.3 版本。', example: '-', children: [ { key: '55', name: 'Enable', type: 'Boolean', desc: '
    是否启用TLS，默认不启用，支持取值：
    true：启用。
    false：不启用。
    ', example: 'false', }, { key: '56', name: 'TlsVersion', type: '[ ]String', desc: 'TlS 版本，输入版本需要连续，支持TLSv1、TLSv1.1、TLSv1.2、TLSv1.3。当 Enable 字段为 true 时，此选项必存在。', example: '[TLSv1, TLSv1.1]', }, ], }, { key: '57', name: 'CertBind', type: 'CertBind', desc: '证书配置，绑定证书的情况下， Https、HSTS、ForceRedirect等功能才能开启。', example: '-', children: [ { key: '58', name: 'CertSource', type: 'String', desc: '
    证书来源，支持参数如下：
    volc：证书在火山平台上托管。
    self：证书在DCDN上托管。
    ', example: 'volc', }, { key: '59', name: 'CertId', type: 'String', desc: '
    火山证书中心的证书 ID。
    ', example: 'cert-rvAQ*****3tDseHQ3KGyA', }, { key: '60', name: 'DeployedStatus', type: 'String', desc: '
    证书部署状态，由全站加速返回该字段，取值如下：
    Deployed：已部署。
    Waiting：等待部署。
    Deploying：部署中。
    ', example: 'Deployed', }, { key: '120', name: 'Expire', type: 'String', desc: '证书过期时间，由全站加速解析证书后返回该字段。', example: '2023-01-04 12:12:12', }, ], }, { key: '61', name: 'ForceRedirect', type: 'ForceRedirect', desc: '强制跳转配置。开启前请先配置 HTTPS 证书，将客户端到全站加速的请求方式强制重定向为HTTP或HTTPS，默认使用301跳转。', example: '-', children: [ { key: '62', name: 'Enable', type: 'Boolean', desc: '
    是否启用强制跳转，默认不启用，支持取值：
    true：启用。
    false：不启用。
    ', example: 'false', }, { key: '63', name: 'RedirectType', type: 'String', desc: '
    强制跳转访问协议类型，当 Enable 字段为 true 时，此选项必存在。支持取值：
    http：访问协议强制跳转为http协议。
    https：访问协议强制跳转为https协议。
    ', example: 'http', }, ], }, { key: '64', name: 'QUICSwitch', type: 'Boolean', desc: '
    是否开启 QUIC，开启前需要先开启 HTTPS 设置，开启后支持客户端以 QUIC 协议访问服务，开启 QUIC前，请确认域名已完成证书配置。默认不启用，支持取值：
    true：启用。
    false：不启用。
    ', example: 'false', }, ], }, { key: '65', name: 'EnableFailOver', type: 'Boolean', desc: '
    是否开启主备容灾功能，默认不启用，支持取值：
    true：启用。
    false：不启用。
    ', example: 'false', }, { key: '66', name: 'IPv6Switch', type: 'Boolean', desc: '
    是否开启 IPv6 功能，通过 IPv6 协议访问全站加速节点和源站。默认不启用，支持取值：
    true：启用。
    false：不启用。
    ', example: 'false', }, { key: '67', name: 'Cache', type: 'Cache', desc: '缓存配置。', example: '-', children: [ { key: '68', name: 'Enable', type: 'Boolean', desc: '
    是否启用缓存功能，默认不启用，支持取值：
    true：启用。
    false：不启用。
    ', example: 'false', }, { key: '69', name: 'AdaptCache', type: 'Boolean', desc: '
    是否启用自适应缓存功能，默认不启用，支持取值：
    true：启用。
    false：不启用。
    ', example: 'false', }, { key: '70', name: 'CacheRules', type: '[ ]CacheRule', desc: '缓存规则配置，启用缓存功能且未开启自适应缓存时必存在。', example: '-', children: [ { key: '71', name: 'Type', type: 'String', desc: '
    缓存规则类型，支持取值：
    file：按文件名后缀匹配缓存。
    dir：按目录匹配缓存。
    all：按文件全路径匹配缓存。
    index：按首页匹配缓存。
    pcre：按全路径正则表达式匹配缓存。
    ', example: 'dir', }, { key: '72', name: 'Contents', type: 'String', desc: '缓存规则,不同的缓存类型对应的缓存规则不同，详见配置缓存规则文档。', example: '/www/dir/aaa/', }, { key: '73', name: 'Policy', type: 'String', desc: '
    缓存策略，支持取值：
    default：默认策略。
    origin：源站优先
    force：强制缓存
    ', example: 'default', }, { key: '74', name: 'CacheTime', type: 'Integer', desc: '缓存时间。', example: '10', }, { key: '75', name: 'CacheTimeUnit', type: 'String', desc: '
    缓存时间单位，支持取值：
    second：秒。
    minute：分。
    hour：小时。
    day：天。
    month：月。
    year：年。
    ', example: ' second', }, { key: '76', name: 'ParamsFilterType', type: 'String', desc: '
    生成缓存键时URL中“?”之后的参数的缓存规则，默认保留全部，支持取值：
    ignore：忽略全部参数（过滤）。
    reserve：保留所有参数（不过滤）。
    part：保留部分参数。
    excl：去除部分参数。
    ', example: 'reserve', }, { key: '77', name: 'IgnoreCase', type: 'Boolean', desc: '
    生成缓存键时是否忽略大小写，默认不忽略，支持取值：
    true：忽略。
    false：不忽略。
    ', example: 'false', }, { key: '78', name: 'ParamsReserveList', type: 'String', desc: '缓存参数列表，参数规则为part和excl时必存在，不同参数用分号相隔。', example: 'Parma;paramb', }, ], }, { key: '79', name: 'CacheKeyRules', type: '[ ]CacheKeyRule', desc: '缓存键配置。配置全站加速服务在缓存文件时，是否去除请求URL中的参数。默认生成一条根目录缓存键，不能修改规则类型和内容。', example: '-', children: [ { key: '124', name: 'Type', type: 'String', desc: '
    缓存键类型，支持取值：
    file：文件后缀。
    dir：目录。
    all：文件全路径。
    index：首页。
    pcre：全路径正则表达式。
    ', example: 'dir', }, { key: '125', name: 'Contents', type: 'String', desc: '缓存键规则,不同的缓存键对应的缓存键规则不同，详见配置缓存键规则文档。', example: '/www/dir/aaa/', }, { key: '80', name: 'ParamsFilterType', type: 'String', desc: '
    生成缓存键时URL中“?”之后的参数的缓存规则，默认保留全部，支持取值：
    ignore：忽略全部参数（过滤）。
    reserve：保留所有参数（不过滤）。
    part：保留部分参数。
    excl：去除部分参数。
    ', example: 'reserve', }, { key: '81', name: 'IgnoreCase', type: 'Boolean', desc: '
    表示配置的规则在匹配请求 URL 及生成缓存键时，是否忽略大小写，支持取值：
    true：忽略。
    false：不忽略。
    ', example: 'false', }, { key: '82', name: 'ParamsReserveList', type: 'String', desc: '缓存参数列表，参数规则为part和excl时必存在，不同参数用分号相隔。', example: 'Parma;paramb', }, ], }, { key: '83', name: 'StatusCodeCacheRule', type: 'StatusCodeCacheRule', desc: '状态码缓存规则配置。为了减轻源处理状态码的压力，您可以进行状态码缓存的配置。', example: '-', children: [ { key: '84', name: 'Enable', type: 'Boolean', desc: '
    是否启用状态码缓存功能，默认不启用，支持取值：
    true：启用。
    false：不启用。
    ', example: 'false', }, { key: '85', name: 'Rules', type: 'Rule', desc: '状态码缓存规则。当 Enable 字段为 true 时，此选项必存在。', example: '-', children: [ { key: '86', name: 'Status', type: 'String', desc: '状态码，支持取值：4xx、5xx。当 Enable 字段为 true 时，此选项必存在。', example: '404', }, { key: '87', name: 'CacheTime', type: 'Integer', desc: '缓存时间。当 Enable 字段为 true 时，此选项必存在。', example: '10', }, { key: '88', name: 'CacheTimeUnit', type: 'String', desc: '缓存时间单位，当 Enable 字段为 true 时，此选项必存在。支持取值： second：秒。 minute：分。 hour：小时。 day：天。 month：月。 year：年。', example: 'second', }, { key: '89', name: 'RespUrl', type: 'String', desc: '自定义响应界面 url ，当 Enable 字段为 true 时，此选项必存在。具体规则如下：仅支持完整的URL或者path。完整URL必须以http/https开始，path必须以/开始。', example: 'http://www.test.com', }, ], }, ], }, ], }, { key: '90', name: 'UrlRedirect', type: 'UrlRedirect', desc: 'Url 重写相关配置。当客户端请求资源的 URL 和全站加速节点上缓存的 URL 不一致时，您可以进行 URL 重写。', example: '-', children: [ { key: '91', name: 'Enable', type: 'Boolean', desc: '是否启用Url重写功能，默认不启用，支持取值： true：启用。 false：不启用。', example: 'false', }, { key: '92', name: 'Rules', type: 'UrlRedirectRule', desc: 'Url 重写相关配置。当 Enable 字段为 true 时，此选项必存在。', example: '-', children: [ { key: '93', name: 'Match', type: 'String', desc: '待重写的url，当 Enable 字段为 true 时，此选项必存在。具体规则如下：以正斜线“/”开头的URL，不含http://头及域名。支持PCRE正则表达式，不包含前后“/”。', example: '/test1', }, { key: '94', name: 'Replacement', type: 'String', desc: '目标url，当 Enable 字段为 true 时，此选项必存在。具体规则如下：以正斜线“/”开头的URL，不含http://头及域名。', example: '/index.html', }, ], }, ], }, { key: '95', name: 'IpAccess', type: 'IpAccess', desc: 'Ip 访问黑/白名单。为了解决恶意 IP 盗刷、攻击等问题，需要对访问来源进行限制，您可以在全站加速控制台配置 IP 黑白名单。', example: '-', children: [ { key: '96', name: 'Enable', type: 'Boolean', desc: '是否启用IP黑/白名单功能，默认不启用，支持取值： true：启用。 false：不启用。', example: 'false', }, { key: '97', name: 'FilterType', type: 'String', desc: 'IP 黑/白名单，当 Enable 字段为 true 时，此选项必存在。支持取值： WhiteList：白名单列表，只有添加在白名单内的IP能访问加速域名下的所有资源。 BlackList：黑名单列表，添加在黑名单内的IP无法访问加速域名下的所有资源。', example: 'WhiteList', }, { key: '98', name: 'FilterList', type: '[ ]String', desc: 'IP 列表，支持配置 IP 地址和网段输入，多个 IP 通过换行分隔，最多输入100个。当 Enable 字段为 true 时，此选项必存在。', example: '[127.0.0.1]', }, ], }, { key: '99', name: 'UserAgentAccess', type: 'UserAgentAccess', desc: 'UserAgent 访问黑/白名单。如果您希望通过对用户 HTTP 请求头中的 UA 字段进行规则判断，从而进行访问者身份识别及过滤，您可以配置 User-Agent 黑白名单。', example: '-', children: [ { key: '100', name: 'Enable', type: 'Boolean', desc: '是否启用 UserAgent 黑/白名单，默认不启用，支持取值： true：启用。 false：不启用。', example: 'false', }, { key: '101', name: 'FilterType', type: 'String', desc: 'UserAgent 黑/白名单，当 Enable 字段为 true 时，此选项必存在。支持选项： WhiteList：白名单列表，只有 HTTP 请求中的 User-Agent 字段匹配到白名单内的字段，用户才可以访问当前请求的资源。 BlackList：黑名单列表，如果 HTTP 请求中的 User-Agent 字段匹配到黑名单内的字段，那么用户无法访问当前请求的资源。', example: 'WhiteList', }, { key: '102', name: 'FilterList', type: '[ ]String', desc: 'UA 列表，支持通配符号“*”，多个字段通过换行分隔，最多输入100个。', example: '\["Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0","\*cur|\*|\*IE\*"\]', }, ], }, { key: '103', name: 'RefererAccess', type: 'RefererAccess', desc: 'Referer 访问黑/白名单。为了防止网站资源被盗用，您可以配置 Referer 防盗链。', example: '-', children: [ { key: '104', name: 'Enable', type: 'Boolean', desc: '是否启用 Referer 黑/白名单，默认不启用，支持取值： true：启用。 false：不启用。', example: 'false', }, { key: '105', name: 'FilterType', type: '[ ]String', desc: 'UserAgent 黑/白名单，当 Enable 字段为 true 时，此选项必存在。支持选项： WhiteList：白名单列表，只有 HTTP 请求中的 Referer 内容匹配到白名单内容，用户才可以访问当前请求的资源。 BlackList：黑名单列表，如果HTTP 请求中的 Referer 内容匹配到黑名单内容，那么用户无法访问当前请求的资源。', example: 'WhiteList', }, { key: '119', name: 'AllowNone', type: 'Boolean', desc: '是否允许Referer字段为空，默认不允许，即便当 Enable 字段为 true 时，本字段也可不填。支持取值： true：允许。 false：不允许。', example: 'false', }, { key: '106', name: 'FilterList', type: '[ ]String', desc: '具体 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"\]', }, ], }, { key: '107', name: 'UrlAccess', type: 'UrlAccess', desc: 'Url 鉴权。为了保护站点资源，避免资源被恶意下载盗用，您还可以通过配置 URL 鉴权，达到防止资源被非法下载盗用、提升内容安全性的目的。', example: '-', children: [ { key: '108', name: 'Enable', type: 'Boolean', desc: '是否开启 Url 鉴权，默认不启用，支持取值： true：启用。 false：不启用。', example: 'false', }, { key: '109', name: 'GenType', type: 'String', desc: '鉴权类型，当 Enable 字段为 true 时，此选项必存在。详见访问控制，支持取值： TypeA。 TypeB。 TypeC。 TypeD。', example: 'TypeC', }, { key: '110', name: 'GenKey', type: 'String', desc: '鉴权密钥，支持6-40位大/小写字母、数字。当 Enable 字段为 true 时，此选项必存在。', example: 'XXM6KuY1p', }, { key: '111', name: 'GenTTL', type: 'Integer', desc: '有效时间，单位为秒，范围为：0~31536000。当 Enable 字段为 true 时，此选项必存在。', example: '30', }, ], }, { key: '112', name: 'WebSocket', type: 'Integer', desc: 'WebSockect 相关配置。当您处于服务端主动推送数据信息到客户端、实时通讯性要求高的业务场景时，可以选择开启 WebSocket 服务。', example: '-', children: [ { key: '113', name: 'Enable', type: 'Boolean', desc: '是否开启 WebSocket 协议，默认不启用，支持取值： true：启用。 false：不启用。', example: 'false', }, { key: '114', name: 'Timeout', type: 'Integer', desc: '超时时间，单位为秒。取值范围 [1，900]。当 Enable 字段为 true 时，此选项必存在。', example: '10', }, ], }, { key: '115', name: 'GzipCompress', type: 'CmpTypeConf', desc: 'Gzip压缩。开启Gzip压缩后，全站加速在返回内容时会对资源进行Gzip压缩，减少静态内容大小，节省开销。', example: '-', children: [ { key: '116', name: 'Enable', type: 'Boolean', desc: '是否开启压缩配置，默认不启用，支持取值： true：启用。 false：不启用。', example: 'false', }, ], }, { key: '117', name: 'BrCompress', type: 'CmpTypeConf', desc: ' Br压缩。开启 Brotli 压缩后，全站加速在返回内容时会对资源进行 Brotli 压缩，减少静态内容大小，节省开销。', example: '-', children: [ { key: '118', name: 'Enable', type: 'Boolean', desc: '是否开启压缩配置，默认不启用，支持取值： true：启用。 false：不启用。', example: 'false', }, ], }, { key: '120', name: 'StaticOptimization', type: 'StaticOptimizationInfo', desc: ' 页面性能优化。H2协议多路复用场景下，通过调整缓冲区策略，控制静态资源请求优先级，实现静态页面加载性能优化。', example: '-', children: [ { key: '121', name: 'Enable', type: 'Boolean', desc: '是否启用页面性能优化，默认不启用，支持取值： true：启用。 false：不启用。', example: 'false', }, ], }, { key: '120', name: 'BusinessScene', type: 'String', desc: '加速场景，此字段为空时默认为other。具体取值如下： api：API加速场景。 page：页面加速场景。 other（默认值）：其他加速场景。', example: 'other', }, { key: '121', name: 'PreConnect ', type: 'PreConnect', desc: '预连接。开启后预连接后，DCDN服务主动与源站建立连接，维护连接池，提高回源连接复用率，缩短访问链路耗时。', example: '-', children: [ { key: '122', name: 'Enable', type: 'Boolean', desc: '是否开启预连接配置，默认不启用，支持取值： true：启用。 false：不启用。', example: 'false', }, ], }, { key: '123', name: 'RTTOptimize ', type: 'RTTOptimize', desc: '回源链路择优。开启回源链路择优后，DCDN服务会选择最优的RTT链路回源，缩短访问链路耗时。', example: '-', children: [ { key: '124', name: 'Enable', type: 'Boolean', desc: '是否开启回源链路择优，开启前需要先开启预连接，默认不启用，支持取值： true：启用。 false：不启用。', example: 'false', }, ], }, ]; return (

);
```


  









## 示例

### 请求示例

```
POST https://open.volcengineapi.com/?Version=2021-04-01&Action=DescribeDomainConfig&<其他公共请求参数>
{
    "Domains": ["www.test.com"]
}
```

### 响应示例

```
{
    "ResponseMetadata": {
        "RequestId": "20220105******0102252431250711DE66",
        "Action": "DescribeDomainConfig",
        "Version": "2021-04-01",
        "Service": "dcdn",
        "Region": "cn-north-1"
    },
    "Result": [
        {
            "Domain": "www.test.com",
            "Cname": "www.test.com.a.b.com",
            "Status": "Deploy",
            "UserName": "2000000191",
            "CreateTime": "2021-12-12 19:17:17",
            "UpdateTime": "2022-01-05 18:35:38",
            "Origin": {
                "Origins": [
                    {
                        "Name": "36.150.2.22",
                        "Weight": 1
                    },
                    {
                        "Name": "219.151.146.52",
                        "Weight": 1
                    }
                ],
                "OriginType": "IP",
                "OriginProtocolType": "http",
                "BackupOrigins": [
                    {
                        "Name": "219.151.146.52",
                        "Weight": 1
                    }
                ],
                "BackupOriginType": "IP",
                "ResponseTimeout": 10,
                "ResponseHeader": {
                    "Enable": false,
                    "HeaderInfo": []
                },
                "OriginHost": {
                    "Enable": false,
                    "HostInfo": ""
                },
                "OriginSni": {
                    "Enable": false,
                    "SniInfo": ""
                },
                "OriginRange": {
                    "Enable": false,
                    "Size": ""
                }
            },
            "Https": {
                "Http2": false,
                "Hsts": {
                    "Enable": false,
                    "MaxAge": 0,
                    "IncludeSubDomain": false
                },
                "TlsVersions": {
                    "Enable": true,
                    "TlsVersion": [
                        "TLSv1",
                        "TLSv1.1",
                        "TLSv1.2"
                    ]
                },
                "CertBind": {
                    "CertSource": "self",
                    "CertId": "cert-rvAQS*****3tDseHQ3KGyA",
                    "CertName": "*.qa.com",
                    "DomainName": "www.test1.com",
                    "DomainId": "l7accdomain-u27eF8d*****ZUTBLnSJYA",
                    "DeployStatus": "Waiting",
                    "Expire": "2022-09-22T12:35:41Z"
                },
                "ForceRedirect": {
                    "Enable": false,
                    "RedirectType": "https"
                },
                "QUICSwitch": false
            },
            "StrategyType": "wrr",
            "EnableFailOver": true,
            "IpAccess": {
                "Enable": false,
                "FilterType": "",
                "FilterList": []
            },
            "UserAgentAccess": {
                "Enable": false,
                "FilterType": "",
                "FilterList": []
            },
            "RefererAccess": {
                "Enable": false,
                "AllowNone": false,
                "FilterType": "",
                "FilterList": []
            },
            "UrlAccess": {
                "Enable": false,
                "GenType": "",
                "GenKey": "",
                "GenTTL": 0
            },
            "IPv6Switch": false,
            "Cache": {
                "Enable": false,
                "CacheRules": [],
                "StatusCodeCacheRule": {
                    "Enable": true,
                    "Rules": [
                        {
                            "Status": "404",
                            "CacheTime": 10,
                            "CacheTimeUnit": "second",
                            "RespUrl": "",
                            "RespCode": ""
                        },
                        {
                            "Status": "405",
                            "CacheTime": 10,
                            "CacheTimeUnit": "second",
                            "RespUrl": "",
                            "RespCode": ""
                        },
                        {
                            "Status": "501",
                            "CacheTime": 10,
                            "CacheTimeUnit": "second",
                            "RespUrl": "",
                            "RespCode": ""
                        }
                    ]
                }
            },
            "RecordFiling": "recovery",
            "WebSocket": {
                "Enable": false,
                "Timeout": 0
            },
            "UrlRedirect": {
                "Enable": false,
                "Rules": []
            }
        }
    ]
}
```