查询域名配置接口

domain_name

是

String

参数解释：

加速域名

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

enterprise_project_id

否

String

参数解释：

企业项目id。您可以通过调用企业项目管理服务（EPS）的查询企业项目列表接口（ListEnterpriseProject）查询企业项目id

约束限制：

当用户开启企业项目功能时，该参数生效，表示查询资源所属项目，"all"表示所有项目

取值范围：

不涉及

默认取值：

不涉及

show_special_configs

否

String

参数解释：

是否展示特殊配置

约束限制：

不涉及

取值范围：

auth_key: 用来查询鉴权KEY和鉴权备KEY的值

默认取值：

不涉及

X-Auth-Token

是

String

参数解释：

用户鉴权Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

configs

ConfigsGetBody object

配置项。

business_type

String

业务类型：

• web：网站加速；

• download：文件下载加速；

• video：点播加速；

• wholesite：全站加速。

service_area

String

服务区域：

• mainland_china：中国大陆；

• global：全球；

• outside_mainland_china：中国大陆境外。

remark

String

域名备注。

origin_request_header

Array of OriginRequestHeader objects

回源请求头配置。

http_response_header

Array of HttpResponseHeader objects

http header配置。

url_auth

UrlAuthGetBody object

URL鉴权查询响应体。

https

HttpGetBody object

证书配置查询响应体。

sources

Array of SourcesConfigResponseBody objects

源站配置。

origin_protocol

String

回源协议，follow：协议跟随回源，http：HTTP回源(默认)，https：https回源。

origin_follow302_status

String

回源跟随，on：开启，off：关闭。

cache_rules

Array of CacheRules objects

缓存规则。

ip_filter

IpFilter object

参数解释：

IP黑白名单，对用户的请求IP地址进行过滤，从而限制访问来源

约束限制：

不涉及

referer

RefererConfig object

参数解释：

referer黑白名单，对访问者身份进行识别和过滤，从而限制访问来源

约束限制：

不涉及

force_redirect

ForceRedirectConfig object

参数解释：

强制客户端使用HTTPS或HTTP协议访问CDN节点

约束限制：

不涉及

compress

Compress object

参数解释：

智能压缩，压缩网站的静态资源，缩小传输文件的大小，提升传输效率，减少带宽消耗

约束限制：

不涉及

cache_url_parameter_filter

CacheUrlParameterFilterGetBody object

缓存url参数配置查询响应体，

ipv6_accelerate

Integer

ipv6设置，1：打开；0：关闭。

error_code_cache

Array of ErrorCodeCache objects

状态码缓存时间。

origin_range_status

String

Range回源，开启: on，off:关闭。

user_agent_filter

UserAgentFilter object

参数解释：

UA黑白名单，对用户请求使用的代理过滤，从而限制访问来源

约束限制：

不涉及

origin_request_url_rewrite

Array of OriginRequestUrlRewrite objects

改写回源URL。

flexible_origin

Array of flexibleOrigins objects

高级回源。

slice_etag_status

String

回源是否校验ETag，on：开启，off：关闭。

origin_receive_timeout

Integer

回源超时时间，单位：秒。

remote_auth

commonRemoteAuth object

参数解释：

配置远程鉴权，当用户向CDN节点请求资源时，CDN将用户请求转发到客户指定的鉴权服务器，CDN根据鉴权服务器返回的结果判断是否给用户返回资源

约束限制：

不涉及

websocket

webSocketSeek object

参数解释：

是否允许客户端使用websocket协议访问CDN节点

约束限制：

• 仅全站加速的域名支持该配置

• WebSocket协议和配置HTTP/2功能不兼容，请勿同时开启

video_seek

videoSeek object

参数解释：

视频拖拽配置，用户可随意拖拽播放进度且不影响观看效果

约束限制：

• 需同步开启FLV、MP4格式文件的URL参数功能，并选择“忽略参数”

• 关闭视频拖拽功能时，FLV时间拖拽功能失效

request_limit_rules

Array of RequestLimitRules objects

参数解释：

请求限速配置

约束限制：

不涉及

ip_frequency_limit

IpFrequencyLimitQuery object

Ip访问限频。

hsts

HstsQuery object

HSTS：配置HSTS后，将强制客户端（如浏览器）使用 HTTPS 协议访问服务器，提升访问安全性。

quic

Quic object

参数解释：

QUIC协议，客户端使用QUIC协议访问CDN节点，提高了传输的安全性，减少传输和连接时的延时，避免网络拥塞

约束限制：

不涉及

error_code_redirect_rules

Array of ErrorCodeRedirectRules objects

自定义错误页面

sni

Sni object

参数解释：

回源SNI，如果源站IP绑定了多个域名，当CDN节点以HTTPS协议访问源站时，可以设置回源SNI，指定HTTPS协议握手时使用的SNI域名

