帮你快速理解、总结文档立即下载
文档中心>边缘安全加速平台 EO>通用参考>配置语法>配置组语法说明

配置组语法说明

最近更新时间：2026-09-28 11:27:31
本文档已由 AI 辅助审校
我的收藏

本页目录：

本文档是对版本管理中各功能模块配置组结构的详细语法解释。其中 Condition 结构和变量定义的细节可在对应文档章节中进一步查阅，链接如下：
条件表达式的嵌套规则及语法细节：Condition。
请求数据的动态提取规则：变量。

通用单位规范

所有表示​​时间​​的数值单位必须为​​秒(s)​​，所有表示​​文件大小​​的数值单位必须为​​字节(B)​​，且​​值仅为纯数字​​。
单位类型
配置示例与说明
​​时间（秒）​​
设置30分钟缓存：30 * 60 = 1800
​​大小（字节）​​
设置10MB 大小限制：10 * 1024 * 1024 = 10485760

配置组概述

每个站点的版本文件由 ZoneFullConfig 内的各字段组成一个 JSON 标准化的配置文件，可以根据 ZoneFullConfig 查看支持的配置组以及各参数说明。

数据结构

AccelerateMainlandParameters

中国大陆加速优化配置。
名称
类型
必选
描述
Switch
String
否
中国大陆加速优化配置开关，取值有：
on：开启。
off：关闭。

AccessURLRedirectParameters

访问 URL 重定向 配置参数。
名称
类型
必选
描述
StatusCode
Integer
否
状态码，取值为 301、302、303、307、308 之一。
Protocol
String
否
目标请求协议，取值有：
http：目标请求协议 HTTP。
https：目标请求协议 HTTPS。
follow：跟随请求。
HostName
HostName
否
目标 HostName 。
注意：此字段可能返回 null，表示取不到有效值。
URLPath
URLPath
否
目标路径。
注意：此字段可能返回 null，表示取不到有效值。
QueryString
否
携带查询参数。
注意：此字段可能返回 null，表示取不到有效值。

AccessURLRedirectQueryString

访问 URL 重定向 配置参数。
名称
类型
必选
描述
Action
String
否
执行动作，取值有：
full：全部保留。
ignore：全部忽略。

AccountProtectionSettings

账号保护配置。
名称
类型
必选
描述
Enabled
String
否
账号保护功能开关。
枚举值：
on：开启；
off：关闭。
默认值：off。
RequestPurpose
String
否
请求目的。用于标识请求所属的业务操作场景。
枚举值：
ACCOUNT.CHANGE_PASSWORD：在已知原密码的情况下修改密码的请求；
ACCOUNT.CHANGE_SECURITY_QUESTION：修改账号安全问题的请求；
ACCOUNT.CHECK_EXISTENCE：校验账号是否已存在的请求，常见于登录或注册页面输入邮箱、手机号后的预校验；
ACCOUNT.LOGIN：登录账号的请求；
ACCOUNT.REGISTER：注册新账号的请求；
ACCOUNT.RESET_PASSWORD：重置密码的请求，通常通过邮箱或短信验证身份后设置新密码；
ACCOUNT.UPDATE：修改账号关联信息的请求，例如手机号、邮箱、支付卡号、收货地址等；
ASSET.CHECK_GIFTCARD_BALANCE：通过卡号等信息查询礼品卡余额的请求；
ASSET.CHECK_LOYALTY_POINTS：查询账号积分余额的请求；
ASSET.REDEEM_CODE：使用兑换码兑换权益的请求；
BROWSE.QUERY：站内搜索商品或服务的请求；
PAYMENT.ADD_TO_CART：将商品加入购物车的请求；
PAYMENT.GET_METHODS：获取账号已绑定支付方式列表的请求；
PAYMENT.MAKE_PAYMENT：提交支付、结算或转账的请求。
UserIDSource
String
否
用户标识在请求来源中的位置，其中 key 替换为实际的参数名称。
取值有：
http.request.cookies["key"]：从 Cookie 中获取名称为 key 的 Cookie 值；
http.request.headers["key"]：从请求头中获取名称为 key 的头部值；
http.request.uri.args["key"]：从 URL 查询参数中获取名称为 key 的参数值。
UserRiskProfile
否
用户风险等级配置。

AdaptiveFrequencyControl

自适应频控
名称
类型
必选
描述
Enabled
String
是
自适应频控是否开启。取值有：
on：开启。
off：关闭。
Id
String
否
自适应频控的规则 ID，仅作为出参返回。
Sensitivity
String
否
自适应频控的限制等级，当 Enabled 为 on 时，此字段必填。取值有：
Loose：宽松。
Moderate：适中。
Strict：严格。
Action
否
自适应频控的处置方式，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：
Monitor：观察；
Deny：拦截；
Challenge：挑战，其中ChallengeActionParameters.Name仅支持JSChallenge。

AdvancedOriginRoutingParameters

高级回源优化配置参数。
名称
类型
必选
描述
Direction
String
是
回源优化方向，取值有：
MainlandChinaAndGlobalAdaptive：自适应；域名需同时开启「智能加速」后生效，EdgeOne将根据客户端与源站的实际地理位置，自动匹配最优回源优化方向，无需手动指定；例如 www.example.com 开启「高级回源优化」，但「智能加速」关闭或仅部分匹配条件开启时，「高级回源优化」将不生效。

AICrawlerDetection

AI 爬虫检测的具体配置。
名称
类型
必选
描述
Enabled
String
否
AI 爬虫检测是否开启。取值有：
on：开启。
off：关闭。
Action
否
AI 爬虫检测的执行动作，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值仅支持：
Deny：拦截；
Monitor：观察；
Allow：放行；
Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 仅支持 JSChallenge 和 ManagedChallenge。

AllowActionParameters

Web 安全 Allow 的附加参数
名称
类型
必选
描述
MinDelayTime
String
否
最小延迟响应时间，当配置为 0s 时，表示不延迟直接响应。支持的单位有：
s：秒，取值范围 0～5。
MaxDelayTime
String
否
最大延迟响应时间，支持的单位有：
s：秒，取值范围 5～10。

AuthenticationParameters

Token 鉴权 配置参数。
名称
类型
必选
描述
AuthType
String
否
鉴权类型。取值有：
TypeA：鉴权方式 A 类型，具体含义请参考 鉴权方式 A；
TypeB：鉴权方式 B 类型，具体含义请参考 鉴权方式 B；
TypeC：鉴权方式 C 类型，具体含义请参考 鉴权方式 C；
TypeD：鉴权方式 D 类型，具体含义请参考 鉴权方式 D；
TypeVOD：鉴权方式 V 类型，具体含义请参考 鉴权方式 V。
SecretKey
String
否
主鉴权密钥，由 6～40 位大小写英文字母或数字组成，不能包含 " 和 $。
Timeout
Integer
否
鉴权 URL 的有效时长，单位为秒，取值：1～630720000。用于判断客户端访问请求是否过期：
若当前时间超过 “timestamp + 有效时长” 时间，则为过期请求，直接返回 403；
若当前时间未超过 “timestamp + 有效时长” 时间，则请求未过期，继续校验 md5 字符串。
注意：当 AuthType 为 TypeA、TypeB、TypeC、TypeD 之一时，此字段必填。
BackupSecretKey
String
否
备鉴权密钥，由 6～40 位大小写英文字母或数字组成，不能包含 " 和 $。
AuthParam
String
否
鉴权参数名称，节点将校验此参数名对应的值。由 1～100 位大小写字母、数字或下划线组成。
注意：当 AuthType 为 TypeA、TypeD 之一时，此字段必填。
TimeParam
String
否
鉴权时间戳，和 AuthParam 字段的值不能相同。
注意：当 AuthType 为 TypeD 时，此字段必填。
TimeFormat
String
否
鉴权时间格式，取值有：
dec：十进制。
hex：十六进制。
注意：当 AuthType 为 TypeD 时，此字段必填。默认为 hex。

BandwidthAbuseDefense

流量防盗刷（仅适用中国大陆地区）的具体配置。
名称
类型
必选
描述
Enabled
String
是
流量防盗刷（仅适用中国大陆地区）是否开启。取值有：
on：开启。
off：关闭。
Id
String
否
流量防盗刷的规则 ID，仅作为出参返回。
Action
否
流量防盗刷（仅适用中国大陆地区）的处置方式，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：
Monitor：观察；
Deny：拦截；
Challenge：挑战，其中ChallengeActionParameters.Name仅支持JSChallenge。

BasicBotSettings

Bot 管理的基础配置，对策略关联的所有域名生效。可以通过 CustomRules 进行精细化定制。
名称
类型
必选
描述
SourceIDC
SourceIDC
否
客户端 IP 的来源 IDC 配置，用于处置来自 IDC（数据中心） 的客户端 IP 的访问请求。此类来源请求不是由移动端或浏览器端直接访问。
SearchEngineBots
否
搜索引擎爬虫配置，用于处置来自搜索引擎爬虫的请求。此类请求的 IP、User-Agent 或 rDNS 结果匹配已知搜索引擎爬虫。
KnownBotCategories
否
商业或开源工具 UA 特征配置（原 UA 特征规则），用于处置来自已知商业工具或开源工具的访问请求。此类请求的 User-Agent 头部符合已知商业或开源工具特征。
IPReputation
否
IP 威胁情报库（原客户端画像分析）配置，用于处置近期访问行为具有特定风险特征的客户端 IP。
BotIntelligence
否
Bot 智能分析的具体配置。

BlockIPActionParameters

Web 安全 IP 封禁的附加参数
名称
类型
必选
描述
Duration
String
是
封禁 IP 的惩罚时长。支持的单位有：
s：秒，取值范围1～120；
m：分，取值范围1～120；
h：小时，取值范围1～48。

BotIntelligence

Bot 智能分析的具体配置。
名称
类型
必选
描述
Enabled
String
否
Bot 智能分析的具体配置开关。取值有：

on：开启；
off：关闭。
Id
String
否
Bot 智能分析的规则 ID，仅作为出参返回。
BotRatings
否
基于客户端和请求特征，将请求来源分为人类来源请求、合法 Bot 请求、疑似 Bot 请求和高风险 Bot 请求，并提供请求处置选项。

BotManagement

Web 安全的 Bot 规则结构。
名称
类型
必选
描述
Enabled
String
否
Bot 管理是否开启。取值有：
on：开启；
off：关闭。
CustomRules
否
Bot 管理的自定义规则，组合各类爬虫和请求行为特征，精准定义 Bot 并配置定制化处置方式。
BasicBotSettings
否
Bot 管理的基础配置，对策略关联的所有域名生效。可以通过 CustomRules 进行精细化定制。
ClientAttestationRules
否
客户端认证规则的定义列表。该功能内测中，如需使用，请提工单。
BrowserImpersonationDetection
否
配置浏览器伪造识别规则（原主动特征识别规则）。设置注入 JavaScript 的响应页面范围，浏览器校验选项，以及对非浏览器客户端的处置方式。

BotManagementActionOverrides

Bot 规则项的具体配置，用于覆盖上层的默认配置。
名称
类型
必选
描述
Ids
Array of String
否
Bot 规则组下的具体项，用于改写此单条规则项配置的内容，Ids 所对应的具体信息请参考 DescribeBotManagedRules 接口返回的信息。
Action
否
Ids 中指定 Bot 规则项的处置动作。 SecurityAction 的 Name 取值支持：
Deny：拦截；
Monitor：观察；
Disabled：未启用，不启用指定规则；
Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 支持 JSChallenge 和 ManagedChallenge；
Allow：放行（仅限Bot基础特征管理）。

BotManagementCustomRule

Web 安全的 Bot 自定义规则。
名称
类型
必选
描述
Id
String
否
Bot 自定义规则的 ID。
通过规则 ID 可支持不同的规则配置操作：
增加新规则：ID 为空或不指定 ID 参数；
修改已有规则：指定需要更新/修改的规则 ID；
删除已有规则：BotManagementCustomRules 参数中，Rules 列表中未包含的已有规则将被删除。
Name
String
否
Bot 自定义规则的名称。
Enabled
String
否
Bot 自定义规则是否开启。取值有：
on：开启；
off：关闭。
Priority
Integer
否
Bot 自定义规则的优先级，范围是 1 ~ 100，默认为 50。
Condition
String
否
Bot 自定义规则的具体内容，需符合表达式语法，详细规范参见产品文档。
Action
否
Bot 自定义规则的处置方式。取值有：
Monitor：观察；
Deny：拦截，其中 DenyActionParameters.Name 支持 Deny 和 ReturnCustomPage；
Challenge：挑战，其中 ChallengeActionParameters.Name 支持 JSChallenge 和 ManagedChallenge；
Redirect：重定向至 URL。

BotManagementCustomRules

Bot 自定义规则的配置。
名称
类型
必选
描述
Rules
否
Bot 自定义规则的列表。使用 ModifySecurityPolicy 修改 Web 防护配置时：
若未指定 SecurityPolicy.BotManagement.CustomRules 中的 Rules 参数，或 Rules 参数长度为零：清空所有 Bot 自定义规则配置。
若 SecurityPolicy.BotManagement 参数中，未指定 CustomRules 参数值：保持已有 Bot 自定义规则配置，不做修改。

BotManagementLite

Web 安全的基础 BOT 规则结构。
名称
类型
必选
描述
CAPTCHAPageChallenge
否
人机校验页的具体配置。
AICrawlerDetection
否
AI爬虫检测的具体配置。

BotRatings

