相关对象定义

CacheTtl

参数	类型	可选	说明
type	String	必选	其合法值为“path”。表示缓存目录的路径。
value	String	必选	其合法值为“/”。表示根目录。
ttl	Int	必选	缓存时间，单位为秒。值为0时，表示不缓存。
weight	Int	必选	权重，其合法值为100。
override_origin	Bool	必选	表示缓存是否遵循源站。值为“true”时，表示不遵循源站，按照该条配置规则缓存。值为“false”时，表示遵循源站。

CacheKey

参数	类型	可选	说明
query	Bool	必选	其合法值为 true 和 false。true 表示保留参数缓存，false 表示忽略参数缓存。
exclude_args	List<String>	可选	忽略哪些参数缓存，只有 query = false 时才有效。
include_args	List<String>	可选	包含哪些参数缓存，只有 query = false 时才有效。

注：exclude_args 与 include_args 不可同时设置。

HSTS

参数	类型	可选	说明
maxAge	Int	必选	配置保存时间，单位为天, 用户输入值为 0 ~ 730 或者 -1，为 -1 时表示关闭该配置项。
includeSubDomains	Bool	必选	是否包含子域名。
preload	Bool	必选	是否支持预加载。

HTTP3

参数	类型	可选	说明
enable	bool	必选	开启为 true，关闭为 false。

HttpHeader

参数	类型	可选	说明
type	String	必选	"origin" 表示回源生效，"response" 表示给用户响应时生效。
header	String	必选	header 为 http 头字段，一般为 HTTP 的标准 Header，其长度限制为 128。也可以是用户自定义的 Header。
value	String	必选	指定 header 的值，其长度限制为 1000。可以是常量，也可以是变量。删除 HTTP 头时，可以传空字符串""。 字符 $ 开始的子串一定要符合 ${x} 的模式，其合法变量值为： • ${uri} 表示客户端请求的 URL 路径部分（不包含查询参数）。 • ${host} 表示客户端请求 host 头部值。 • ${scheme} 表示客户端请求协议（http 或 https）。 • ${request_uri} 表示客户端请求路径和参数（包含查询参数）。 • ${jvip} 表示节点 IP。 • ${remote_addr} 表示客户端 IP，存在代理的情况下不准确。 • ${request_id} 表示请求的唯一标识符。 典型非法值： • 变量不符合限制要求，如 "X-REQ-${url}"； • 包含 "$" 字符但不符合 "${x}" 模式，如："X-REQ-$uri" 。 注意：value 不支持 "$" 纯字符的传递，如果您希望响应客户端一个包含 "$" 符号的响应头将不被允许，如 "X-$" 是非法的。
action	String	必选	设置 HTTP 头合法值为 "add"，删除 HTTP 头合法值为 "remove"。

注：最多设置 20 条 HTTP 回源请求头规则，最多设置 20 条 HTTP 节点响应头规则。不支持删除 "ohc"，"baidu" 开头的回源请求头。

CacheTtlCode

参数	类型	可选	说明
type	String	必选	合法值为"code"，表示异常状态码缓存。
value	String	必选	状态码的合法值为： • 4xx：400、401、403、404、405、407、414、451 • 5xx：500、501、502、503、504、509、514
ttl	Int	必选	缓存时间，单位为秒。取值范围：0-315360000。
overrideOrigin	Bool	必选	缓存是否遵循源站，其合法值为“true”。
weight	Int	必选	权重，其合法值为 100 。

注：最多支持设置 15 条状态码缓存规则，且规则不可重复设置。

PageRule