约束限制：

不涉及

request_url_rewrite

Array of RequestUrlRewrite objects

访问URL重写。

browser_cache_rules

Array of BrowserCacheRules objects

浏览器缓存过期时间。

access_area_filter

Array of AccessAreaFilter objects

参数解释：

区域访问控制，限制某些地理位置的用户访问

约束限制：

不涉及

client_cert

ClientCert object

参数解释：

客户端证书配置，实现客户端与CDN节点的双向证书认证，提高网站通信安全性

约束限制：

不涉及

name

String

参数解释：

设置回源请求头参数

约束限制：

不涉及

取值范围：

• 1-100个字符

• 由数字，大小写字母，中划线组成

• 只能以字母开头

默认取值：

不涉及

value

String

参数解释：

设置回源请求头参数的值

约束限制：

不涉及

取值范围：

• 1-1000个字符

• 由数字0 - 9、字符a - z、A - Z，及特殊符“.”、“-”、“_”、“*”、“#”、“!”、“&”、“+”、“|”、“^”、“~”、“'”、“"”、“/”、“:”、“;”、“,”、“=”、“@”、“?”、“<”、“>”组成

• 当为删除动作时，可不填

• 不支持中文

• 不支持变量配置，如：$client_ip,$remote_port等

默认取值：

不涉及

action

String

参数解释：

回源请求头设置类型

约束限制：

• 同一个请求头字段只允许删除或者设置

• action为set时，若原回源请求头参数不存在该字段，则执行新增动作。若存在，则执行修改动作

取值范围：

• delete: 删除

• set: 设置

默认取值：

不涉及

name

String

参数解释：

设置HTTP响应头参数

约束限制：

不涉及

取值范围：

• 1-100个字符

• 由数字，大小写字母，中划线组成，只能以字母开头

默认取值：

不涉及

value

String

参数解释：

设置HTTP响应头参数的值

约束限制：

不涉及

取值范围：

• 1-1000个字符

• 支持字母、数字和特定字符，如：.-_*#!&+|^~'"/:;,=@?<> 等

• 当为删除动作时，可不填

默认取值：

不涉及

action

String

参数解释：

设置HTTP响应头操作类型

约束限制：

• 同一个响应头字段只允许删除或者设置

• action为set时，若原HTTP响应头参数不存在该字段，则执行新增动作。若存在，则执行修改动作

取值范围：

• set: 设置

• delete: 删除

默认取值：

不涉及

status

String

是否开启URL鉴权，on：开启,off：关闭。

type

String

鉴权方式，

type_a：鉴权方式A，

type_b：鉴权方式B，

type_c1：鉴权方式C1，

type_c2：鉴权方式C2。

expire_time

Integer

过期时间，单位：秒。

sign_method

String

加密算法。

match_type

String

鉴权范围。

inherit_config

InheritConfigQuery object

鉴权继承，为M3U8/MPD索引文件下的TS/MP4文件添加鉴权参数，解决因鉴权不通过导致的TS/MP4文件无法播放的问题。

key

String

鉴权KEY。

backup_key

String

鉴权KEY（备）。

sign_arg

String

鉴权参数。

time_format

String

时间格式，

dec：十进制,

hex：十六进制。

time_arg

String

时间参数。

status

String

是否开启鉴权继承，on：开启,off：关闭。

inherit_type

String

鉴权继承配置，

m3u8：M3U8,mpd：MPD,“m3u8,mpd”。

inherit_time_type

String

鉴权继承的文件类型时间,

sys_time：当前系统时间，parent_url_time：与m3u8和mpd访问链接保持一致。

https_status

String

HTTPS证书是否启用，on：开启，off：关闭。

certificate_type

String

证书类型。server：国际证书；server_sm：国密证书。

certificate_source

Integer

证书来源,1：华为云托管证书,0：自有证书。2：SCM证书。

scm_certificate_id

String

SCM证书id

certificate_name

String

证书名字。

certificate_value

String

HTTPS协议使用的证书内容，PEM编码格式。

expire_time

Long

证书过期时间。

enc_certificate_value

String

国密证书加密证书内容，PEM编码格式。

certificates

Array of CertificatesGetBody objects

双证书配置查询响应体。

http2_status

String

是否使用HTTP2.0，on：是，off：否。

tls_version

String

传输层安全性协议。

ocsp_stapling_status

String

是否开启ocsp stapling,on：是，off：否。

certificate_source

Integer

证书来源,0：自有证书。2：SCM证书。

scm_certificate_id

String

SCM证书id

certificate_type

String

证书类型，server：国际证书；server_sm：国密证书。

certificate_name

String

证书名字。

certificate_value

String

HTTPS协议使用的证书内容，PEM编码格式。

enc_certificate_value

String

国密证书加密证书内容，PEM编码格式。