基于客户端和请求特征，将请求来源分为人类来源请求、合法 Bot 请求、疑似 Bot 请求和高风险 Bot 请求，并提供请求处置选项。
名称
类型
必选
描述
HighRiskBotRequestsAction
否
恶意 Bot 请求的执行动作。 SecurityAction 的 Name 取值支持：
Deny：拦截；
Monitor：观察；
Allow：放行；
Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 支持 JSChallenge 和 ManagedChallenge。
LikelyBotRequestsAction
否
疑似 Bot 请求的执行动作。 SecurityAction 的 Name 取值支持：
Deny：拦截；
Monitor：观察；
Allow：放行；
Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 支持 JSChallenge 和 ManagedChallenge。
VerifiedBotRequestsAction
否
友好 Bot 请求的执行动作。 SecurityAction 的 Name 取值支持：
Deny：拦截；
Monitor：观察；
Allow：放行；
Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 支持 JSChallenge 和 ManagedChallenge。
HumanRequestsAction
否
正常 Bot 请求的执行动作。 SecurityAction 的 Name 取值支持：
Allow：放行。

BotSessionValidation

Cookie 校验和会话跟踪行为具体配置。
名称
类型
必选
描述
IssueNewBotSessionCookie
String
否
是否更新 Cookie 并校验。取值有：
on：更新 Cookie 并校验；
off：仅校验。
MaxNewSessionTriggerConfig
否
更新 Cookie 并校验时的触发阈值，仅当 IssueNewBotSessionCookie 为 on 时有效。
SessionExpiredAction
否
未携带 Cookie 或 Cookie 已过期的执行动作。 SecurityAction 的 Name 取值支持：
Deny：拦截，其中 DenyActionParameters 中支持 Stall 配置；
Monitor：观察；
Allow：等待后响应，其中 AllowActionParameters 需要 MinDelayTime 和 MaxDelayTime 配置。
SessionInvalidAction
否
不合法 Cookie 的执行动作。 SecurityAction 的 Name 取值支持：
Deny：拦截，其中 DenyActionParameters 中支持 Stall 配置；
Monitor：观察；
Allow：等待后响应，其中 AllowActionParameters 需要 MinDelayTime 和 MaxDelayTime 配置。
SessionRateControl
否
会话速率和周期特征校验的具体配置。

BrowserImpersonationDetection

浏览器伪造识别规则（原主动特征识别规则）的配置。
名称
类型
必选
描述
Rules
否
浏览器伪造识别规则的列表。使用 ModifySecurityPolicy 修改 Web 防护配置时：
若未指定 SecurityPolicy.BotManagement.BrowserImpersonationDetection 中的 Rules 参数，或 Rules 参数长度为零： 清空所有浏览器伪造识别规则配置。
若 SecurityPolicy.BotManagement 参数中，未指定 BrowserImpersonationDetection 参数值： 保持已有浏览器伪造识别规则配置，不做修改。

BrowserImpersonationDetectionAction

Bot 浏览器校验规则（原主动特征识别规则）的 Action。
名称
类型
必选
描述
BotSessionValidation
否
Cookie 校验和会话跟踪配置。
ClientBehaviorDetection
否
客户端行为校验配置。

BrowserImpersonationDetectionRule

浏览器伪造识别规则（原主动特征识别规则）。
名称
类型
必选
描述
Id
String
否
浏览器伪造识别规则的 ID。

通过规则 ID 可支持不同的规则配置操作：

增加新规则：ID 为空或不指定 ID 参数；
修改已有规则：指定需要更新/修改的规则 ID；
删除已有规则：BrowserImpersonationDetection 参数中，Rules 列表中未包含的已有规则将被删除。
Name
String
否
浏览器伪造识别规则的名称。
Enabled
String
否
浏览器伪造识别规则是否开启。取值有：
on：开启；
off：关闭。
Condition
String
否
浏览器伪造识别规则的具体内容，其中仅支持请求方式（Method）、请求路径（Path）和请求 URL 的配置，需符合表达式语法，详细规范参见产品文档。
Action
否
浏览器伪造识别规则的处置方式，包括 Cookie 校验和会话跟踪配置以及客户端行为校验配置。

CacheConfigCustomTime

节点缓存 TTL 自定义缓存时间配置参数。
名称
类型
必选
描述
Switch
String
否
自定义缓存时间开关，取值有：
on：开启。
off：关闭。
CacheTime
Integer
否
自定义缓存时间数值，单位为秒，取值：0-315360000。
注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。

CacheConfigParameters

节点缓存 TTL 配置参数。
名称
类型
必选
描述
FollowOrigin
否
遵循源站缓存配置。FollowOrigin、NoCache、CustomTime 最多只能配置一个 Switch 为 on。
注意：此字段可能返回 null，表示取不到有效值。
NoCache
NoCache
否
不缓存配置。FollowOrigin、NoCache、CustomTime 最多只能配置一个 Switch 为 on。
注意：此字段可能返回 null，表示取不到有效值。
CustomTime
否
自定义缓存时间配置。FollowOrigin、NoCache、CustomTime 最多只能配置一个 Switch 为 on。
注意：此字段可能返回 null，表示取不到有效值。

CacheKeyConfigParameters

缓存键配置。
名称
类型
必选
描述
FullURLCache
String
否
是否开启全路径缓存，取值有：
on：开启全路径缓存（即关闭参数忽略）；
off：关闭全路径缓存（即开启参数忽略）。
IgnoreCase
String
否
是否忽略大小写缓存，取值有：
on：忽略；
off：不忽略。
QueryString
否
查询字符串保留配置参数。此字段和 FullURLCache 必须同时设置，但不能同为 on。

CacheKeyCookie

自定义 Cache Key Cookie 配置参数。
名称
类型
必选
描述
Switch
String
否
功能开关，取值有：
on：开启；
off：关闭。
Action
String
否
缓存动作，取值有：
full：全部保留；
ignore：全部忽略；
includeCustom：保留指定参数；
excludeCustom：忽略指定参数。
注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。
Values
Array of String
否
自定义 Cache Key Cookie 名称列表。
注意：当 Action 为 includeCustom 或 excludeCustom 时，此字段必填；当 Action 为 full 或 ignore 时，无需填写此字段，若填写则不生效。

CacheKeyHeader

自定义 Cache Key HTTP 请求头配置参数。
名称
类型
必选
描述
Switch
String
否
功能开关，取值有：
on：开启；
off：关闭。
Values
Array of String
否
自定义 Cache Key HTTP 请求头列表。
注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。

CacheKeyParameters

自定义 Cache Key 配置参数。
名称
类型
必选
描述
FullURLCache
String
否
查询字符串全部保留开关，取值有：
on：开启；
off：关闭。
注意：FullURLCache、IgnoreCase、Header、Scheme、Cookie 至少设置一个配置。此字段和 QueryString.Switch 必须同时设置，但不能同为 on。
QueryString
否
查询字符串保留配置参数。此字段和 FullURLCache 必须同时设置，但不能同为 on。
注意：此字段可能返回 null，表示取不到有效值。
IgnoreCase
String
否
忽略大小写开关，取值有：
on：开启；
off：关闭。
注意：FullURLCache、IgnoreCase、Header、Scheme、Cookie 至少设置一个配置。
Header
否
HTTP 请求头配置参数。FullURLCache、IgnoreCase、Header、Scheme、Cookie 至少设置一个配置。
注意：此字段可能返回 null，表示取不到有效值。
Scheme
String
否
请求协议开关，取值有：
on：开启；
off：关闭。
注意：FullURLCache、IgnoreCase、Header、Scheme、Cookie 至少设置一个配置。
Cookie
否
Cookie 配置参数。FullURLCache、IgnoreCase、Header、Scheme、Cookie 至少设置一个配置。
注意：此字段可能返回 null，表示取不到有效值。

CacheKeyQueryString

自定义 Cache Key 查询字符串配置参数。
名称
类型
必选
描述
Switch
String
否
查询字符串保留/忽略指定参数开关，取值有：
on：开启；
off：关闭。
Action
String
否
查询字符串保留/忽略指定参数动作。取值有：
includeCustom：表示保留部分参数；
excludeCustom：表示忽略部分参数。
注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。
Values
Array of String
否
查询字符串中需保留/忽略的参数名列表。
注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。

CacheParameters

节点缓存 TTL 配置参数。
名称
类型
必选
描述
FollowOrigin
否
缓存遵循源站。不填表示不设置该配置，FollowOrigin、NoCache、CustomTime 最多只能配置一个 Switch 为 on。
注意：此字段可能返回 null，表示取不到有效值。
NoCache
NoCache
否
不缓存。不填表示不设置该配置，FollowOrigin、NoCache、CustomTime 最多只能配置一个 Switch 为 on。
注意：此字段可能返回 null，表示取不到有效值。
CustomTime
否
自定义缓存时间。不填表示不设置该配置，FollowOrigin、NoCache、CustomTime 最多只能配置一个 Switch 为 on。
注意：此字段可能返回 null，表示取不到有效值。

CachePrefreshParameters

缓存预刷新 配置参数。
名称
类型
必选
描述
Switch
String
否
缓存预刷新开关，取值有：
on：开启；
off：关闭。
CacheTimePercent
Integer
否
预刷新时间设置为节点缓存时间的百分比数值，取值：1～99。
注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。

CAPTCHAPageChallenge

人机校验页的具体配置。
名称
类型
必选
描述
Enabled
String
否
人机校验页是否开启，取值有：
on：开启；
off：关闭。

ChallengeActionParameters

Web 安全 Challenge 挑战的附加参数
名称
类型
必选
描述
ChallengeOption
String
是
安全执行的具体挑战动作。取值有：
InterstitialChallenge：插页式挑战；
InlineChallenge：内嵌式挑战；
JSChallenge：JavaScript 挑战；
ManagedChallenge：托管挑战。
Interval
String
否
重复挑战的时间间隔，当 Name 为 InterstitialChallenge/InlineChallenge 时，该字段必填。默认值为 300s。支持的单位有：
s：秒，取值范围1～60；
m：分，取值范围1～60；
h：小时，取值范围1～24。
AttesterId
String
否
客户端认证方式 ID 。当 Name 为 InterstitialChallenge/InlineChallenge 时，该字段必填。

ClientAttestationRule

客户端认证规则
名称
类型
必选
描述
Id
String
否
客户端认证规则的 ID。
通过规则 ID 可支持不同的规则配置操作：
增加新规则：ID 为空或不指定 ID 参数；
修改已有规则：指定需要更新/修改的规则 ID；
删除已有规则：BotManagement 参数中，ClientAttestationRule 列表中未包含的已有规则将被删除。
Name
String
否
客户端认证规则的名称。
Enabled
String
否
规则是否开启。取值有：
on：开启；
off：关闭。
Priority
Integer
否
规则的优先级，数值越小越优先执行，范围是 0 ~ 100，默认为 0。
Condition
String
否
规则的具体内容，需符合表达式语法，详细规范参见产品文档。
AttesterId
String
否
客户端认证选项 ID。
DeviceProfiles
Array of DeviceProfile
否
客户端设备配置。若 ClientAttestationRules 参数中，未指定 DeviceProfiles 参数值：保持已有客户端设备配置，不做修改。
InvalidAttestationAction
否
客户端认证未通过的处置方式。SecurityAction.Name 取值范围如下：
Allow：放行，其中 AllowActionParameters 支持 MinDelayTime 和 MaxDelayTime 配置；
Deny：拦截，其中 DenyActionParameters 中支持 BlockIp、ReturnCustomPage 和 Stall 配置；
Monitor：观察；
Challenge：挑战，其中 ChallengeActionParameters.ChallengeOption 支持 JSChallenge、ManagedChallenge、InterstitialChallenge 和 InlineChallenge；
Redirect：重定向至URL。
AccountProtectionSettings
否
账号保护配置。

ClientAttestationRules

客户端认证的配置。
名称
类型
必选
描述
Rules
否
客户端认证的列表。使用 ModifySecurityPolicy 修改 Web 防护配置时：
若未指定 SecurityPolicy.BotManagement.ClientAttestationRules 中的 Rules 参数，或 Rules 参数长度为零：清空所有客户端认证规则配置。
若 SecurityPolicy.BotManagement 参数中，未指定 ClientAttestationRules 参数值：保持已有客户端认证规则配置，不做修改。

ClientBehaviorDetection

客户端行为校验
名称
类型
必选
描述
CryptoChallengeIntensity
String
否
工作量证明校验强度。取值有：
low：低；
medium：中；
high：高。
CryptoChallengeDelayBefore
String
否
客户端行为校验的执行方式。取值有：
0ms：立即执行；
100ms：延迟 100ms 执行；
200ms：延迟 200ms 执行；
300ms：延迟 300ms 执行；
400ms：延迟 400ms 执行；
500ms：延迟 500ms 执行；
600ms：延迟 600ms 执行；
700ms：延迟 700ms 执行；
800ms：延迟 800ms 执行；
900ms：延迟 900ms 执行；
1000ms：延迟 1000ms 执行。
MaxChallengeCountInterval
String
否
触发阈值统计的时间窗口，取值有：
5s：5 秒内；
10s：10 秒内；
15s：15 秒内；
30s：30 秒内；
60s：60 秒内；
5m：5 分钟内；
10m：10 分钟内；
30m：30 分钟内；
60m：60 分钟内。
MaxChallengeCountThreshold
Integer
否
触发阈值统计的累计次数，取值范围 1 ~ 100000000。
ChallengeNotFinishedAction
否
客户端未启用 JS（未完成检测）时的执行动作。 SecurityAction 的 Name 取值支持：
Deny：拦截，其中 DenyActionParameters 中支持 Stall 配置；
Monitor：观察；
Allow：等待后响应，其中 AllowActionParameters 需要 MinDelayTime 和 MaxDelayTime 配置。
ChallengeTimeoutAction
否
客户端检测超时的执行动作。 SecurityAction 的 Name 取值支持：
Deny：拦截，其中 DenyActionParameters 中支持 Stall 配置；
Monitor：观察；
Allow：等待后响应，其中 AllowActionParameters 需要 MinDelayTime 和 MaxDelayTime 配置。
BotClientAction
否
Bot 客户端的执行动作。 SecurityAction 的 Name 取值支持：
Deny：拦截，其中 DenyActionParameters 中支持 Stall 配置；
Monitor：观察；
Allow：等待后响应，其中 AllowActionParameters 需要 MinDelayTime 和 MaxDelayTime 配置。