参数	类型	可选	说明
name	String	必选	规则名称。
status	String	必选	合法值为 "ON" 和 "OFF"，默认值为 "ON"。"OFF" 表示关闭该项，指该项在配置中存在，但在节点上不生效。
rules	array<array<Rule>>	必选	规则的判断条件，其本身是个二维数组结构。 可以理解为，rules 分为多组条件集，每组内又有多个条件。组内的 n 个条件是 “且” 的关系，组与组之间是 “或” 关系。 举例： rules = [ [a, b], [c, d] ] 其中，rules 有两组条件集，组1 为 [a, b]，组2为 [c, d]。其表达的含义：当表达式 (a && b) || (c && d) 为真时，会执行 config 配置。 限制： • 当 matchFrom 为 header 、 arg 或 cookie 时，组内的多个条件中， matchKey 不能重复。 • 当 matchFrom 为 header，判断 matchKey 是否相等时不区分大小写。比如，我们认为 "user-agent" 和 "User-Agent" 是相等的。 • 不同组中的 matchKey 可以重复。 • 一个组内，matchFrom="host/fullUrl/basename/remoteAddrs/method/remoteGeos/remoteIsp/suffix/path/directory"的条件只能有一个。
config	List<Config>	必选	规则引擎支持的配置项

注：

• 请求体的总大小不能超过 500K。
• 各套餐的规则数目限制如下（指 pageRules 数组的元素个数必须小于等于以下限制）：

	基础版	标准版	高级版	企业版
可配置规则数	20条	50条	100条	200条

• 针对同一配置，规则引擎的优先级高于全局配置，规则引擎的配置优先生效。
• 新增规则应在最下方，执行顺序从上往下，最上方优先级更高。您可以根据需要在配置过程中调整规则顺序。

Rule

参数	类型	可选	说明
matchFrom	String	必选	匹配类型。 其合法值为： 1. host 2. header（需输入 header key）（HTTP请求头） 3. arg（需输入参数 key）（查询字符串） 4. suffix（文件后缀） 5. path（URL Path） 6. fullUrl（URL full） 7. basename（文件名称） 8. remoteAddrs（客户端IP） 9. method（请求方法） 10. cookie 11. remoteGeos（客户端地理位置） 12. remoteIsp（客户端运营商） 13. directory（文件目录） 各个匹配类型支持的操作符（“操作符” 概念详见下一行说明）分别如下： 1. host     a. inValues     b. notInValues 2.header     a. inValues     b. notInValues     c. exists     d. notExists     e. regex     f. notRegex 3.arg     a. inValues     b. notInValues     c. exists     d. notExists     e. regex     f. notRegex 4. suffix     a. inValues     b. notInValues     c. regex     d. notRegex 5. path     a. inValues     b. notInValues     c. regex     d. notRegex 6. fullUrl     a. inValues     b. notInValues     c. regex     d. notRegex 7. basename     a. inValues     b. notInValues     c. regex     d. notRegex 8. remoteAddrs     a. inValues     b. notInValues 9.method     a. inValues     b. notInValues 10. cookie     a. inValues     b. notInValues     c. exists     d. notExists     e. regex     f. notRegex 11. remoteGeos     a. inValues     b. notInValues 12. remoteIsp     a. inValues     b. notInValues 13.directory     a. inValues     b. notInValues
operator	String	必选	操作符。 其合法值为： • inValues：等于多值之一 • notInValues：不等于任一值 • exists：matchKey 存在 • notExists：matchKey 不存在 • regex：正则匹配 • notRegex：正则不匹配. 其中支持正则匹配/正则不匹配的匹配类型为： • path（URL Path） • fullUrl（URL full） • arg（查询字符串） • suffix（文件后缀） • basename（文件名称） • header（HTTP请求头） • method（请求方法） • cookie
matchKey	String	可选	仅在 matchFrom 为 header 、 arg 或 cookie 时，此值有效。不能存在重复的 key。您可以参照MatchKey获取更详细的限制说明。
values	List<String> 或 String	可选	值列表。您可以参照Value获取更详细的值说明。 限制： •当 matchFrom 为 header 或 arg 且 operator 为 exists 或 notExists时，该项不能传值。 •当 matchFrom 为 cookie 且 operator 为 exists 或 notExists时，该项可选填。
ignoreCase	bool	可选	匹配条件的参数值可以忽略大小写，合法值为：true或false。true 表示忽略大小写， false 表示不忽略大小写。 支持忽略大小写的匹配条件为： • path（URL Path） • fullUrl（URL full） • arg（查询字符串） • suffix（文件后缀） • basename（文件名称） • header（HTTP请求头） • method（请求方法） • cookie