expire_time

Long

证书过期时间。

origin_type

String

源站类型，

• ipaddr：源站IP；

• domain：源站域名；

• obs_bucket：OBS桶域名；

• third_bucket：第三方桶，使用该源站类型需要提交工单申请。

origin_addr

String

源站IP或者域名。

priority

Integer

源站优先级，70：主，30：备。

weight

Integer

权重，取值范围1-100。

obs_web_hosting_status

String

是否开启OBS静态网站托管，源站类型为obs_bucket时传递，off：关闭，on：开启。

http_port

Integer

HTTP端口，默认80,端口取值取值范围1-65535。

https_port

Integer

HTTPS端口，默认443,端口取值取值范围1-65535。

host_name

String

回源HOST，默认加速域名。

obs_bucket_type

String

OBS桶类型。

• private: 私有桶（除桶ACL授权外的其他用户无桶的访问权限）。

• public: 公有桶（任何用户都可以对桶内对象进行读操作）。

bucket_access_key

String

第三方对象存储访问密钥。

bucket_secret_key

String

第三方对象存储密钥。

bucket_region

String

第三方对象存储区域。

bucket_name

String

第三方对象存储名称。

match_type

String

参数解释：

匹配类型

约束限制：

不涉及

取值范围：

• all: 匹配所有文件

• file_extension: 按文件后缀匹配

• catalog: 按目录匹配

• full_path: 全路径匹配

• home_page: 按首页匹配

默认取值：

不涉及

match_value

String

参数解释：

缓存规则匹配内容

约束限制：

• 当match_type为all时，置空

• 当match_type为file_extension时，为文件后缀，输入首字符为“.”，以“,”或“;”分隔，如.jpg,.zip,.exe，并且输入的文件名后缀总数不超过100个，总字符不超过1000

• 当match_type为catalog时，为目录路径，输入要求以“/”作为首字符， 以“,”或“;”分隔，如/test/folder01,/test/folder02，并且输入的目录路径总数不超过20个，总字符不超过255