ClientFiltering

智能客户端过滤
名称
类型
必选
描述
Enabled
String
是
智能客户端过滤是否开启。取值有：
on：开启；
off：关闭。
Id
String
否
智能客户端过滤的规则 ID，仅作为出参返回。
Action
否
智能客户端过滤的处置方式，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：
Monitor：观察；
Deny：拦截；
Challenge：挑战，其中ChallengeActionParameters.Name仅支持JSChallenge。

ClientIPCountryParameters

回源时携带客户端 IP 所属地域信息，值的格式为 ISO-3166-1 两位字母代码。
名称
类型
必选
描述
Switch
String
否
配置开关，取值有：
on：开启；
off：关闭。
HeaderName
String
否
存放客户端 IP 所属地域信息的请求头名称，当 Switch=on 时有效。为空则使用默认值：EO-Client-IPCountry。

ClientIPHeaderParameters

存储客户端请求 IP 的头部信息配置。
名称
类型
必选
描述
Switch
String
否
配置开关，取值有：
on：开启；
off：关闭。
HeaderName
String
否
回源时，存放客户端 IP 的请求头名称。当 Switch 为 on 时，该参数必填。该参数不允许填写 X-Forwarded-For。

CompressionParameters

智能压缩配置。
名称
类型
必选
描述
Switch
String
否
智能压缩配置开关，取值有：
on：开启；
off：关闭。
Algorithms
Array of String
否
支持的压缩算法列表。当 Switch 为 on 时，此字段必填，否则此字段不生效。取值有：
brotli：brotli 算法；
gzip：gzip 算法。

ConfigGroupFunctionRegionSelection

地区策略配置。
名称
类型
必选
描述
Function
String
是
指定执行的函数，取值为函数在站点内的唯一标识。当 TriggerType 为 direct 时生效。
Regions
Array of String
是
国家/地区列表。示例值：CN：中国，CN.GD：中国广东。取值请参考：国家/地区及对应代码枚举。

ConfigGroupFunctionTrigger

边缘函数触发规则。
名称
类型
必选
描述
Condition
String
是
匹配条件。
TriggerType
String
否
函数选择配置类型：
枚举值：
direct：直接指定执行函数；
weight：基于权重比选择函数；
region：基于客户端 IP 的国家/地区选择函数。
Function
String
否
指定执行的函数，取值为函数在站点内的唯一标识。当 TriggerType 为 direct 时生效。
RegionMappingSelections
否
基于客户端 IP 国家/地区的函数选择配置。
WeightedSelections
否
基于权重的函数选择配置。
Remark
String
否
规则描述。

ConfigGroupFunctionWeightedSelection

权重策略配置。
名称
类型
必选
描述
Function
String
是
指定执行的函数，取值为函数在站点内的唯一标识。当 TriggerType 为 direct 时生效。
Weight
Integer
是
选中权重。取值范围0-100，所有的权重之和需要为100。 选中概率计算方式为： weight/100。例如设置了两个函数 A 和 B ，其中 A 的权重为30，那么 B 的权重必须为70，最终选中 A 的概率为30%，选中 B 的概率为70%。

ConfigGroupRuleEngineItem

七层加速规则，执行顺序由数组顺序决定。
名称
类型
必选
描述
RuleName
String
否
规则名称。名称长度限制不超过 255 个字符。
Description
Array of String
否
规则注释。可以填写多个注释。
Branches
Array of RuleBranch
否
子规则分支。此列表当前只支持填写一项规则，多填无效。
注意：此字段可能返回 null，表示取不到有效值。

ContentCompressionParameters

内容压缩配置。
名称
类型
必选
描述
Switch
String
是
内容压缩配置开关，取值有：
on：开启；
off：关闭。
当 Switch 为 on 时，将同时支持 brotli 和 gzip 压缩算法。

CustomAction

定制配置
名称
类型
必选
描述
ActionId
String
是
定制配置的配置项 Id。
您可以通过 DescribeAvailableCustomActionsForRuleEngine 接口的返回值 CustomActionSet[].ActionId 获取。
Parameters
是
该定制配置项下各参数字段的取值。
您可以通过 DescribeAvailableCustomActionsForRuleEngine 接口返回值 CustomActionSet[].Parameters 获取。

CustomActionParameter

定制配置的单个字段参数内容。
名称
类型
必选
描述
Name
String
是
定制配置项下各参数字段名称。
您可以通过 DescribeAvailableCustomActionsForRuleEngine 接口返回值 CustomActionSet[].Parameters[].Name 获取，如 "Seconds"、"Ports"、"StatusCode"。
ValueType
String
是
定制配置项下各参数字段值的类型。
枚举值：
String：字符串类型；
Integer：整型类型；
Float：浮点数类型；
Boolean：布尔类型；
ArrayOfString：字符串数组类型；
ArrayOfInteger：整型数组类型；
ArrayOfFloat：浮点数数组类型。
您可以通过 DescribeAvailableCustomActionsForRuleEngine 接口返回值 CustomActionSet[].Parameters[].Type 获取。
StringValue
String
否
字符串类型参数值。当 ValueType 为 String 时，该参数必填。
您可以通过 DescribeAvailableCustomActionsForRuleEngine 接口返回值 CustomActionSet[].Parameters 获取参数值的默认值、单位、限制等说明。
IntegerValue
Integer
否
整型类型参数值。当 ValueType 为 Integer 时，该参数必填。
您可以通过 DescribeAvailableCustomActionsForRuleEngine 接口返回值 CustomActionSet[].Parameters 获取参数值的默认值、单位、限制等说明。
FloatValue
Float
否
浮点数类型参数值。当 ValueType 为 Float 时，该参数必填。
您可以通过 DescribeAvailableCustomActionsForRuleEngine 接口返回值 CustomActionSet[].Parameters 获取参数值的默认值、单位、限制等说明。
BooleanValue
Boolean
否
布尔类型参数值。当 ValueType 为 Boolean 时，该参数必填。
您可以通过 DescribeAvailableCustomActionsForRuleEngine 接口返回值 CustomActionSet[].Parameters 获取参数值的默认值、单位、限制等说明。
StringArrayValue
Array of String
否
字符串数组类型参数值。当 ValueType 为 ArrayOfString 时，该参数必填。
您可以通过 DescribeAvailableCustomActionsForRuleEngine 接口返回值 CustomActionSet[].Parameters 获取参数值的默认值、单位、限制等说明。
IntegerArrayValue
Array of Integer
否
整型数组类型参数值。当 ValueType 为 ArrayOfInteger 时，该参数必填。
您可以通过 DescribeAvailableCustomActionsForRuleEngine 接口返回值 CustomActionSet[].Parameters 获取参数值的默认值、单位、限制等说明。
FloatArrayValue
Array of Float
否
浮点数数组类型参数值。当 ValueType 为 ArrayOfFloat 时，该参数必填。
您可以通过 DescribeAvailableCustomActionsForRuleEngine 接口返回值 CustomActionSet[].Parameters 获取参数值的默认值、单位、限制等说明。

CustomActionParameters

定制配置操作参数。
名称
类型
必选
描述
CustomActions
Array of CustomAction
是
需要配置的定制配置列表。

CustomRule

Web 防护功能下的自定义规则。
名称
类型
必选
描述
Name
String
是
自定义规则的名称。
Condition
String
是
自定义规则的具体内容，需符合表达式语法，详细规范参见 产品文档 。
Action
是
自定义规则的处置动作。SecurityAction.Name 取值范围如下：
Deny：拦截；
Monitor：观察；
ReturnCustomPage：使用指定页面拦截；
Redirect：重定向至 URL；
BlockIP：IP 封禁；
JSChallenge：JavaScript 挑战；
ManagedChallenge：托管挑战；
Allow：放行。
Enabled
String
是
自定义规则是否开启。取值有：
on：开启；
off：关闭。
Id
String
否
自定义规则的 ID。通过规则 ID 可支持不同的规则配置操作：
增加新规则：ID 为空或不指定 ID 参数；
修改已有规则：指定需要更新/修改的规则 ID；
删除已有规则：CustomRules 参数中，Rules 列表中未包含的已有规则将被删除。
RuleType
String
否
自定义规则的类型。取值有：
BasicAccessRule：基础访问管控；
PreciseMatchRule：精准匹配规则；
ManagedAccessRule：专家定制规则，仅出参支持。
说明：当未指定 RuleType 时，默认为 PreciseMatchRule。
Priority
Integer
否
自定义规则的优先级，范围是 0 ~ 100，默认为 0，仅支持精准匹配规则（PreciseMatchRule）。

CustomRules

Web 安全的自定义规则结构
名称
类型
必选
描述
Rules
Array of CustomRule
否
自定义规则的定义列表。
使用 ModifySecurityPolicy 修改 Web 防护配置时：
若未指定 Rules 参数，或 Rules 参数长度为零：清空所有自定义规则配置。
若 SecurityPolicy 参数中，未指定 CustomRules 参数值：保持已有自定义规则配置，不做修改。

CustomTime

节点缓存 TTL 自定义缓存时间参数配置。
名称
类型
必选
描述
Switch
String
否
自定义缓存时间开关，取值有：
on：开启；
off：关闭。
IgnoreCacheControl
String
否
忽略源站 CacheControl 开关，取值有：
on：开启；
off：关闭。
注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。
CacheTime
Integer
否
自定义缓存时间数值，单位为秒，取值：0～315360000。
注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。

CustomVariable

自定义变量详情。
名称
类型
必选
描述
Name
String
是
变量名称。需填写完整前缀：user.zone.* 表示站点级自定义变量，user.rule.* 表示规则级自定义变量。前缀后的自定义部分仅支持大小写字母、数字和下划线。变量名称区分大小写，长度不能超过 50 个字符。变量创建成功后，名称不可修改。
InitialValue
String
否
变量初始值。支持使用常量字符串、变量以及公式。长度不能超过 255 个字符。
Description
String
否
变量描述。长度限制不超过 60 个字符。

CustomVariableOperation

自定义变量运算详情。
名称
类型
必选
描述
Branches
否
子规则分支。此列表当前只支持填写一项规则，多填无效。
注意：此字段可能返回 null，表示取不到有效值。
Description
Array of String
否
规则注释。可以填写多个注释。

CustomVariableOperationRuleAction

自定义变量规则操作。
名称
类型
必选
描述
Name
String
是
操作名称。名称需要与参数结构体对应，例如 Name=Set，则 SetParameters 必填。当前仅支持填写 Set。
Set：自定义变量设置。
SetParameters
否
自定义变量设置参数。此参数中若存在多条运算，按照数组的顺序依次执行。当 Name 取值为 Set 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。

CustomVariableOperationRuleBranch

自定义变量运算子规则分支。
名称
类型
必选
描述
Condition
String
否
匹配条件。
Actions
否
操作。 注意：Actions 和 SubRules 不可同时为空。
注意：此字段可能返回 null，表示取不到有效值。
SubRules
否
子规则列表。此列表中若存在多条规则，按照从上往下的顺序依次执行。 注意：SubRules 和 Actions 不可同时为空。且当前只支持填写一层 SubRules。
注意：此字段可能返回 null，表示取不到有效值。

CustomVariableOperationSubRule

自定义变量运算子规则。
名称
类型
必选
描述
Branches
否
子规则分支
注意：此字段可能返回 null，表示取不到有效值。
Description
Array of String
否
规则注释。

DefaultDenySecurityActionParameters

默认拦截动作配置。当安全规则命中并触发拦截处置动作时，若 SecurityAction 仅指定了 Name 为 Deny 且未指定 DenyActionParameters，则按功能模块维度匹配并使用此处定义的默认参数配置：
ManagedRules 托管规则默认拦截处置动作配置。
OtherModules 除托管规则外的安全防护规则（自定义规则、速率限制 和 Bot 管理功能）默认拦截处置动作配置。
名称
类型
必选
描述
ManagedRules
否
托管规则默认拦截处置动作配置。 DenyActionParameters 支持的配置参数：
ReturnCustomPage：是否使用自定义页面。
ResponseCode：自定义页面的状态码。
ErrorPageId：自定义页面的 PageId。
OtherModules
否
除托管规则外的安全防护规则（自定义规则、速率限制 和 Bot 管理功能）默认拦截处置动作配置。 DenyActionParameters 支持的配置参数：
ReturnCustomPage：是否使用自定义页面。
ResponseCode：自定义页面的状态码。
ErrorPageId：自定义页面的 PageId。

DenyActionParameters