规则引擎匹配类型与配置项支持关系

匹配类型 matchFrom	不支持的配置项
host	—
header	http3、http2Disable、http2Origin、originTimeout、isa、compress
arg	http3、http2Disable、http2Origin、originTimeout、isa、compress
suffix	http3、http2Disable、http2Origin、originTimeout、isa、compress
path	http3、http2Disable、http2Origin、originTimeout、isa、compress
fullUrl	http3、http2Disable、http2Origin、originTimeout、isa、compress
directory	http3、http2Disable、http2Origin、originTimeout、isa、compress
basename	httpToHttpsEnabled、httpToHttpsCode、hsts、http3、http2Disable、http2Origin、isa、originTimeout、compress
remoteAddrs	httpToHttpsEnabled、httpToHttpsCode、hsts、http3、http2Disable、http2Origin、isa、originTimeout、compress
cookie	httpToHttpsEnabled、httpToHttpsCode、hsts、http3、http2Disable、http2Origin、isa、originTimeout、compress
remoteGeos	httpToHttpsEnabled、httpToHttpsCode、hsts、http3、http2Disable、http2Origin、isa、originTimeout、compress
remoteIsp	httpToHttpsEnabled、httpToHttpsCode、hsts、http3、http2Disable、http2Origin、isa、originTimeout
method	cacheTtl、cacheKey、httpToHttpsEnabled、httpToHttpsCode、hsts、http3、http2Disable、http2Origin、isa、originTimeout

Config

配置项参数	说明
cacheTtl	节点缓存配置,可参考CacheTtl 。
cacheKey	自定义 cache key 配置，可参考Rule.CacheKey
offlineMode	离线模式配置，可参考OfflineMode
refreshRevalidate	忽略客户端刷新配置，可参考RefreshRevalidate
httpToHttpsEnabled	强制 HTTPS 开关配置，可参考HttpToHttpsEnabled
httpToHttpsCode	强制 HTTPS 状态码配置，可参考HttpToHttpsCode
hsts	HSTS 状态码配置，可参考HSTS
isa	智能加速配置，可参考Isa
http2Disable	HTTP2配置，可参考HTTP2
http3	HTTP3配置，可参考HTTP3
webSocket	webSocket配置，可参考WebSocket
http2Origin	HTTP2回源配置，可参考Http2Origin
clientMaxBodySize	最大上传大小配置，可参考ClientMaxBodySize
compress	页面压缩开关配置，可参考Compress
compressMethodArray	页面压缩方法配置，可参考CompressMethodArray
httpHeader	自定义http头部配置，可参考HttpHeader
originTimeout	回源超时时间配置，可参考OriginTimeout
originRedirectOptions	回源301/302跟随配置，可参考OriginRedirectOptions
originOptions	回源range配置，可参考OriginOptions
realIp	用户IP获取配置，可参考RealIp
errorPage	自定义错误页面配置，可参考ErrorPage
trafficLimit	单链接限速配置，可参考TrafficLimit
antiHotLink	URL鉴权配置，可参考AntiHotLink
originArg	回源请求参数配置，可参考OriginArg
urlRules	访问URL重定向配置，可参考UrlRules

MatchKey

匹配类型	操作符	值说明
arg	inValues、notInValues、exists、notExists、regex、notRegex	1 - 100 个字符，可由字母（a - z，A - Z）、数字（0 - 9）、以及部分特殊字符组成。
header	inValues、notInValues、exists、notExists、regex、notRegex	1 - 100 个字符，可由字母（a - z，A - Z）、数字（0 - 9）、以及部分特殊字符组成。可支持自定义。
cookie	inValues、notInValues、exists、notExists、regex、notRegex	1 - 100 个字符，可由字母（a - z，A - Z）、数字（0 - 9）、以及部分特殊字符组成。

Value

规则引擎通过匹配类型和操作符组合来描述请求匹配条件。下表列出了当前支持的匹配类型、可用操作符及此时对应值的填写说明。