• 当match_type为full_path时，为全路径，输入要求以“/”作为首字符，支持匹配指定目录下的具体文件，或者带通配符“*”的文件，单条全路径缓存规则里仅支持配置一个全路径，如/test/index.html或/test/*.jpg，不可配置/*

• 当match_type为home_page时，置空

取值范围：

不涉及

默认取值：

不涉及

ttl

Integer

参数解释：

资源在CDN节点的缓存过期时间

约束限制：

最大支持365天

取值范围：

不涉及

默认取值：

0

ttl_unit

String

参数解释：

缓存过期时间单位

约束限制：

不涉及

取值范围：

• s: 秒

• m: 分

• h: 小时

• d: 天

默认取值：

不涉及

priority

Integer

参数解释：

缓存规则的优先级，数值越大，优先级越高

约束限制：

优先级不能相同

取值范围：

1-100

默认取值：

不涉及

follow_origin

String

参数解释：

缓存过期时间来源，设置CDN节点的缓存遵循源站还是CDN侧的配置

约束限制：

不涉及

取值范围：

• on: CDN节点的缓存过期时间遵循源站的设置

• off: CDN节点的缓存过期时间遵循“缓存规则”中的“缓存过期时间”

• min_ttl: CDN节点的缓存过期时间取缓存规则和源站二者的最小值

默认取值：

off: CDN节点的缓存过期时间遵循“缓存规则”中的“缓存过期时间”

force_cache

String

参数解释：

强制缓存：CDN节点缓存过期时间是否忽略源站响应头Cache-Control中的no-cache、private、no-store字段

约束限制：

强制缓存与缓存过期时间来源功能配合使用，具体使用限制及配置效果请参考CDN用户指南的配置节点缓存规则章节

取值范围：

• on: 打开强制缓存

• off: 关闭强制缓存

默认取值：

off: 关闭强制缓存

url_parameter_type

String

参数解释：

URL参数

约束限制：

不涉及

取值范围：

• del_params: 忽略指定URL参数

• reserve_params: 保留指定URL参数

• ignore_url_params: 忽略全部URL参数

• full_url: 使用完整URL参数

默认取值：

full_url: 使用完整URL参数

url_parameter_value

String

参数解释：

URL参数值

约束限制：

• 最多配置30条参数值

• 以“,”或“;”分隔

• 当url_parameter_type为del_params或reserve_params时必填

取值范围：

不涉及

默认取值：

不涉及

type

String

参数解释：

IP黑白名单类型

约束限制：

不涉及

取值范围：

• off: 关闭IP黑白名单

• black: IP黑名单

• white: IP白名单

默认取值：

不涉及

value

String

参数解释：

配置IP黑白名单

约束限制：

• 当type=off时，非必传

• 多条规则用“,”分隔

• 最多支持配置500条规则

• 多个完全重复的IP/IP段将合并为一条规则

• 不支持带通配符的地址，如192.168.0.*

取值范围：

不涉及

默认取值：

不涉及

type

String

参数解释：

Referer黑白名单类型

约束限制：

不涉及

取值范围：

• off: 关闭Referer黑白名单

• black: Referer黑名单

• white: Referer白名单

默认取值：

不涉及

value

String

参数解释：

域名或IP地址

约束限制：

• 以“,”进行分隔

• 域名、IP地址总数不超过1000个

• 端口取值范围1-65535

取值范围：

不涉及

默认取值：

不涉及

include_empty

Boolean

参数解释：

是否包含空Referer

约束限制：

不涉及

取值范围：

• true: 包含空

• false: 不包含空

默认取值：

false: 不包含空

status

String

参数解释：

强制跳转开关

约束限制：

不涉及

取值范围：

• on: 开启

• off: 关闭

默认取值：

不涉及

type

String

参数解释：

强制跳转类型

约束限制：

如果开启强制跳转HTTPS，请先配置HTTPS证书，否则将导致访问失败

取值范围：

• http: 强制跳转HTTP

• https: 强制跳转HTTPS

默认取值：

不涉及

redirect_code

Integer

参数解释：

重定向跳转码

约束限制：

不涉及

取值范围：

• 301

• 302

• 307

默认取值：

不涉及

status

String

参数解释：

智能压缩开关

约束限制：

不涉及

取值范围：

• on: 开启

• off: 关闭

默认取值：

不涉及

type

String

参数解释：

智能压缩类型

约束限制：

当配置了多种智能压缩类型时，优先使用brotli压缩

取值范围：

多种智能压缩类型用“,”分隔，可选值如下：

• gzip: gzip压缩

• br: brotli压缩

默认取值：

不涉及

file_type

String

参数解释：

需要压缩的文件类型

约束限制：

不涉及

取值范围：

• 内容总长度不可超过2000个字符

• 单个格式不可超过50个字符

• 多种格式用“,”分隔

默认取值：

开启状态下，首次传空时默认值为.js,.html,.css,.xml,.json,.shtml,.htm，否则为上次设置值

compress_min_length

Integer

参数解释：

压缩区间最小范围

约束限制：

如果未设置参与压缩的文件大小，默认大小为“0MB～30MB”的文件参与压缩。

取值范围：

• 文件大小范围（0MB～30MB），单位为Byte

默认取值：

不涉及

compress_max_length

Integer

参数解释：

压缩区间最大范围

约束限制：

如果未设置参与压缩的文件大小，默认大小为“0MB～30MB”的文件参与压缩。

取值范围：

• 文件大小范围（0MB～30MB），单位为Byte

默认取值：

不涉及

type

String

缓存URL参数操作类型：

• full_url：缓存所有参数；

• ignore_url_params：忽略所有参数；

• del_params：忽略指定URL参数；

• reserve_params：保留指定URL参数。

  说明：

  本接口参数有调整，参数替换如下：

  • del_params替代del_args。

  • reserve_params替代reserve_args。

value

String

参数值。

code

Integer

参数解释：

需要缓存的错误码

约束限制：

不涉及

取值范围：

• 3xx: 301, 302

• 4xx: 400, 403, 404, 405, 407, 414, 416, 451

• 5xx: 500, 501, 502, 503, 504, 509, 514

默认取值：

不涉及

ttl

Integer

参数解释：

错误码缓存时间

约束限制：

不涉及

取值范围：

0-31536000，单位：秒

默认取值：

不涉及

type

String

参数解释：

UA黑白名单类型

约束限制：

不涉及

取值范围：

• off: 关闭UA黑白名单

• black: UA黑名单

• white: UA白名单

默认取值：

不涉及

value

String

参数解释：

UA黑白名单内容

约束限制：

• 当type=off时，非必传

• 最多配置50条规则

• 多条规则用“,”分隔

取值范围：

• 单条规则不超过200个字符

• 支持数字0-9、字符a-z、A-Z，空格，及特殊符"*"、"."、"-"、"_"、"("、")"、";"、","、"/"、"'"、"#"、"!"、"@"、"$"、"^"、"&"、"+"、"="、"~"、"?"、"""、"["、"]"、"{"、"}"、""、":"、"%"

默认取值：

不涉及

include_empty

Boolean

参数解释：

是否包含空UA

约束限制：

不涉及

取值范围：

true: 包含空

false:不包含空

默认取值：

• 当UA为黑名单时该字段默认值为false

• 当UA为白名单时该字段默认值为true

ua_list

Array of strings

参数解释：

配置UA黑白名单

约束限制：

• 当type=off时，非必传

• 最多配置50条规则

• 单条规则不超过200个字符

• 同时配置value和ua_list时，ua_list生效

priority

Integer

参数解释：

回源URL改写规则的优先级

约束限制：

• 不支持多条回源URL改写规则设置同一优先级

• 优先级不能输入为空

取值范围：

1-100

默认取值：

不涉及

match_type

String

参数解释：

匹配类型

约束限制：

不涉及

取值范围：

• all: 所有文件

• file_path: URI路径

• wildcard: 通配符

• full_path: 全路径

默认取值：

不涉及

source_url

String

参数解释：

需要替换的URI

约束限制：

匹配方式为“所有文件”时，不支持配置参数

取值范围：

• 1-512个字符

• 支持通配符*匹配，如：/test/*/*.mp4