安全执行动作为封禁的附加参数。
名称
类型
必选
描述
BlockIp
String
否
是否对来源 IP 延长封禁。取值有：
on：开启；
off：关闭。
启用后，对触发规则的客户端 IP 持续拦截。当启用该选项时，必须同时指定 BlockIpDuration 参数。 注意：该选项不可与 ReturnCustomPage 或 Stall 选项同时启用。
BlockIpDuration
String
否
当 BlockIP 为 on 时IP 的封禁时长。
ReturnCustomPage
String
否
是否使用自定义页面。取值有：
on：开启；
off：关闭。
启用后，使用自定义页面内容拦截（响应）请求，当启用该选项时，必须同时指定 ResponseCode 和 ErrorPageId 参数。 注意：该选项不可与 BlockIp 或 Stall 选项同时启用。
ResponseCode
String
否
自定义页面的状态码。
ErrorPageId
String
否
自定义页面的PageId。
Stall
String
否
是否对请求来源挂起不予处理。取值有：
on：开启；
off：关闭。
启用后，不再响应当前连接会话内请求，且不会主动断开连接。用于爬虫对抗时，消耗客户端连接资源。 注意：该选项不可与 BlockIp 或 ReturnCustomPage 选项同时启用。

DeviceProfile

客户端设备配置
名称
类型
必选
描述
ClientType
String
是
客户端设备类型。取值有：
iOS；
Android；
WebView；
WeChatMiniProgram。
HighRiskMinScore
Integer
否
高风险请求的最低风险分数。分数大于等于该值时，判定为高风险。
取值范围：[2, 99]
默认值：50
HighRiskRequestAction
否
高风险请求的处置方式。SecurityAction 的 Name 取值支持：
Deny：拦截；
Monitor：观察；
Redirect：重定向；
Challenge：挑战。
默认值为 Monitor。
MediumRiskMinScore
Integer
否
中风险请求的最低风险分数。分数大于等于该值且小于 HighRiskMinScore 时，判定为中风险；低于该值时，判定为低风险。
取值范围：[1, 98]
默认值：15
MediumRiskRequestAction
否
中风险请求的处置方式。SecurityAction 的 Name 取值支持：
Deny：拦截；
Monitor：观察；
Redirect：重定向；
Challenge：挑战。
默认值为 Monitor。

ErrorPage

自定义错误页面。
名称
类型
必选
描述
StatusCode
Integer
是
状态码。支持范围为 400、403、404、405、414、416、451、500、501、502、503、504。
RedirectURL
String
是
重定向 URL，需要为完整跳转路径，如 https://www.test.com/error.html。

ErrorPageParameters

自定义错误页面配置参数。
名称
类型
必选
描述
ErrorPageParams
Array of ErrorPage
否
自定义错误页面配置列表。
注意：此字段可能返回 null，表示取不到有效值。

ExceptionRule

Web 安全的例外规则
名称
类型
必选
描述
Id
String
否
例外规则的 ID。

通过规则 ID 可支持不同的规则配置操作：

增加新规则：ID 为空或不指定 ID 参数；
修改已有规则：指定需要更新/修改的规则 ID；
删除已有规则：ExceptionRules 参数中，Rules 列表中未包含的已有规则将被删除。
Name
String
否
例外规则的名称。
Condition
String
否
例外规则的具体内容，需符合表达式语法，详细规范参见产品文档。
SkipScope
String
否
例外规则执行选项，取值有：
WebSecurityModules: 指定例外规则的安全防护模块，需配合 ⁠WebSecurityModulesForException⁠ 使用；
WebSecuritySubmodules: 指定例外规则的安全防护子模块，需配合 ⁠WebSecuritySubmodulesForException⁠ 使用；
ManagedRules：指定例外规则的具体托管规则，需配合 ⁠ManagedRulesForException⁠ 使用；
ManagedRuleGroups：指定例外规则的托管规则组，需配合 ⁠ManagedRuleGroupsForException⁠ 使用。
SkipOption
String
否
跳过请求的具体类型，取值有：
SkipOnAllRequestFields: 跳过所有请求；
SkipOnSpecifiedRequestFields: 跳过指定请求字段。
仅当 SkipScope 为 ManagedRules 或 ManagedRuleGroups 时有效。
WebSecurityModulesForException
Array of String
否
指定例外规则的安全防护模块，仅当 SkipScope 为 WebSecurityModules 时有效，取值有：
websec-mod-managed-rules：托管规则；
websec-mod-rate-limiting：速率限制；
websec-mod-custom-rules：自定义规则；
websec-mod-adaptive-control：自适应频控、智能客户端过滤、慢速攻击防护、流量盗刷防护；
websec-mod-bot：Bot管理。
WebSecuritySubmodulesForException
Array of String
否
指定例外规则的安全防护子模块，仅当 SkipScope 为 WebSecuritySubmodules 时有效，取值有：
托管规则（ManagedRules）模块功能：
websec-mod-managed-rules/managed-rule-groups：规则集；
websec-mod-managed-rules/frequent-scanning-protection：高频扫描防护；
速率限制（RateLimitingRules）模块功能：
websec-mod-rate-limiting-rules：速率限制规则；
自定义规则（CustomRules）模块功能：
websec-mod-custom-rules：自定义规则；
HTTP DDoS 防护（HttpDDoSProtection）模块功能：
websec-mod-http-ddos-protection/adaptive-frequency-control：自适应频控；
websec-mod-http-ddos-protection/client-filtering：智能客户端过滤；
websec-mod-http-ddos-protection/bandwidth-abuse-defense：流量盗刷防护；
高级 Bot 管理（BotManagement）模块功能：
websec-mod-bot-management/basic-feature：基础特征管理；
websec-mod-bot-management/ip-reputation：客户端画像分析；
websec-mod-bot-management/bot-intelligence：智能 Bot 分析；
websec-mod-bot-management/custom-rules：自定义规则；
websec-mod-bot-management/browser-impersonation-detection：主动特征识别；
websec-mod-bot-management/client-attestation-rules：客户端认证；
基础 Bot 管理（BotManagementLite）模块功能：
websec-mod-bot-management-lite/ai-crawler-detection：AI 爬虫处置；
websec-mod-bot-management-lite/captcha-page-challenge：人机校验页。
ManagedRulesForException
Array of String
否
指定例外规则的具体托管规则，仅当 SkipScope 为 ManagedRules 时有效。
ManagedRuleGroupsForException
Array of String
否
指定例外规则的托管规则组，仅当 SkipScope 为 ManagedRuleGroups 时有效。
RequestFieldsForException
否
指定例外规则跳过指定请求字段的具体配置，仅当 SkipScope 为 ManagedRules 或 ManagedRuleGroups 并且 SkipOption 为 SkipOnSpecifiedRequestFields 时有效。
Enabled
String
否
例外规则是否开启。取值有：
on：开启；
off：关闭。

ExceptionRules

Web 安全的例外规则
名称
类型
必选
描述
Rules
Array of ExceptionRule
否
例外规则的定义列表。使用 ModifySecurityPolicy 修改 Web 防护配置时:
若未指定 Rules 参数，或 Rules 参数长度为零：清空所有例外规则配置。
若 SecurityPolicy 参数中，未指定 ExceptionRules 参数值：保持已有例外规则配置，不做修改。

FollowOrigin

缓存遵循源站配置。
名称
类型
必选
描述
Switch
String
是
遵循源站配置开关，取值有：
on：开启；
off：关闭。
DefaultCache
String
否
源站未返回 Cache-Control 头时，缓存/不缓存开关。当 Switch 为 on 时，此字段必填，当 Switch 为 off 时，无需填写此字段，若填写则不生效。取值有：
on：缓存；
off：不缓存。
DefaultCacheStrategy
String
否
源站未返回 Cache-Control 头时，使用/不使用默认缓存策略开关。当 DefaultCache 为 on 时，此字段必填，否则此字段不生效；当 DefaultCacheTime 不为 0 时，此字段必须为 off。取值有：
on：使用默认缓存策略；
off：不使用默认缓存策略。
DefaultCacheTime
Integer
否
源站未返回 Cache-Control 头时，表示默认的缓存时间，单位为秒，取值：0-315360000。当 DefaultCache 为 on 时，此字段必填，否则此字段不生效；当 DefaultCacheStrategy 为 on 时， 此字段必须为 0。

ForceRedirectHTTPSParameters

访问协议强制 HTTPS 跳转配置。
名称
类型
必选
描述
Switch
String
否
访问强制跳转配置开关，取值有：
on：开启；
off：关闭。
RedirectStatusCode
Integer
否
重定向状态码。当 Switch 为 on 时，此字段必填，否则此字段不生效。取值有：
301：301跳转；
302：302跳转。

FrequentScanningProtection

高频扫描防护配置选项，当某一访客的请求频繁命中「配置为拦截」的托管规则时，在一段时间内封禁该访客所有请求。
名称
类型
必选
描述
Enabled
String
否
高频扫描防护规则是否开启。取值有：
on：开启，高频扫描防护规则生效；
off：关闭，高频扫描防护规则不生效。
Id
String
否
高频扫描防护的规则 ID，仅作为出参返回。
Action
否
高频扫描防护的处置动作。 当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：
Deny：拦截，响应拦截页面；
Monitor：观察，不处理请求记录安全事件到日志中；
JSChallenge：JavaScript 挑战，响应 JavaScript 挑战页面。
CountBy
String
否
请求统计的匹配方式，当 Enabled 为 on 时，此字段必填。取值有：
http.request.xff_header_ip：客户端 IP（优先匹配 XFF 头部）；
http.request.ip：客户端 IP。
BlockThreshold
Integer
否
此参数指定高频扫描防护的阈值，即在 CountingPeriod 所设置时间范围内命中「配置为拦截」的托管规则时的累计拦截次数，取值范围 1 ~ 4294967294，例如 100，当超过此统计值时，后续请求将触发 Action 所设置的处置动作。当 Enabled 为 on 时，此字段必填。
CountingPeriod
String
否
此参数指定高频扫描防护所统计的时间窗口，即命中「配置为拦截」的托管规则的请求的统计时间窗口，取值 5 ~ 1800，单位仅支持秒（s），例如 5s。 当 Enabled 为 on 时，此字段必填。
ActionDuration
String
否
此参数指定高频扫描防护 Action 参数所设置处置动作的持续时长，取值范围 60 ~ 86400，单位仅支持秒（s），例如 60s。当 Enabled 为 on 时，此字段必填。

GrpcParameters

gRPC 配置项。
名称
类型
必选
描述
Switch
String
否
gRPC 配置开关，取值有：
on：开启；
off：关闭。

HeaderAction

HTTP 头部设置规则。
名称
类型
必选
描述
Action
String
是
HTTP 头部设置方式。取值有：
set：设置；变更指定头部参数的取值为设置后的值；
del：删除；删除指定的头部参数；
add：增加；增加指定的头部参数。
Name
String
是
HTTP 头部名称。
Value
String
否
HTTP 头部值。当 Action 取值为 set 或者 add 时，该参数必填；当 Action 取值为 del 时，该参数无需填写。

HostHeaderParameters

Host Header 重写配置参数。
名称
类型
必选
描述
Action
String
否
执行动作，取值有：
followOrigin：跟随源站域名；
custom：自定义。
ServerName
String
否
Host Header 重写，需要填写完整域名。
注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。

HostName

访问 URL 重定向 HostName 配置参数。
名称
类型
必选
描述
Action
String
否
目标 HostName 配置，取值有：
follow：跟随请求；
custom：自定义。
Value
String
否
目标 HostName 自定义取值，最大长度 1024。
注意：当 Action 为 custom 时，此字段必填；当 Action 为 follow 时，此字段不生效。

HostPolicy

域名策略绑定配置，定义单个域名所使用的安全策略类型及对应的策略内容。
配置字段
类型
必选
描述
Host
String
否
站点级策略，针对站点下所有域名生效的策略，详情见 站点级策略。
PolicyType
String
否
当前域名使用的策略类型。取值有：
ZoneDefault：使用站点级策略，即 ZoneDefaultPolicy 中定义的策略配置；
Custom：使用域名级策略；使用该选项时，必须同时配置 Policy 字段，指定详细策略配置；
Template：使用策略模板；使用该选项时，必须同时配置 TemplateId 字段，指定当前域名使用的策略模板。
Policy
否
可选。当 PolicyType 为 Custom 时，该字段为当前域名的详细策略配置，对当前域名生效。
TemplateId
String
否
可选。当 PolicyType 为 Template 时，该字段用于指定当前域名所使用的策略模板的 Id。

HSTSParameters

HSTS 配置参数。
名称
类型
必选
描述
Switch
String
否
HSTS 配置开关，取值有：
on：开启；
off：关闭。
Timeout
Integer
否
缓存 HSTS 头部时间，单位为秒，取值：1-31536000。
注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。
IncludeSubDomains
String
否
是否允许其他子域名继承相同的 HSTS 头部，取值有：
on：允许其他子域名继承相同的 HSTS 头部；
off：不允许其他子域名继承相同的 HSTS 头部。
注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。
Preload
String
否
是否允许浏览器预加载 HSTS 头部，取值有：
on：允许浏览器预加载 HSTS 头部；
off：不允许浏览器预加载 HSTS 头部。
注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。

HTTP2Parameters

HTTP2 接入配置参数。
名称
类型
必选
描述
Switch
String
否
HTTP2 接入配置开关，取值有：
on：开启；
off：关闭。

HttpDDoSProtection