匹配类型	操作符	值说明
host	inValues、notInValues	站点所属域名。 可填写多个，最多 50 个，支持使用通配符' * '。
path	inValues、notInValues	当前站点下 URL 路径的请求。 每个内容以'/'开头，长度 200 字符以内，回车分隔多个值，最多可配置 50 个。
path	regex、notRegex	当前站点下 URL 路径的请求。 支持 Google RE2 正则表达式，表达式长度最多支持 1024 个字符。例如：^/example/test[123]/$ 。
directory	inValues、notInValues	文件目录。 不支持通配符' * '，每个内容需要以 '/'开头,以'/'结尾，长度 200 字符以内，回车分隔多个值，最多可配置 50 个。
arg	inValues、notInValues	查询字符串。 每个值为1-255 个字符，可由大小写英文字母、数字、以及特殊字符组成，最多配置 50 个。
arg	regex、notRegex	查询字符串。 支持 Google RE2 正则表达式，表达式长度最多支持 1024 个字符。
suffix	inValues、notInValues	文件后缀。 不能以' . '开头，可填写多个，回车分隔，最多 100 个。
suffix	regex、notRegex	文件后缀。 支持 Google RE2 正则表达式，表达式长度最多支持 1024 个字符。
header	inValues、notInValues	HTTP 请求头。 每个值为1-255 个字符，可由大小写英文字母、数字、以及特殊字符组成，回车分隔多个值，最多配置 50 个。
header	regex、notRegex	HTTP 请求头。 支持 Google RE2 正则表达式，表达式长度最多支持 1024 个字符。
fullUrl	inValues、notInValues	当前站点下完整 URL 路径。 不支持填写通配符 *，最多可配置 50 个，单个内容长度最多支持 1024 个字符。
fullUrl	regex、notRegex	当前站点下完整 URL 路径。 支持 Google RE2 正则表达式，表达式长度最多支持 1024 个字符。
basename	inValues、notInValues	文件名称。 最多可配置 50 个，单个内容长度最多支持 255 个字符。
basename	regex、notRegex	文件名称。 支持 Google RE2 正则表达式，表达式长度最多支持 1024 个字符。
remoteGeos	inValues、notInValues	客户端地理位置。可参考地理位置。
remoteAddrs	inValues、notInValues	客户端IP。支持IP和IP段，回车分隔多个值，最多可配置1000个。
remoteIsp	inValues、notInValues	客户端运营商。ct,un,cm 分别表示电信、联通、移动。英文符号 | 分隔。
method	inValues、notInValues	请求方法。支持 GET、POST、DELETE、PUT、OPTIONS、CONNECT、HEAD、TRACE、PATCH。
cookie	inValues、notInValues	不支持填写通配符 *，最多可配置 50 个，单个内容长度最多支持 255 个字符。
cookie	regex、notRegex	支持 Google RE2 正则表达式，表达式长度最多支持 1024 个字符。

Rule.CacheKey

参数	类型	可选	说明
query	Bool	必选	其合法值为 true 和 false。true 表示保留参数缓存，false 表示忽略参数缓存
ignore_case	Bool	可选	其合法值为 true 和 false。true 表示开启忽略大小写，false 表示关闭忽略大小写。
exclude_args	Array<String>	可选	忽略哪些参数缓存，只有 query = false 时才有效
include_args	Array<String>	可选	包含哪些参数缓存，只有 query = false 时才有效

注：exclude_args 与 include_args 不可同时设置。

RefreshRevalidate

参数	类型	可选	说明
enabled	Bool	必选	true 表示开启，false 表示关闭

WebSocket

参数	类型	可选	说明
enabled	Bool	必选	true 表示开启，false 表示关闭
timeout	Int	可选	最大连接超时时长，支持范围： 1-300 秒（开启时必传，关闭时不传）

OriginTimeout

参数	类型	可选	说明
loadTimeout	Int	必选	HTTP应答超时时间，支持范围：5-300秒
connectTimeout	Int	必选	TCP连接超时时间，支持范围：5-30秒

OriginRedirectOptions

参数	类型	可选	说明
enableRedirectFollow	String	必选	ON 表示开启，OFF 表示关闭
maxRedirectFollowCount	Int	可选	最大跟随次数，支持范围：1-5