• 以正斜线（/）开头的URI，不含http(s)://头及域名

默认取值：

不涉及

target_url

String

参数解释：

替换后的URI

约束限制：

取值范围：

• 1-256个字符

• 以正斜线（/）开头的URI，不含http(s)://头及域名

默认取值：

不涉及

match_type

String

参数解释：

URI的匹配方式

约束限制：

不涉及

取值范围：

• file_extension: 文件后缀匹配

• file_path: 目录路径

默认取值：

不涉及

match_pattern

String

参数解释：

URI的匹配规则

约束限制：

match_type为file_extension时：

• 支持所有格式的文件类型

• 输入首字符为“.”，以“;”进行分隔

• 输入的文件后缀名总数不能超过20个

match_type为file_path时：

• 要求以“/”作为首字符

• 以“;”进行分隔

• 输入的目录路径总数不能超过20个

取值范围：

1-512个字符

默认取值：

不涉及

priority

Integer

参数解释：

优先级

约束限制：

不涉及

取值范围：

1-100

默认取值：

不涉及

back_sources

Array of backSources objects

参数解释：

配置客户端请求匹配当前规则时，CDN节点回源访问的源站

约束限制：

每条规则的回源源站数量不超过1个

取值范围：

不涉及

默认取值：

不涉及

sources_type

String

参数解释：

源站类型

约束限制：

不涉及

取值范围：

• ipaddr: 源站IP

• domain: 源站域名

• obs_bucket: OBS桶域名

默认取值：

不涉及

ip_or_domain

String

参数解释：

源站IP或者域名

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

obs_bucket_type

String

参数解释：

OBS桶类型

约束限制：

不涉及

取值范围：

• private: 私有桶

• public: 公有桶

默认取值：

public: 公有桶

http_port

Integer

参数解释：

HTTP端口

约束限制：

不涉及

取值范围：

1-65535

默认取值：

80

https_port

Integer

参数解释：

HTTPS端口

约束限制：

不涉及

取值范围：

1-65535

默认取值：

443

remote_authentication

String

参数解释：

是否开启远程鉴权

约束限制：

不涉及

取值范围：

• on: 开启

• off: 关闭

默认取值：

不涉及

remote_auth_rules

RemoteAuthRule object

参数解释：

远程鉴权配置

约束限制：

不涉及

auth_server

String

参数解释：

可访问的鉴权服务器地址

约束限制：

• 输入的URL必须有“http”或“https”

• 不能是localhost或127.0.0.1这类本地地址

• 不能是CDN的加速域名

取值范围：

不涉及

默认取值：

不涉及

request_method

String

参数解释：

鉴权服务器支持的请求方法

约束限制：

不涉及

取值范围：

• GET

• POST

• HEAD

默认取值：

不涉及

file_type_setting

String

参数解释：

参与鉴权的文件类型

约束限制：

不涉及

取值范围：

• all: 所有文件均参与鉴权

• specific_file: 指定类型的文件参与鉴权。示例：jpg|MP4

默认取值：

不涉及

specified_file_type

String

参数解释：

参与鉴权的具体文件类型

约束限制：

• 当file_type_setting等于specific_file时为必选，其余情况为空

• 文件类型用竖线分隔，例如jpg|mp4

• 只有在必选情况下才会对该字段做校验

取值范围：

• 1-512个字符

• 由大小写字母和数字构成

默认取值：

不涉及

reserve_args_setting

String

参数解释：

参加鉴权的参数

约束限制：

不涉及

取值范围：

• reserve_all_args: 保留所有URL参数

• reserve_specific_args: 保留指定URL参数

• ignore_all_args: 忽略所有URL参数

默认取值：

不涉及

reserve_args

String

参数解释：

设置参数

约束限制：

• 当reserve_args_setting为reserve_specific_args时为必选，其余情况为空

• 多个参数用竖线分隔：key1|key2

取值范围：

不涉及

默认取值：

不涉及

add_custom_args_rules

Array of customArgs objects

参数解释：

设置CDN节点转发用户请求到远程鉴权服务器时需添加的参数

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

reserve_headers_setting

String