HTTP DDoS 防护配置。
名称
类型
必选
描述
AdaptiveFrequencyControl
否
自适应频控的具体配置。
ClientFiltering
否
智能客户端过滤的具体配置。
BandwidthAbuseDefense
否
流量防盗刷的具体配置。
SlowAttackDefense
否
慢速攻击防护的具体配置。

HTTPResponseParameters

HTTP 应答配置参数。
名称
类型
必选
描述
StatusCode
Integer
否
响应状态码。支持 2XX、4XX、5XX，不包括 499、514、101、301、302、303、509、520-599。
ResponsePage
String
否
响应页面 ID。

HTTPUpstreamTimeoutParameters

七层回源超时配置。
名称
类型
必选
描述
ResponseTimeout
Integer
否
HTTP 应答超时时间。
取值范围：[5, 600]
单位：秒
默认值：15

IPReputation

IP 情报库（原客户端画像分析）配置。
名称
类型
必选
描述
Enabled
String
否
IP 情报库（原客户端画像分析）。取值有：
on：开启；
off：关闭。
IPReputationGroup
否
IP 情报库（原客户端画像分析）的具体配置内容。

IPReputationGroup

IP 情报库（原客户端画像分析）的具体配置。
名称
类型
必选
描述
BaseAction
否
IP 情报库（原客户端画像分析）的执行动作。SecurityAction 的 Name 取值支持：
Deny：拦截；
Monitor：观察；
Disabled：未启用，不启用指定规则；
Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 支持 JSChallenge 和 ManagedChallenge。
BotManagementActionOverrides
否
IP 情报库（原客户端画像分析）的具体配置，用于覆盖 BaseAction 中的默认配置。其中 BotManagementActionOverrides 的 Ids 中可以填写：
IPREP_WEB_AND_DDOS_ATTACKERS_LOW：网络攻击 - 一般置信度；
IPREP_WEB_AND_DDOS_ATTACKERS_MID：网络攻击 - 中等置信度；
IPREP_WEB_AND_DDOS_ATTACKERS_HIGH：网络攻击 - 高置信度；
IPREP_PROXIES_AND_ANONYMIZERS_LOW：网络代理 - 一般置信度；
IPREP_PROXIES_AND_ANONYMIZERS_MID：网络代理 - 中等置信度；
IPREP_PROXIES_AND_ANONYMIZERS_HIGH：网络代理 - 高置信度；
IPREP_SCANNING_TOOLS_LOW：扫描器 - 一般置信度；
IPREP_SCANNING_TOOLS_MID：扫描器 - 中等置信度；
IPREP_SCANNING_TOOLS_HIGH：扫描器 - 高置信度；
IPREP_ATO_ATTACKERS_LOW：账号接管攻击 - 一般置信度；
IPREP_ATO_ATTACKERS_MID：账号接管攻击 - 中等置信度；
IPREP_ATO_ATTACKERS_HIGH：账号接管攻击 - 高置信度；
IPREP_WEB_SCRAPERS_AND_TRAFFIC_BOTS_LOW：恶意 BOT - 一般置信度；
IPREP_WEB_SCRAPERS_AND_TRAFFIC_BOTS_MID：恶意 BOT - 中等置信度；
IPREP_WEB_SCRAPERS_AND_TRAFFIC_BOTS_HIGH：恶意 BOT - 高置信度。

IPv6Parameters

IPv6 访问配置。
名称
类型
必选
描述
Switch
String
否
IPv6 访问功能配置，取值有：
on：开启 IPv6 访问功能；
off：关闭 IPv6 访问功能。

KnownBotCategories

商业或开源工具 UA 特征配置（原 UA 特征规则）。
名称
类型
必选
描述
BaseAction
否
来自已知商业工具或开源工具的访问请求的处置方式。 SecurityAction 的 Name 取值支持：
Deny：拦截；
Monitor：观察；
Disabled：未启用，不启用指定规则；
Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 支持 JSChallenge 和 ManagedChallenge；
Allow：放行（待废弃）。
BotManagementActionOverrides
否
指定已知商业工具或开源工具的访问请求的处置方式。

ManagedRuleAction

托管规则的项配置
名称
类型
必选
描述
RuleId
String
是
托管规则组下的具体项，用于改写此单条规则项配置的内容，具体参考产品文档。
Action
是
RuleId 中指定托管规则项的处置动作。 SecurityAction 的 Name 取值支持：
Deny：拦截，响应拦截页面；
Monitor：观察，不处理请求，记录安全事件到日志中；
Disabled：未启用，不扫描请求，跳过该规则。

ManagedRuleAutoUpdate

托管规则自动更新选项
名称
类型
必选
描述
AutoUpdateToLatestVersion
String
是
是否开启自动更新至最新版本。取值有：
on：开启；
off：关闭。
RulesetVersion
String
否
当前使用的版本，格式符合ISO 8601标准，如2023-12-21T12:00:32Z，默认为空，仅出参。

ManagedRuleDetail

托管规则详情
名称
类型
必选
描述
RuleId
String
否
托管规则Id。
RiskLevel
String
否
托管规则的防护级别。取值有：
low：低风险，此规则风险较低，适用于非常严格控制环境下的访问场景，该等级规则可能造成较多的误报；
medium：中风险，表示此条规则风险正常，适用较为严格的防护场景；
high：高风险，表示此条规则风险较高，大多数场景不会产生误报；
extreme：超高风险，表示此条规则风险极高，基本不会产生误报。
Description
String
否
规则描述。
Tags
Array of String
否
规则标签。部分类型的规则不存在标签。
RuleVersion
String
否
规则所属版本。

ManagedRuleGroup

托管规则组配置。
名称
类型
必选
描述
GroupId
String
是
托管规则的组名称，未指定配置的规则分组将按照默认配置处理，GroupId 的具体取值参考产品文档。
SensitivityLevel
String
是
托管规则组的防护级别。取值有：
loose：宽松，只包含超高风险规则，此时需配置Action，且RuleActions配置无效；
normal：正常，包含超高风险和高风险规则，此时需配置Action，且RuleActions配置无效；
strict：严格，包含超高风险、高风险和中风险规则，此时需配置Action，且RuleActions配置无效；
extreme：超严格，包含超高风险、高风险、中风险和低风险规则，此时需配置Action，且RuleActions配置无效；
custom：自定义，精细化策略，按单条规则配置处置方式，此时Action字段无效，使用RuleActions配置单条规则的精细化策略。
Action
是
托管规则组的处置动作。SecurityAction 的 Name 取值支持：
Deny：拦截，响应拦截页面；
Monitor：观察，不处理请求记录安全事件到日志中；
Disabled：未启用，不扫描请求跳过该规则。
RuleActions
Array of ManagedRuleAction
否
托管规则组下规则项的具体配置，仅在 SensitivityLevel 为 custom 时配置生效。
MetaData
否
托管规则组信息，仅出参。

ManagedRuleGroupMeta

托管规则组信息
名称
类型
必选
描述
GroupDetail
String
否
托管规则组描述，仅出参。
GroupName
String
否
托管规则组名称，仅出参。
RuleDetails
Array of ManagedRuleDetail
否
当前托管规则组下的所有子规则信息，仅出参。

ManagedRules

Web 安全的托管规则
名称
类型
必选
描述
Enabled
String
是
托管规则是否开启。取值有：
on：开启，所有托管规则按配置生效；
off：关闭，所有托管规则不生效。
DetectionOnly
String
是
评估模式是否开启，仅在 Enabled 参数为 on 时有效。取值有：
on：开启，表示所有托管规则以观察模式生效；
off：关闭，表示所有托管规则以实际配置生效。
SemanticAnalysis
String
否
托管规则语义分析选项是否开启，仅在 Enabled 参数为 on 时有效。取值有：
on：开启，对请求进行语义分析后进行处理；
off：关闭，对请求不进行语义分析，直接进行处理。
默认为 off。
AutoUpdate
否
托管规则自动更新选项。
ManagedRuleGroups
Array of ManagedRuleGroup
否
托管规则组的配置。如果此结构传空数组或 GroupId 未包含在列表内将按照默认方式处理。
FrequentScanningProtection
否
高频扫描防护配置选项，当某一访客的请求频繁命中「配置为拦截」的托管规则时，在一段时间内封禁该访客所有请求。

MaxAgeParameters

浏览器缓存 TTL 配置参数。
名称
类型
必选
描述
FollowOrigin
String
否
遵循源站 Cache-Control 开关，取值有：
on：遵循源站，忽略 CacheTime 时间设置；
off：不遵循源站，使用 CacheTime 时间设置。
CacheTime
Integer
否
自定义缓存时间数值，单位为秒，取值：0～315360000。
注意：当 FollowOrigin 为 off 时，表示不遵循源站，使用 CacheTime 设置缓存时间，否则此字段不生效。

MaxNewSessionTriggerConfig

Bot 管理中校验的触发阈值。
名称
类型
必选
描述
MaxNewSessionCountInterval
String
否
触发阈值统计的时间窗口，取值有：
5s：5 秒内；
10s：10 秒内；
15s：15 秒内；
30s：30 秒内；
60s：60 秒内；
5m：5 分钟内；
10m：10 分钟内；
30m：30 分钟内；
60m：60 分钟内。
MaxNewSessionCountThreshold
Integer
否
触发阈值统计的累计次数，取值范围 1 ~ 100000000。

MinimalRequestBodyTransferRate

正文传输最小速率阈值的具体配置。
名称
类型
必选
描述
MinimalAvgTransferRateThreshold
String
是
正文传输最小速率阈值，单位仅支持bps。
CountingPeriod
String
是
正文传输最小速率统计时间范围，取值有：
10s：10秒；
30s：30秒；
60s：60秒；
120s：120秒。
Enabled
String
是
正文传输最小速率阈值是否开启。取值有：
on：开启；
off：关闭。

ModifyOriginParameters

修改源站配置参数。
名称
类型
必选
描述
OriginType
String
否
源站类型。取值有：
IPDomain：IPV4、IPV6 或域名类型源站；
OriginGroup：源站组类型源站；
LoadBalance：负载均衡，该功能内测中，如需使用，请提工单；
COS：腾讯云 COS 对象存储源站；
AWSS3：支持 AWS S3 协议的所有对象存储源站。
Origin
String
否
源站地址，根据 OriginType 的取值分为以下情况：
当 OriginType = IPDomain 时，该参数请填写 IPV4、IPV6 地址或域名；
当 OriginType = COS 时，该参数请填写 COS 桶的访问域名；
当 OriginType = AWSS3，该参数请填写 S3 桶的访问域名；
当 OriginType = OriginGroup 时，该参数请填写源站组 ID；当为出参的时候，如果引用了其它站点的源站组，格式为{源站组 ID}@{ZoneID}；例如：og-testorigin@zone-38moq1z10wwwy；
当 OriginType = LoadBalance 时，该参数请填写负载均衡实例 ID，该功能当前仅白名单开放；当为出参的时候，如果引用了其它站点的负载均衡，格式为{负载均衡 ID}@{ZoneID}；例如：lb-2rxpamcyqfzg@zone-38moq1z10wwwy。
OriginProtocol
String
否
回源协议配置。当 OriginType 取值为 IPDomain、OriginGroup、LoadBalance 时该参数必填。取值有：
http：使用 HTTP 协议；
https：使用 HTTPS 协议；
follow：协议跟随。
HTTPOriginPort
Integer
否
HTTP 回源端口，取值范围 1～65535。当回源协议 OriginProtocol 为 http 或者 follow 时该参数必填。
HTTPSOriginPort
Integer
否
HTTPS 回源端口，取值范围 1～65535。当回源协议 OriginProtocol 为 https 或者 follow 时该参数必填。
PrivateAccess
String
否
指定是否允许访问私有对象存储源站，当源站类型 OriginType = COS 或 AWSS3 时该参数必填，取值有：

on：使用私有鉴权；
off：不使用私有鉴权。
PrivateParameters
否
私有鉴权使用参数，该参数仅当 OriginType = AWSS3 且 PrivateAccess = on 时会生效。
注意：此字段可能返回 null，表示取不到有效值。

ModifyRequestHeaderParameters

修改 HTTP 回源请求头配置参数。
名称
类型
必选
描述
HeaderActions
Array of HeaderAction
否
HTTP 头部设置规则列表。
注意：此字段可能返回 null，表示取不到有效值。

ModifyResponseHeaderParameters

修改 HTTP 节点响应头配置参数。
名称
类型
必选
描述
HeaderActions
Array of HeaderAction
否
HTTP 回源头部规则列表。
注意：此字段可能返回 null，表示取不到有效值。

NetworkErrorLoggingParameters

网络错误日志记录配置项。
名称
类型
必选
描述
Switch
String
否
网络错误日志记录配置开关，取值有
on：开启；
off：关闭。

NoCache

不缓存配置
名称
类型
必选
描述
Switch
String
是
不缓存配置开关，取值有：
on：开启；
off：关闭。

OCSPStaplingParameters

OCSP 装订配置参数。
名称
类型
必选
描述
Switch
String
否
OCSP 装订配置开关，取值有：
on：开启；
off：关闭。

OfflineCacheParameters

离线缓存是否开启。
名称
类型
必选
描述
Switch
String
否
离线缓存开关，取值有：
on：开启；
off：关闭。

OriginAuthenticationParameters

回源鉴权参数。
名称
类型
必选
描述
RequestProperties
是
回源鉴权请求属性。

OriginAuthenticationRequestProperties