OriginOptions

参数	类型	可选	说明
range	String	必选	"force_all" 表示开启回源 range，"off" 表示关闭
partSize	String	可选	回源分片大小，不区分大小写。其合法值为 "512k" 或 "512K"、"1m" 或 "1M"。（开启时必传，关闭时不传）

RealIp

参数	类型	可选	说明
enabled	Bool	必选	true 表示开启，false 表示关闭
name	String	可选	开启时生效，合法值为 "True-Client-Ip"、"X-Real-IP" （开启时必传，关闭时不传）

ErrorPage

参数	类型	可选	说明
code	Int	必选	特定的错误状态码。其合法值为：401、403、404、414、429、500、501、502、503、504
url	String	必选	重定向目标地址，当出现 code 错误码时，重定向到这个用户自定义的 url。当 url 为外链时，其 Host 只能是域名（不能是 IP），且已经完成域名备案

TrafficLimit

参数	类型	可选	说明
enable	Bool	必选	是否开启限速。true 表示开启，false 表示关闭
limitRate	Int	必选	开启限速时必选，单位 Byte/s
limitStartHour	Int	可选	限速开始时间，请输入 0 - 24 范围的数字，小于限速结束时间，默认值为 0
limitEndHour	Int	可选	限速结束时间，请输入 0 - 24 范围的数字，大于限速开始时间，默认值为 24
limitRateUnit	String	可选	默认限速单位，其合法值为 ‘k’、‘m’、‘g’。默认为 'k'

AntiHotLink

参数	类型	可选	说明
antiType	String	必选	A/B/C 三种鉴权方式。其合法值为 ‘typeA’、‘typeB’、‘typeC’
secretKey	String	必选	主 key
newsecretKey	String	可选	备 Key
timeout	Int	可选	鉴权有效时间，A/B/C 三类鉴权方式都支持，单位为秒；默认为 1800
timestampFormat	String	可选	鉴权时间格式。可选值为 "dec"、"hex"、"calendar"，分别表示 10 进制时间格式、16 进制时间格式、字符串类的时间格式(YYYYMMDDHHMM)。其中，只有 typeB 类鉴权才可以取值为 "calendar"
authArg	String	可选	签名参数，只支持 typeA 类鉴权方式，默认值为 "auth_key"

OriginArg

参数	类型	可选	说明
ignore	Bool	必选	合法值为 true 或 false。true 表示忽略参数，false 表示保留参数
args	Array	必选	表示要保留或忽略的参数。最多 10 个参数，参数限制 255 字符

UrlRules

参数	类型	可选	说明
scheme	String	必选	请求协议，其合法值为：http、https、''。'' 表示跟随原请求协议
host	String	必选	重定向域名。其合法值为 或合法域名字符串。'' 表示跟随原请求 host
srcPath	String	可选	匹配请求的路径。当目标路径为正则替换时，该参数有效且为合法的正则表达式，否则无需传该参数。支持Google RE2正则表达式。
dstPath	String	必选	重定向目标路径。其合法值为 '' 或以 ‘/’ 开头的正则表达式或捕获组或正常请求路径。'' 表示跟随原请求路径。支持Google RE2正则表达式。
query	String	必选	是否携带原请求参数。‘OFF’ 表示不携带，‘ON’ 表示携带
status	Int	必选	重定向状态码。其合法值为：301、302、303、307、308

地理位置

地理位置	参数
上海	shanghai
云南	yunnan
北京	beijing
吉林	jilin
四川	sichuan
天津	tianjin
宁夏	ningxia
安徽	anhui
山东	shandong
山西	shanxi
广东	guangdong
广西	guangxi
新疆	xinjiang
未知	unknown
江苏	jiangsu
江西	jiangxi
河北	hebei
河南	henan
浙江	zhejiang
海南	hainan
湖北	hubei
湖南	hunan
甘肃	gansu
福建	fujian
西藏	xizang
贵州	guizhou
辽宁	liaoning
重庆	chongqing
陕西	shaanxi
青海	qinghai
海外	abroad
黑龙江	heilongjiang
内蒙古	neimenggu