参数解释：

设置CDN节点转发用户请求到远程鉴权服务器时需要添加的请求头

约束限制：

不涉及

取值范围：

• reserve_all_headers: 保留所有请求头参数

• reserve_specific_headers: 保留指定请求头参数

• ignore_all_headers: 忽略所有请求头参数

默认取值：

不涉及

add_custom_headers_rules

Array of customArgs objects

参数解释：

请求头鉴权参数

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

auth_success_status

String

参数解释：

设置鉴权成功时远程鉴权服务器返回给CDN节点的状态码

约束限制：

不涉及

取值范围：

• 2xx

• 3xx

默认取值：

不涉及

auth_failed_status

String

参数解释：

设置鉴权失败时远程鉴权服务器返回给CDN节点的状态码

约束限制：

不涉及

取值范围：

• 4xx

• 5xx

默认取值：

不涉及

response_status

String

参数解释：

设置鉴权失败时CDN节点返回给用户的状态码

约束限制：

不涉及

取值范围：

• 2xx

• 3xx

• 4xx

• 5xx

默认取值：

不涉及

timeout

Integer

参数解释：

设置鉴权超时时间，即从CDN转发鉴权请求开始，到CDN节点收到远程鉴权服务器返回的结果的时间

约束限制：

不涉及

取值范围：

0或50-3000，单位：毫秒

默认取值：

不涉及

timeout_action

String

参数解释：

设置鉴权超时后，CDN节点如何处理用户请求

约束限制：

不涉及

取值范围：

• pass：鉴权超时后允许用户请求，返回对应的资源

• forbid：鉴权超时后拒绝用户请求，返回配置的响应自定义状态码给用户

默认取值：

不涉及

reserve_headers

String

参数解释：

要保留的请求头

约束限制：

• 当reserve_headers_setting为reserve_specific_headers时为必选，其余情况为空

• 多个请求头用竖线分隔：key1|key2

取值范围：

不涉及

默认取值：

不涉及

type

String

参数解释：

参数类型

约束限制：

不涉及

取值范围：

• custom_var: 自定义

• nginx_preset_var: 预置的变量

默认取值：

不涉及

key

String

参数解释：

参数名

约束限制：

不涉及

取值范围：

• 1-256个字符

• 由数字0-9、字符a-z、A-Z，及特殊字符._-*#%|+^@?=组成

默认取值：

不涉及

value

String

参数解释：

参数值

约束限制：

不涉及

取值范围：

• 当type为custom_var时支持1-256个字符，由数字0-9、字符a-z、A-Z，及特殊字符._-*#%|+^@?=组成

• 当type为nginx_preset_var时，value只能输入$http_host、$http_user_agent、$http_referer、$http_x_forwarded_for、$http_content_type、$remote_addr、$scheme、$server_protocol、$request_uri、$uri、$args、$request_method

默认取值：

不涉及

status

String

参数解释：

是否开启websocket协议

约束限制：

不涉及

取值范围：

• on: 开启

• off: 关闭

默认取值：

不涉及

timeout

Integer

参数解释：

请求建立连接后，会话的保持时间

约束限制：

不涉及

取值范围：

1-300，单位：秒，当status为on时必填

默认取值：

不涉及

enable_video_seek

Boolean

参数解释：

视频拖拽开关

约束限制：

当本字段设置为“false”时，查询域名配置接口将不会返回视频拖拽配置信息

取值范围：

• true: 开启

• false: 关闭

默认取值：

不涉及

enable_flv_by_time_seek

Boolean

参数解释：

flv时间拖拽开关

约束限制：

不涉及

取值范围：

• true: 开启

• false: 关闭

默认取值：

不涉及

start_parameter

String

参数解释：

自定义用户请求URL中视频播放的开始参数

约束限制：

不涉及

取值范围：

• 1-64个字符

• 支持使用数字0-9、字符a-z、A-Z，及"_"

默认取值：

不涉及

end_parameter

String

参数解释：

自定义用户请求URL中视频播放的结束参数

约束限制：

不涉及

取值范围：

• 1-64个字符

• 支持使用数字0-9、字符a-z、A-Z，及"_"

默认取值：

不涉及

status

String

参数解释：

是否开启请求限速

• 此为旧接口中的参数，后续将下线

• 只支持on，off无效

约束限制：

request_limit_rules字段置空时代表关闭请求限速功能

取值范围：

on

默认取值：

不涉及

priority

Integer

参数解释：

优先级

约束限制：

优先级不能相同

取值范围：

1-100

默认取值：

不涉及

match_type

String

参数解释：

匹配类型

约束限制：

不涉及

取值范围：

• all：所有文件

• catalog：目录

默认取值：

不涉及

match_value

String

参数解释：

匹配类型值

约束限制：

• 当match_type为all时传空值，例如：""