回源鉴权请求属性。
名称
类型
必选
描述
Type
String
是
设置回源鉴权参数类型，取值有：
QueryString：表示设置回源鉴权参数类型为查询字符串；
Header：表示设置回源鉴权参数类型为请求头。
Name
String
是
设置回源鉴权类型对应的参数名称。
Value
String
是
设置回源鉴权类型对应的参数值。

OriginPrivateParameters

对象存储源站私有鉴权参数。
名称
类型
必选
描述
AccessKeyId
String
是
鉴权参数 Access Key ID。
SecretAccessKey
String
是
鉴权参数 Secret Access Key。
SignatureVersion
String
是
鉴权版本。取值有：
v2：v2版本；
v4：v4版本。
Region
String
否
存储桶地域。

OriginPullProtocolParameters

回源 HTTPS 配置参数。
名称
类型
必选
描述
Protocol
String
否
回源协议配置，取值有：
http：使用 HTTP 协议回源；
https：使用 HTTPS 协议回源；
follow：协议跟随。

PostMaxSizeParameters

POST 请求上传文件流式传输最大限制。
名称
类型
必选
描述
Switch
String
否
是否开启 POST 请求上传文件限制，单位为 Byte，平台默认为限制为 32 * 220 Byte，取值有：
on：开启限制；
off：关闭限制。
MaxSize
Integer
否
POST 请求上传文件流式传输最大限制，该字段仅在 Switch 为 on 时生效，取值在 1MB 和 800MB 之间，单位字节。

QUICParameters

QUIC 配置项。
名称
类型
必选
描述
Switch
String
否
QUIC 配置开关，取值有：
on：开启；
off：关闭。

RangeOriginPullParameters

分片回源配置参数。
名称
类型
必选
描述
Switch
String
否
分片回源开关，取值有：
on：开启；
off：关闭。

RateLimitingRule

速率限制的具体配置。
名称
类型
必选
描述
Id
String
否
精准速率限制的 ID。
通过规则 ID 可支持不同的规则配置操作：
增加新规则：ID 为空或不指定 ID 参数；
修改已有规则：指定需要更新/修改的规则 ID；
删除已有规则：RateLimitingRules 参数中，Rules 列表中未包含的已有规则将被删除。
Name
String
否
精准速率限制的名称。
Condition
String
否
精准速率限制的具体内容，需符合表达式语法，详细规范参见 产品文档。
Mode
String
否
限速方式。在统计时间窗口 CountingPeriod 内，对满足特征 CountBy 的请求，支持配置以下限速方式：
Block: 阻断访问源。当统计次数超过阈值 MaxRequestThreshold 时，在 ActionDuration 时长内，对满足特征的所有后续请求执行 Action 处置；
Throttle: 仅处置超额请求。当统计次数超过阈值 MaxRequestThreshold 时，仅对超过阈值的请求执行 Action 处置，窗口结束后停止处置。此时，ActionDuration 参数将被忽略。

默认值为 Block。
CountBy
Array of String
否
速率阈值请求特征的匹配方式， 当 Enabled 为 on 时，此字段必填。 当条件有多个时，将组合多个条件共同进行统计计算，条件最多不可超过5条。取值有：
http.request.ip：客户端 IP；
http.request.xff_header_ip：客户端 IP（优先匹配 XFF 头部）；
http.request.uri.path：请求的访问路径；
http.request.cookies['session']：名称为 session 的 Cookie，其中 session 可替换为自己指定的参数；
http.request.headers['user-agent']：名称为 user-agent 的 HTTP 头部，其中 user-agent 可替换为自己指定的参数；
http.request.ja3：请求的 JA3 指纹；
http.request.ja4：请求的 JA4 指纹；
http.request.uri.query['test']：名称为 test 的 URL 查询参数，其中 test 可替换为自己指定的参数。
MaxRequestThreshold
Integer
否
精准速率限制在时间范围内的累计拦截次数，取值范围 1 ~ 100000。
CountingPeriod
String
否
统计的时间窗口，取值有：
1s：1秒；
5s：5秒；
10s：10秒；
20s：20秒；
30s：30秒；
40s：40秒；
50s：50秒；
1m：1分钟；
2m：2分钟；
5m：5分钟；
10m：10分钟；
1h：1小时。
ActionDuration
String
否
Action 动作的持续时长，单位仅支持：
s：秒，取值 1 ~ 120；
m：分钟，取值 1 ~ 120；
h：小时，取值 1 ~ 48；
d：天，取值 1 ~ 30。
当 Mode 为 Throttle 时，此参数将被忽略，不会生效。
Action
否
精准速率限制的处置方式。取值有：
Monitor：观察；
Deny：拦截，其中DenyActionParameters.Name支持Deny和ReturnCustomPage；
Challenge：挑战，其中ChallengeActionParameters.Name支持JSChallenge和ManagedChallenge；
Redirect：重定向至URL。
Priority
Integer
否
精准速率限制的优先级，范围是 0 ~ 100，默认为 0。
Enabled
String
否
精准速率限制规则是否开启。取值有：
on：开启。
off：关闭。

RateLimitingRules

精准速率限制的配置
名称
类型
必选
描述
Rules
Array of RateLimitingRule
否
精准速率限制的定义列表。使用 ModifySecurityPolicy 修改 Web 防护配置时：
若未指定 Rules 参数，或 Rules 参数长度为零：清空所有精准速率限制配置。
若 SecurityPolicy 参数中，未指定 RateLimitingRules 参数值：保持已有自定义规则配置，不做修改。

RedirectActionParameters

Web 安全重定向的附加参数
名称
类型
必选
描述
URL
String
是
重定向的URL。

RequestBodyTransferTimeout

正文传输超时时长的具体配置。
名称
类型
必选
描述
IdleTimeout
String
是
正文传输超时时长，取值 5 ~ 120，单位仅支持秒（s）。
Enabled
String
是
正文传输超时时长是否开启。取值有：
on：开启；
off：关闭。

RequestFieldsForException

例外规则中的跳过字段配置
名称
类型
必选
描述
Scope
String
是
跳过的具体字段。取值支持：
body.json：JSON 请求内容；此时 Condition 支持 key、value, TargetField 支持 key、value，例如 { "Scope":"body.json", "Condition":"", "TargetField":"key" }，表示 JSON 请求内容所有参数跳过 WAF 扫描；
cookie：Cookie；此时 Condition 支持 key、value, TargetField 支持 key、value，例如 { "Scope":"cookie", "Condition":"${key} in ['account-id'] and ${value} like ['prefix-']", "TargetField":"value" }，表示 Cookie 参数名称等于account-id 并且参数值通配符匹配 prefix- 跳过 WAF 扫描；
header：HTTP 头部参数；此时 Condition 支持 key、value, TargetField 支持 key、value，例如 { "Scope":"header", "Condition":"${key} like ['x-auth-']", "TargetField":"value" }，表示 header 参数名称通配符匹配 x-auth- 跳过 WAF 扫描；
uri.query：URL 编码内容/查询参数；此时 Condition 支持 key、value, TargetField 支持 key、value，例如 { "Scope":"uri.query", "Condition":"${key} in ['action'] and ${value} in ['upload', 'delete']", "TargetField":"value" }，表示 URL 编码内容/查询参数的参数名称等于 action 并且参数值等于 upload 或 delete 跳过 WAF 扫描；
uri：请求路径URI；此时 Condition 必须为空， TargetField 支持 query、path、fullpath，例如 { "Scope":"uri", "Condition":"", "TargetField":"query" }，表示请求路径 URI 仅查询参数跳过 WAF 扫描；
body：请求正文内容；此时 Condition 必须为空， TargetField 支持 fullbody、multipart，例如 { "Scope":"body", "Condition":"", "TargetField":"fullbody" }，表示请求正文内容为完整请求正文跳过 WAF 扫描。
Condition
String
是
跳过的具体字段的表达式，需要符合表达式语法。 Condition 支持表达式配置语法：
按规则的匹配条件表达式语法编写，支持引用 key、value；
支持 in、like 操作符，以及 and 逻辑组合；
例如：
${key} in ['x-trace-id']：参数名称等于x-trace-id；
${key} in ['x-trace-id'] and ${value} like ['Bearer *']：参数名称等于x-trace-id并且参数值通配符匹配Bearer *。
TargetField
String
是
Scope 参数使用不同取值时，TargetField 表达式中支持的值如下：
body.json：支持 key、value
cookie：支持 key、value
header：支持 key、value
uri.query：支持 key、value
uri：支持 path、query、fullpath
body：支持 fullbody、multipart

ResponseSpeedLimitParameters

单连接下载限速配置参数。
名称
类型
必选
描述
Mode
String
是
下载限速模式，取值有：
LimitUponDownload：全过程下载限速；
LimitAfterSpecificBytesDownloaded：全速下载特定字节后开始限速；
LimitAfterSpecificSecondsDownloaded：全速下载特定时间后开始限速。
MaxSpeed
String
是
限速值，指定限速大小，填写含单位的数值或变量。当前支持单位有：KB/s。
StartAt
String
否
限速开始值，可以为下载大小或指定时长，填写含单位的数值或变量，指定下载大小或指定时长。
当Mode 取值为 LimitAfterSpecificBytesDownloaded 时，单位取值有：KB；
当Mode 取值为 LimitAfterSpecificSecondsDownloaded 时，单位取值有：s。

ReturnCustomPageActionParameters

Web 安全自定义页面的附加参数
名称
类型
必选
描述
ResponseCode
String
是
响应状态码。
ErrorPageId
String
是
响应的自定义页面ID。

RuleBranch

子规则分支。
名称
类型
必选
描述
Condition
String
否
Actions
Array of RuleEngineAction
否
操作。 注意：Actions 和 SubRules 不可同时为空。 注意：此字段可能返回 null，表示取不到有效值。
SubRules
Array of RuleEngineSubRule
否
子规则列表。此列表中时存在多条规则，按照从上往下的顺序依次执行。 注意：SubRules 和 Actions 不可同时为空。且当前只支持填写一层 SubRules。 注意：此字段可能返回 null，表示取不到有效值。

RuleEngineAction

规则引擎操作。
名称
类型
必选
描述
Name
String
是
操作名称。名称需要与参数结构体对应，例如 Name=Cache，则 CacheParameters 必填。
Cache：节点缓存 TTL；
CacheKey：自定义 Cache Key；
CachePrefresh：缓存预刷新；
AccessURLRedirect：访问 URL 重定向；
UpstreamURLRewrite：回源 URL 重写；
QUIC：QUIC；
WebSocket：WebSocket；
Authentication：Token 鉴权；
MaxAge：浏览器缓存 TTL；
StatusCodeCache：状态码缓存 TTL；
OfflineCache：离线缓存；
SmartRouting：智能加速；
AdvancedOriginRouting：高级回源优化；
RangeOriginPull：分片回源 ；
UpstreamHTTP2：HTTP2 回源；
HostHeader：Host Header 重写；
ForceRedirectHTTPS：访问协议强制 HTTPS 跳转配置；
OriginPullProtocol：回源 HTTPS；
Compression：智能压缩配置；
HSTS：HSTS；
ClientIPHeader：存储客户端请求 IP 的头部信息配置；
OCSPStapling：OCSP 装订；
HTTP2：HTTP2 接入；
PostMaxSize：POST 请求上传文件流式传输最大限制配置；
ClientIPCountry：回源时携带客户端 IP 所属地域信息；
UpstreamFollowRedirect：回源跟随重定向参数配置；
UpstreamRequest：回源请求参数；
Shield：源站卸载配置；
TLSConfig：SSL/TLS 安全；
ModifyOrigin：修改源站；
SiteFailover：源站故障转移；
HTTPUpstreamTimeout：七层回源超时配置；
HttpResponse：HTTP 应答；
ErrorPage：自定义错误页面；
ModifyResponseHeader：修改 HTTP 节点响应头；
ModifyRequestHeader：修改 HTTP 节点请求头；
ResponseSpeedLimit：单连接下载限速；
SetContentIdentifier：设置内容标识符；
Vary：Vary 特性配置；
ContentCompression：内容压缩配置；
OriginAuthentication：回源鉴权配置；
CustomAction：定制配置。
CacheParameters
否
节点缓存 TTL 配置参数，当 Name 取值为 Cache 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
CacheKeyParameters
否
自定义 Cache Key 配置参数，当 Name 取值为 CacheKey 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
CachePrefreshParameters
否
缓存预刷新配置参数，当 Name 取值为 CachePrefresh 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
AccessURLRedirectParameters
否
访问 URL 重定向配置参数，当 Name 取值为 AccessURLRedirect 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
UpstreamURLRewriteParameters
否
回源 URL 重写配置参数，当 Name 取值为 UpstreamURLRewrite 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
QUICParameters
否
QUIC 配置参数，当 Name 取值为 QUIC 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
WebSocketParameters
否
WebSocket 配置参数，当 Name 取值为 WebSocket 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
AuthenticationParameters
否
Token 鉴权配置参数，当 Name 取值为 Authentication 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
MaxAgeParameters
否
浏览器缓存 TTL 配置参数，当 Name 取值为 MaxAge 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
StatusCodeCacheParameters
否
状态码缓存 TTL 配置参数，当 Name 取值为 StatusCodeCache 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
OfflineCacheParameters
否
离线缓存配置参数，当 Name 取值为 OfflineCache 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
SmartRoutingParameters
否
智能加速配置参数，当 Name 取值为 SmartRouting 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
AdvancedOriginRoutingParameters
否
高级回源优化配置参数，当 Name 取值为 AdvancedOriginRouting 时，该参数必填。