• 当match_type为catalog时传目录地址，以“/”作为首字符,例如："/test"

• 值为catalog的时候必填

取值范围：

不涉及

默认取值：

不涉及

type

String

参数解释：

限速方式

约束限制：

当前仅支持按流量大小限速，取值为size

取值范围：

不涉及

默认取值：

不涉及

limit_rate_after

Long

参数解释：

限速条件

约束限制：

不涉及

取值范围：

0-1073741824，单位：byte

默认取值：

不涉及

limit_rate_value

Integer

参数解释：

限速值，即达到限速条件后的最大访问速度

约束限制：

不涉及

取值范围：

0-104857600，单位：Bps

默认取值：

不涉及

limit_time

String

参数解释：

指明限速的时段

约束限制：

• 按照每天24小时设置限速时段，格式为：HHMM-HHMM（HH为时，MM为分，时区为UTC+8）

• 多个时段限速时用“,”分隔，例如：0100-0200,2200-2300

• 最多可配置10个时段

取值范围：

不涉及

默认取值：

0000-2400

status

String

状态，on：打开，off：关闭。

qps

Integer

访问阈值,单位：次/秒。

status

String

状态，on：打开，off：关闭。

max_age

Integer

过期时间,即：响应头“Strict-Transport-Security”在客户端的缓存时间。单位:秒。

include_subdomains

String

包含子域名，on：包含，off：不包含。

status

String

参数解释：

QUIC功能状态开关

约束限制：

不涉及

取值范围：

• on: 开启

• off: 关闭

默认取值：

不涉及

error_code

Integer

参数解释：

重定向的错误码

约束限制：

不涉及

取值范围：

• 4xx: 400, 403, 404, 405, 414, 416, 451

• 5xx: 500, 501, 502, 503, 504

默认取值：

不涉及

target_code

Integer

参数解释：

重定向状态码

约束限制：

不涉及

取值范围：

• 301

• 302

默认取值：

不涉及

target_link

String

参数解释：

重定向的目标链接

约束限制：

必须以http://或https://开头

取值范围：

不涉及

默认取值：

不涉及

status

String

参数解释：

是否开启回源SNI

约束限制：

不涉及

取值范围：

• on: 开启

• off: 关闭

默认取值：

不涉及

server_name

String

参数解释：

CDN节点回源时使用HTTPS协议握手的sni域名

约束限制：

• 开启回源SNI时必填

取值范围：

• 仅支持输入数字、“-”、“.”、英文大小写字符

默认取值：

condition

UrlRewriteCondition object

参数解释：

匹配条件

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

redirect_status_code

Integer

参数解释：

重定向状态码

约束限制：

不涉及

取值范围：

• 301

• 302

• 303

• 307

默认取值：

不涉及

redirect_url

String

参数解释：

重定向URL

约束限制：

• 重定向后的URL，以正斜线（/）开头，不含http://头及域名，如：/test/index.html