注意：此字段可能返回 null，表示取不到有效值。
RangeOriginPullParameters
否
分片回源配置参数，当 Name 取值为 RangeOriginPull 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
UpstreamHTTP2Parameters
否
HTTP2 回源配置参数，当 Name 取值为 UpstreamHTTP2 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
HostHeaderParameters
否
Host Header 重写配置参数，当 Name 取值为 HostHeader 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
ForceRedirectHTTPSParameters
否
访问协议强制 HTTPS 跳转配置，当 Name 取值为 ForceRedirectHTTPS 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
OriginPullProtocolParameters
否
回源 HTTPS 配置参数，当 Name 取值为 OriginPullProtocol 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
CompressionParameters
否
智能压缩配置，当 Name 取值为 Compression 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
HSTSParameters
否
HSTS 配置参数，当 Name 取值为 HSTS 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
ClientIPHeaderParameters
否
存储客户端请求 IP 的头部信息配置，当 Name 取值为 ClientIPHeader 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
OCSPStaplingParameters
否
OCSP 装订配置参数，当 Name 取值为 OCSPStapling 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
HTTP2Parameters
否
HTTP2 接入配置参数，当 Name 取值为 HTTP2 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
PostMaxSizeParameters
否
POST 请求上传文件流式传输最大限制配置，当 Name 取值为 PostMaxSize 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
ClientIPCountryParameters
否
回源时携带客户端 IP 所属地域信息配置参数，当 Name 取值为 ClientIPCountry 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
UpstreamFollowRedirectParameters
否
回源跟随重定向参数配置，当 Name 取值为 UpstreamFollowRedirect 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
UpstreamRequestParameters
否
回源请求参数配置参数，当 Name 取值为 UpstreamRequest 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
ShieldParameters
否
源站卸载配置参数，当 Name 取值为 Shield 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
TLSConfigParameters
否
SSL/TLS 安全配置参数，当 Name 取值为 TLSConfig 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
ModifyOriginParameters
否
修改源站配置参数，当 Name 取值为 ModifyOrigin 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
SiteFailoverParameters
否
源站故障转移配置参数，当 Name 取值为 SiteFailover 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
HTTPUpstreamTimeoutParameters
否
七层回源超时配置，当 Name 取值为 HTTPUpstreamTimeout 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
ErrorPageParameters
否
自定义错误页面配置参数，当 Name 取值为 ErrorPage 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
ModifyResponseHeaderParameters
否
修改 HTTP 节点响应头配置参数，当 Name 取值为 ModifyResponseHeader 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
ModifyRequestHeaderParameters
否
修改 HTTP 节点请求头配置参数，当 Name 取值为 ModifyRequestHeader 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
ResponseSpeedLimitParameters
否
单连接下载限速配置参数，当 Name 取值为 ResponseSpeedLimit 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
SetContentIdentifierParameters
否
内容标识配置参数，当 Name 取值为 SetContentIdentifier 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。
VaryParameters
否
Vary 特性配置参数，当 Name 取值为 Vary 时，该参数必填。
ContentCompressionParameters
否
内容压缩配置参数，当 Name 取值为 ContentCompression 时，该参数必填。该参数为白名单功能，如有需要，请联系腾讯云工程师处理。
OriginAuthenticationParameters
否
回源鉴权配置参数，当 Name 取值为 OriginAuthentication 时，该参数必填。该参数为白名单功能，如有需要，请联系腾讯云工程师处理。
CustomActionParameters
否
定制配置操作参数，当 Name 取值为 CustomAction 时，该参数必填。
您可以通过 DescribeAvailableCustomActionsForRuleEngine 接口的返回值 CustomActionSet 获取您当前支持的定制配置项列表。
HttpResponseParameters
否
HTTP 应答配置参数，当 Name 取值为 HttpResponse 时，该参数必填。
注意：此字段可能返回 null，表示取不到有效值。

RuleEngineSubRule

子规则。
名称
类型
必选
描述
Branches
Array of RuleBranch
否
子规则分支
注意：此字段可能返回 null，表示取不到有效值。
Description
Array of String
否
规则注释。

SearchEngineBots

搜索引擎规则配置。
名称
类型
必选
描述
BaseAction
否
来自搜索引擎爬虫的请求的执行动作。 SecurityAction 的 Name 取值支持：
Deny：拦截；
Monitor：观察；
Disabled：未启用，不启用指定规则；
Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 支持 JSChallenge 和 ManagedChallenge；
Allow：放行（待废弃）。
BotManagementActionOverrides
否
指定搜索引擎爬虫请求的处置方式。

SecurityAction

安全的执行动作
名称
类型
必选
描述
Name
String
是
安全执行的具体动作。取值有：
Deny：拦截，阻止请求访问站点资源；
Monitor：观察，仅记录日志；
Redirect：重定向至 URL；
Disabled：未启用，不启用指定规则；
Allow：允许访问，但延迟处理请求；
Challenge：挑战，响应挑战内容；
Trans：放行，允许请求直接访问站点资源；
BlockIP：待废弃，IP 封禁；
ReturnCustomPage：待废弃，使用指定页面拦截；
JSChallenge：待废弃，JavaScript 挑战；
ManagedChallenge：待废弃，托管挑战。
DenyActionParameters
否
当 Name 为 Deny 时的附加参数。
RedirectActionParameters
否
当 Name 为 Redirect 时的附加参数。
AllowActionParameters
否
当 Name 为 Allow 时的附加参数。
ChallengeActionParameters
否
当 Name 为 Challenge 时的附加参数。
BlockIPActionParameters
否
待废弃，当 Name 为 BlockIP 时的附加参数。
ReturnCustomPageActionParameters
否
待废弃，当 Name 为 ReturnCustomPage 时的附加参数。

SecurityHeadersToOrigin

回源请求携带安全头部配置，配置生效后将携带对应 keyname 的请求头部回源。
名称
类型
必选
描述
BotIdentificationHeaders
Array of String
否
Bot 标识信息回源头部配置。
枚举值：
EO-Bot-Botnet-ID：基于 Bot 请求特征生成的识别标识。
BotManagementHeaders
Array of String
否
高级 Bot 管理模块识别结果回源头部配置。
枚举值：
EO-Bot-Client-Attestation：高级 Bot 管理 - 客户端认证模块认证票据校验结果；
EO-Bot-Client-Risk：高级 Bot 管理 - 客户端认证模块设备风险评估结果；
EO-Bot-Intelligence：高级 Bot 管理 - Bot 智能分析模块识别结果；
EO-Bot-IP-Reputation：高级 Bot 管理 - 客户端画像分析识别结果；
EO-Bot-Known-Tool：高级 Bot 管理 - 基础特征管理 - UA 特征规则模块识别结果；
EO-Bot-Search-Engine：高级 Bot 管理 - 基础特征管理 - 搜索引擎规则模块识别结果；
EO-Bot-Source-IDC：高级 Bot 管理 - 基础特征管理 - IDC 规则模块识别结果；
EO-Bot-User-Risk：高级 Bot 管理 - 客户端认证模块账号风险评估结果。
ClientFingerprintHeaders
Array of String
否
客户端指纹信息回源头部配置。
枚举值：
EO-Bot-Fingerprint：客户端指纹信息。

SecurityPolicy

安全策略配置
名称
类型
必选
描述
CustomRules
否
自定义规则配置。
ManagedRules
否
托管规则配置。
HttpDDoSProtection
否
HTTP DDOS 防护配置。
RateLimitingRules
否
速率限制规则配置。
ExceptionRules
否
例外规则配置。
BotManagement
否
Bot 管理配置。
BotManagementLite
否
基础 Bot 管理配置。
DefaultDenySecurityActionParameters
否
默认拦截动作配置。
SecurityHeadersToOrigin
否
回源请求携带安全头部配置，配置生效后将携带对应 keyname 的请求头部回源。

SecurityWeightedAction

按权重分配的 SecurityAction。
名称
类型
必选
描述
SecurityAction
否
Bot 自定义规则的处置方式。取值有：
Allow：放行，其中 AllowActionParameters 支持 MinDelayTime 和 MaxDelayTime 配置；
Deny：拦截，其中 DenyActionParameters 中支持 BlockIp、ReturnCustomPage 和 Stall 配置；
Monitor：观察；
Challenge：挑战，其中 ChallengeActionParameters.ChallengeOption 支持 JSChallenge 和 ManagedChallenge；
Redirect：重定向至URL。
Weight
Integer
否
当前 SecurityAction 的权重，仅支持 10 ~ 100 且必须为 10 的倍数，其中 Weight 参数全部相加须等于 100。

SessionRateControl

会话速率和周期特征校验配置。
名称
类型
必选
描述
Enabled
String
否
会话速率和周期特征校验配置是否开启。取值有：
on：启用
off：关闭
HighRateSessionAction
否
会话速率和周期特征校验高风险的执行动作。 SecurityAction 的 Name 取值支持：
Deny：拦截，其中 DenyActionParameters 中支持 Stall 配置；
Monitor：观察；
Allow：等待后响应，其中 AllowActionParameters 需要 MinDelayTime 和 MaxDelayTime 配置。
MidRateSessionAction
否
会话速率和周期特征校验中风险的执行动作。 SecurityAction 的 Name 取值支持：
Deny：拦截，其中 DenyActionParameters 中支持 Stall 配置；
Monitor：观察；
Allow：等待后响应，其中 AllowActionParameters 需要 MinDelayTime 和 MaxDelayTime 配置。
LowRateSessionAction
否
会话速率和周期特征校验低风险的执行动作。 SecurityAction 的 Name 取值支持：
Deny：拦截，其中 DenyActionParameters 中支持 Stall 配置；
Monitor：观察；
Allow：等待后响应，其中 AllowActionParameters 需要 MinDelayTime 和 MaxDelayTime 配置。

SetContentIdentifierParameters

内容标识配置参数。
名称
类型
必选
描述
ContentIdentifier
String
否
内容标识id

SetParameters

自定义变量设置参数。
名称
类型
必选
描述
Name
String
是
自定义变量名称。自定义变量必须先被定义才可进行运算。
Value
String
是
自定义变量赋值。支持使用常量字符串、变量以及公式，不支持中文。长度不能超过 1000 个字符。

ShieldParameters

源站卸载配置参数。
名称
类型
必选
描述
ShieldSpaceId
String
是
源站卸载空间 ID。

SiteFailover

源站故障转移 配置参数内部结构。
名称
类型
必选
描述
Mode
String
是
源站故障转移类型。取值有：
FailoverToHost:回源到指定 IP/域名；
FailoverToCOS:回源到腾讯云 COS；
FailoverToS3CompatibleObjectStorage:回源到 S3 兼容；
FailoverRedirectToURL :重定向至指定 URL；
FailoverCustomResponsePage:使用自定义响应页面。
Origin
String
否
源站地址，根据 Mode 的取值分为以下情况：
当 Mode = FailoverToHost 时，该参数请填写 IPV4、IPV6 地址或域名；
当 Mode = FailoverToCOS 时，该参数请填写 COS 桶的访问域名；
当 Mode = FailoverToS3CompatibleObjectStorage，该参数请填写 S3 桶的访问域名。
OriginProtocol
String
否
回源协议配置。当 Mode 取值为 FailoverToHost 时该参数必填。取值有：
http：使用 HTTP 协议；
https：使用 HTTPS 协议；
follow：协议跟随。
HTTPOriginPort
Integer
否
HTTP 回源端口，取值范围 1～65535。当回源协议 OriginProtocol 为 http 或者 follow 时该参数必填。
HTTPSOriginPort
Integer
否
HTTPS 回源端口，取值范围 1～65535。当回源协议 OriginProtocol 为 https 或者 follow 时该参数必填。
UpstreamHostHeader
否
回源Host Header 重写配置，
UpstreamURLRewrite
否
回源 URL 重写配置。
UpstreamRequestParameters
否
回源请求参数配置。
UpstreamHTTP2Parameters
否
HTTP2 回源配置参数。
PrivateAccess
String
否
指定是否允许访问私有对象存储源站，当源站类型 Mode = FailoverToCOS 或 FailoverToS3CompatibleObjectStorage 时该参数必填，取值有：
on：使用私有鉴权；
off：不使用私有鉴权。
PrivateParameters
否
私有鉴权使用参数，该参数仅当 Mode = FailoverToS3CompatibleObjectStorage 且 PrivateAccess = on 时会生效。
RedirectURL
String
否
重定向目标 URL。当 Mode 取值为 FailoverRedirectToURL 时该参数必填。
ResponsePageId
String
否
响应页面 ID。当 Mode 取值为 FailoverCustomResponsePage 时该参数必填。
StatusCode
Integer
否
响应状态码。当 Mode 取值为 FailoverRedirectToURL 或 FailoverCustomResponsePage 时该参数必填。取值有：
当 Mode = FailoverRedirectToURL 时，该参数取值为 301、302、303、307、308 之一；
当 Mode = FailoverCustomResponsePage 时，该参数取值为 400、403、404、405、414、416、451、500、501、502、503、504 之一。

SiteFailoverParameters

源站故障转移配置参数。
名称
类型
必选
描述
SiteFailoverStatusCodes
Array of Integer
是
源站故障转移条件状态码。当源站返回的响应状态码命中本字段返回时，才会按照SiteFailoverParams执行源站转移。该参数取值为 4xx、5xx 之一。
SiteFailoverParams
Array of SiteFailover
是
源站故障转移配置参数列表。最小长度为1，最大长度为2。