• 当匹配类型为全路径时，"*"可以用“$1”捕获，例如：匹配内容为/test/*.jpg，重定向URL配置为/newtest/$1.jpg，则用户请求/test/11.jpg时，$1捕获11，重定向后请求的URL为/newtest/11.jpg

取值范围：

不涉及

默认取值：

不涉及

redirect_host

String

参数解释：

支持将客户端请求重定向到其他域名

约束限制：

不涉及

取值范围：

• 1-255个字符

• 必须以http://或https://开头

默认取值：

不填时默认为当前域名

execution_mode

String

参数解释：

执行规则

约束限制：

不涉及

取值范围：

• redirect: 如果请求的URL匹配了当前规则，该请求将被重定向到目标Path。执行完当前规则后，当存在其他配置规则时，会继续匹配剩余规则

• break: 如果请求的URL匹配了当前规则，请求将被改写为目标Path。执行完当前规则后，当存在其他配置规则时，将不再匹配剩余规则，此时不支持配置重定向Host和重定向状态码，返回状态码200

默认取值：

不涉及

match_type

String

参数解释：

匹配类型

约束限制：

不涉及

取值范围：

• catalog: 指定目录下的文件需执行访问URL重写规则

• full_path: 某个完整路径下的文件需执行访问URL重写规则

默认取值：

不涉及

match_value

String

参数解释：

匹配内容

约束限制：

• 当match_type为catalog时，为目录路径，输入要求以“/”作为首字符，以“,”进行分隔，如/test/folder01,/test/folder02，并且输入的目录路径总数不超过20个

• 当match_type为full_path时，为全路径，输入要求以“/”作为首字符，支持匹配指定目录下的具体文件，或者带通配符“*”的文件，单条全路径缓存规则里仅支持配置一个全路径，如/test/index.html或/test/*.jpg

取值范围：

不涉及

默认取值：

不涉及

priority

Integer

参数解释：

访问URL重写规则的优先级

约束限制：

不支持多条规则设置同一优先级

取值范围：

1-100

默认取值：

不涉及

condition

BrowserCacheRulesCondition object

参数解释：

匹配条件

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

cache_type

String

参数解释：

缓存生效类型

约束限制：

不涉及

取值范围：

• follow_origin: 遵循源站的缓存策略，即Cache-Control头部的设置

• ttl: 浏览器缓存遵循当前规则设置的过期时间

• never: 浏览器不缓存资源

默认取值：

不涉及

ttl

Integer

参数解释：

缓存过期时间

约束限制：

• 最大支持365天

• 当缓存生效类型为ttl时必填

取值范围：

不涉及

默认取值：

不涉及

ttl_unit

String

参数解释：

缓存过期时间单位

约束限制：

当缓存生效类型为ttl时必填

取值范围：

• s：秒

• m：分钟

• h：小时

• d：天

默认取值：

不涉及

match_type

String

参数解释：

匹配类型

约束限制：

不涉及

取值范围：

• all: 匹配所有文件

• file_extension: 按文件后缀匹配

• catalog: 按目录匹配

• full_path: 全路径匹配

• home_page: 按首页匹配

默认取值：

不涉及

match_value

String

参数解释：

缓存匹配设置

约束限制：

• 当match_type为all时，置空

• 当match_type为file_extension时，为文件后缀，输入首字符为“.”，以“,”进行分隔， 如.jpg,.zip,.exe，并且输入的文 件名后缀总数不超过20个

• 当match_type为catalog时，为目录，输入要求以“/”作为首字符， 以“,”进行分隔，如/test/folder01,/test/folder02，并且输入的目录路径总数不超过20个

• 当match_type为full_path时，为全路径，输入要求以“/”作为首字符，支持匹配指定目录下的具体文件，或者带通配符“*”的文件， “*”的位置必须在最后一个“/”的后一位，且不能以“*”结尾，单条全路径缓存规则里仅支持配置一个全路径，如/test/index.html或/test/*.jpg

• 当match_type为home_page时，置空

取值范围：

不涉及

默认取值：

不涉及

priority

Integer

参数解释：

浏览器缓存的优先级, 数值越大优先级越高

约束限制：

不支持多条规则设置同一优先级

取值范围：

不涉及

默认取值：

1-100

type

String

参数解释：

规则类型

约束限制：

不涉及

取值范围：

• black: 黑名单，如果匹配到黑名单规则，则黑名单所选区域内的用户将无法访问当前资源，返回403状态码

• white: 白名单，白名单所选区域以外的用户均无法访问当前资源，返回403状态码

默认取值：

不涉及

content_type

String

参数解释：

生效类型

约束限制：

不涉及

取值范围：

• all: 所有文件，所有文件均遵循配置的规则

• file_directory: 目录路径，指定目录路径的资源遵循配置的规则

• file_path: 全路径，指定路径的资源遵循配置的规则

默认取值：

不涉及

content_value

String

参数解释：

生效规则

约束限制：

• 当content_type为all时，置空或不传

• 当content_type为file_directory时，输入要求以“/”作为首字符，多个目录以“,”进行分隔，如/test/folder01,/test/folder02，并且输入的目录路径总数不超过100个

• 当content_type为file_path时，输入要求以“/”或“*”作为首字符，支持配置通配符“*”，通配符不能连续出现且不能超过两个。多个路径以“,”进行分隔，如/test/a.txt,/test/b.txt，并且输出的总数不能超过100个

• 不允许配置两条完全一样的白名单或黑名单规则

• 仅允许配置一条生效类型为“所有文件”的规则

取值范围：

不涉及

默认取值：

不涉及

area

String

参数解释：

配置规则适用的区域

约束限制：

• 多个区域以“,”进行分隔

• 支持的区域如：CN_IN：中国大陆，AF：阿富汗，IE：爱尔兰，EG：埃及，AU：澳大利亚等。具体的位置编码参见《附录-地理位置编码》查询

取值范围：

不涉及

默认取值：

不涉及

exception_ip

String

参数解释：

例外IP，配置指定IP不执行当前规则

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

status

String

参数解释：

客户端证书配置开关

约束限制：

不涉及

取值范围：

• on: 开启

• off: 关闭

默认取值：

不涉及

trusted_cert

String

参数解释：

客户端CA证书的内容

约束限制：

仅支持PEM格式

取值范围：

不涉及

默认取值：

不涉及

hosts

String

参数解释：

客户端CA证书指定的域名

约束限制：

• 如果不配置域名，则CDN会放行所有持有该CA证书的客户端请求

• 最多可配置100个域名

• 多个域名用“,”或“|”分隔

取值范围：

不涉及

默认取值：

不涉及

200

成功响应。