SlowAttackDefense

慢速攻击防护的具体配置。
名称
类型
必选
描述
Enabled
String
是
慢速攻击防护是否开启。取值有：
on：开启；
off：关闭。
Id
String
否
慢速攻击防护的规则 ID，仅作为出参返回。
Action
否
慢速攻击防护的处置方式，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：
Monitor：观察；
Deny：拦截；
MinimalRequestBodyTransferRate
否
正文传输最小速率阈值的具体配置，当 Enabled 为 on 时，此字段必填。
RequestBodyTransferTimeout
否
正文传输超时时长的具体配置，当 Enabled 为 on 时，此字段必填。

SmartRoutingParameters

智能加速配置。
名称
类型
必选
描述
Switch
String
否
智能加速配置开关，取值有：
on：开启；
off：关闭。

SourceIDC

IDC 规则配置的具体内容。
名称
类型
必选
描述
BaseAction
否
来自指定 IDC 请求的处置方式。 SecurityAction 的 Name 取值支持：
Deny：拦截；
Monitor：观察；
Disabled：未启用，不启用指定规则；
Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 支持 JSChallenge 和 ManagedChallenge；
Allow：放行（待废弃）。
BotManagementActionOverrides
否
指定 IDC 请求的处置方式。

StandardDebugParameters

Debug 调试结构体。
名称
类型
必选
描述
Switch
String
否
Debug 功能开关，取值有：
on：开启；
off：关闭。
AllowClientIPList
Array of String
否
允许的客户端来源。支持填写 IPv4 以及 IPv6 的 IP 网段。0.0.0.0/0 表示允许所有 IPv4 客户端进行调试；::/0 表示允许所有 IPv6 客户端进行调试；不能填写 127.0.0.1。
注意：当 Switch 字段为 on 时，此字段必填，且填写个数为 1～100；当 Switch 为 off 时，无需填写此字段，若填写则不生效。
Expires
否
Debug 功能到期时间。超出设置的时间，则功能失效。
注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。

StatusCodeCacheParam

状态码缓存 TTL 配置参数内部结构。
名称
类型
必选
描述
StatusCode
Integer
否
状态码，取值为 400、 401、403、 404、 405、 407、 414、 500、 501、 502、 503、 504、 509、 514 之一。
CacheTime
Integer
否
缓存时间数值，单位为秒，取值：0～31536000。

StatusCodeCacheParameters

状态码缓存 TTL 配置参数。
名称
类型
必选
描述
StatusCodeCacheParams
否
状态码缓存 TTL 。
注意：此字段可能返回 null，表示取不到有效值。

TLSConfigParameters

SSL/TLS 安全配置参数。
名称
类型
必选
描述
Version
Array of String
否
TLS 版本。至少填写一个，如果是多个时，需要为连续版本号，例如：开启 TLS1、1.1、1.2 和 1.3，不可仅开启 1 和 1.2 而关闭 1.1。取值有：
TLSv1：TLSv1 版本；
TLSv1.1：TLSv1.1 版本；
TLSv1.2：TLSv1.2 版本；
TLSv1.3：TLSv1.3 版本。
CipherSuite
String
否
密码套件。详细介绍请参考 TLS 版本及密码套件说明
。取值有：
loose-v2023：loose-v2023 密码套件；
general-v2023：general-v2023 密码套件；
strict-v2023：strict-v2023 密码套件。

UpstreamFollowRedirectParameters

回源跟随重定向参数配置。
名称
类型
必选
描述
Switch
String
否
回源跟随重定向配置开关，取值有：
on：开启；
off：关闭。
MaxTimes
Integer
否
最大重定向次数。取值为 1-5。
注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。

UpstreamHTTP2Parameters

HTTP2 回源配置。
名称
类型
必选
描述
Switch
String
否
HTTP2 回源配置开关，取值有：
on：开启；
off：关闭。

UpstreamRequestCookie

回源请求参数 Cookie 配置。
名称
类型
必选
描述
Switch
String
否
回源请求参数 Cookie 配置开关，取值有：
on：开启；
off：关闭。
Action
String
否
回源请求参数 Cookie 模式。当 Switch 为 on 时，该参数必填。取值有：
full：表示全部保留；
ignore：表示全部忽略；
includeCustom：表示保留部分参数；
excludeCustom：表示忽略部分参数。
Values
Array of String
否
指定参数值。仅当查询字符串模式 Action 为 includeCustom 或者 excludeCustom 时该参数生效，用于指定需要保留或者忽略的参数。最大支持 10 个参数。

UpstreamRequestParameters

回源请求参数配置参数。
名称
类型
必选
描述
QueryString
否
查询字符串配置。可选配置项，不填表示不配置。
注意：此字段可能返回 null，表示取不到有效值。
Cookie
否
Cookie 配置。可选配置项，不填表示不配置。
注意：此字段可能返回 null，表示取不到有效值。

UpstreamRequestQueryString

回源请求参数查询字符串配置。
名称
类型
必选
描述
Switch
String
否
回源请求参数查询字符串配置开关，取值有：
on：开启；
off：关闭。
Action
String
否
查询字符串模式。当 Switch 为 on 时，该参数必填。取值有：
full：全部保留；
ignore：全部忽略；
includeCustom：保留部分参数；
excludeCustom：忽略部分参数。
Values
Array of String
否
指定参数值。仅当查询字符串模式 Action 为 includeCustom 或者 excludeCustom 时该参数生效，用于指定需要保留或者忽略的参数。最大支持 10 个参数。

UpstreamURLRewriteParameters

回源 URL 重写 配置参数。
名称
类型
必选
描述
Type
String
否
回源 URL 重写类型。仅支持填写 Path。
Action
String
否
回源 URL 重写动作。取值有：
replace：指替换完整路径；用于将完整的请求 URL Path 替换为指定路径；
addPrefix：指增加路径前缀；用于增加指定路径前缀至请求 URL Path；
rmvPrefix：指移除路径前缀；用于移除请求 URL Path 的指定路径前缀；
regexReplace：指正则替换完整路径；用于通过 Google RE2 正则表达式匹配和替换完整路径。
Value
String
否
回源 URL 重写值。需要满足 URL Path 规范，且保证重写后的 Path 以 / 开头，以防止回源 URL 的 Host 被修改，长度范围为 1～1024。当 Action 为 addPrefix 时，不能以 / 结尾；当 Action 为 rmvPrefix 时，不能存在 *；当 Action 为 regexReplace 时，支持用 $NUM 引用正则捕获组，其中 NUM 代表组编号，如 $1，最多支持 $9。
Regex
String
否
回源 URL 重写用于正则替换匹配完整路径的正则表达式。需要满足 Google RE2 规范，长度范围为 1～1024。当 Action 为 regexReplace 时，此字段必填，否则无需填写此字段。

URLPath

访问 URL 重定向路径配置参数。
名称
类型
必选
描述
Action
String
否
执行动作，取值有：
follow：跟随请求；
custom：自定义；
regex：正则匹配。
Regex
String
否
正则匹配的表达式，长度范围为 1～1024。
注意：当 Action 为 regex 时，此字段必填；当 Action 为 follow 或 custom 时，无需填写此字段，若填写则不生效。
Value
String
否
重定向的目标URL，长度范围为 1～1024。 注意：当 Action 为 regex 或 custom 时，此字段必填；当 Action 为 follow 时，无需填写此字段，若填写则不生效。

UserRiskProfile

用户风险等级配置。风险分数范围为 0～100，分数越高表示风险越高。
名称
类型
必选
描述
HighRiskMinScore
Integer
否
高风险请求的最低风险分数。分数大于等于该值时，判定为高风险。
取值范围：[2, 99]
默认值：50
HighRiskRequestAction
否
高风险请求的处置方式。SecurityAction 的 Name 取值支持：
Deny：拦截；
Monitor：观察；
Redirect：重定向；
Challenge：挑战。
默认值：Monitor
MediumRiskMinScore
Integer
否
中风险请求的最低风险分数。分数大于等于该值且小于 HighRiskMinScore 时，判定为中风险；低于该值时，判定为低风险。
取值范围：[1, 98]
默认值：15
MediumRiskRequestAction
否
中风险请求的处置方式。SecurityAction 的 Name 取值支持：
Deny：拦截；
Monitor：观察；
Redirect：重定向；
Challenge：挑战。
默认值：Monitor

VaryParameters

Vary 特性 配置参数。
名称
类型
必选
描述
Switch
String
是
Vary 特性配置开关，取值有：
on：开启；
off：关闭。

WebSecurity

Web 安全防护配置组，定义站点级默认策略、各域名策略绑定关系及策略模板。
配置字段
类型
必选
描述
ZoneDefaultPolicy
否
站点级策略的配置详情。
HostPolicy
否
域名级策略的配置详情。
Templates
否
策略模板的配置详情。

WebSecurityTemplates

模板的安全配置。
名称
类型
必选
描述
TemplateId
String
否
策略模板的 ID
TemplateName
String
否
策略模板名称。由中文、英文、数字和下划线组成，不能以下划线开头，且长度不能超过 32 个字符。
Policy
否
策略模板的策略配置，配置对所有关联了该策略模板的域名生效。

WebSocketParameters

WebSocket 配置。
名称
类型
必选
描述
Switch
String
否
WebSocket 超时时间配置开关，取值有：
on：使用 Timeout 作为 WebSocket 超时时间；
off：平台仍支持 WebSocket 连接，此时使用系统默认的 15 秒为超时时间。
Timeout
Integer
否
超时时间，单位为秒，最大超时时间 120 秒。
注意：当 Switch 为 on 时，此字段必填，否则此字段不生效。

ZoneConfig

站点加速配置。
名称
类型
必选
描述
SmartRouting
否
智能加速配置。
注意：此字段可能返回 null，表示取不到有效值。
Cache
否
缓存过期时间配置。
注意：此字段可能返回 null，表示取不到有效值。
MaxAge
否
浏览器缓存配置。
注意：此字段可能返回 null，表示取不到有效值。
CacheKey
否
节点缓存键配置。
注意：此字段可能返回 null，表示取不到有效值。
CachePrefresh
否
缓存预刷新配置。
注意：此字段可能返回 null，表示取不到有效值。
OfflineCache
否
离线缓存配置。
注意：此字段可能返回 null，表示取不到有效值。
Compression
否
智能压缩配置。
注意：此字段可能返回 null，表示取不到有效值。
ForceRedirectHTTPS
否
访问协议强制 HTTPS 跳转配置。
注意：此字段可能返回 null，表示取不到有效值。
HSTS
否
HSTS 相关配置。
注意：此字段可能返回 null，表示取不到有效值。
TLSConfig
否
TLS 相关配置。
注意：此字段可能返回 null，表示取不到有效值。
OCSPStapling
否
OCSP 装订配置。
注意：此字段可能返回 null，表示取不到有效值。
HTTP2
否
HTTP2 相关配置。
注意：此字段可能返回 null，表示取不到有效值。
QUIC
否
QUIC 访问配置。
注意：此字段可能返回 null，表示取不到有效值。
UpstreamHTTP2
否
HTTP2 回源配置。
注意：此字段可能返回 null，表示取不到有效值。
IPv6
否
IPv6 访问配置。
注意：此字段可能返回 null，表示取不到有效值。
WebSocket
否
WebSocket 配置。
注意：此字段可能返回 null，表示取不到有效值。
PostMaxSize
否
POST 请求传输配置。
注意：此字段可能返回 null，表示取不到有效值。
ClientIPHeader
否
客户端 IP 回源请求头配置。
注意：此字段可能返回 null，表示取不到有效值。
ClientIPCountry
否
回源时是否携带客户端 IP 所属地域信息的配置。
注意：此字段可能返回 null，表示取不到有效值。
Grpc
否
gRPC 协议支持配置。
注意：此字段可能返回 null，表示取不到有效值。
NetworkErrorLogging
否
网络错误日志记录配置。
注意：此字段可能返回 null，表示取不到有效值。
AccelerateMainland
否
中国大陆加速优化配置。
注意：此字段可能返回 null，表示取不到有效值。
StandardDebug
否
标准 Debug 配置。
注意：此字段可能返回 null，表示取不到有效值。

ZoneCustomVariables

站点级自定义变量配置，包括变量定义和变量运算。
名称
类型
必选
描述
CustomVariables
Array of CustomVariable
是
站点级自定义变量列表。CustomVariable.Name 需要使用 user.zone. 作为前缀。变量按照数组顺序依次初始化，InitialValue 仅支持引用位于当前变量之前的变量，不支持引用当前变量自身或位于当前变量之后的变量。
CustomVariableOperations
是
站点级自定义变量运算规则。运算中支持引用已定义的站点级自定义变量。此列表当前只支持填写一项规则，多填无效。

ZoneFullConfig

站点完整配置结构。
名称
类型
必选
描述
FormatVersion
String
是
语法版本，当前默认为 1.0，输入其他值将会报错。
ZoneConfig
否
站点级配置，包含「站点加速」中所有配置项，且所有项均为必选，否则配置无效。
Rules
否
规则级配置，包含「规则引擎」中所有规则，且数组可为空，表示不启用任何规则。
WebSecurity
否
Web 安全防护配置，对应控制台中「安全防护 - Web 防护」里支持的功能。
FunctionTriggers
否
边缘函数触发规则配置，包含触发「边缘函数」中所有规则，且数组可为空，表示不启用任何规则。
ZoneCustomVariables
否
站点级自定义变量配置，包括变量定义和变量运算。

中国站