版本 2.1.1792967583 · 最新 下载 OpenAPI Markdown 版

全网 URL 防护设置

平台级全网 URL 防护的缺省开关与阈值,仅管理员可改;站点各自的开关与阈值在站点安全配置里。

url-guard-settings防护鉴权: 仅管理员2 个接口

获取全网 URL 防护设置

GET/api/v2/url-guard-settings
鉴权: 仅管理员

修改全网 URL 防护设置

PUT/api/v2/url-guard-settings
鉴权: 仅管理员

请求体 application/json

字段类型必填说明
actionstring必填 触发后对该 URL 的动作:挑战验证、拦截、每 IP 限速。
可选值 ["challenge","block","limit"]
baseline_ratiointeger— 触发还须达到平时的这么多倍(平时 = 该 URL 过去 1 小时的平均 QPS,不含最近 1 分钟);面板最小填 1,缺省 5;0 = 不看倍数(旧配置没有该字段,按 0 沿用原判定)。只管新触发,已在途规则续期只看 QPS。修改时不带则保持原值。
enabledboolean必填 全局默认开关;站点未单独设置时按它。
expected_updated_atstring— 乐观锁:调用方读到的 updated_at(读到为空用 1970-01-01T00:00:00Z)。与库里当前值不等则回 409 stale_version、不保存;不带则不检查。
gatestring— WAF 增强(waf_enhanced)判定档:full 开通、readonly 到期只读缓冲内(License.readonly_days,缺省 7 天;照常生效、设置只读)、basic 未开通或已回落(不下发);修改时忽略。
可选值 ["full","readonly","basic"]
gate_expired_atstring— 仅管理员响应且 gate_reason=expired 时带:平台 WAF 增强授权的到期时刻;租户响应不带。
gate_ownerWafGateOwner— 站点属主,仅管理员响应带;租户响应不带别人的信息。
gate_packagesstring[]— 仅管理员响应带:属主名下未到期的套餐名(最多 20 个);租户响应不带。
gate_reasonWafGateReason— WAF 增强(waf_enhanced)没生效的原因,gate 为 full 或 readonly 时不带。package = 平台已授权但属主没有未到期且含 WAF 增强的套餐;license = 平台没开通(从未授权、服务商撤销、授权被停用);expired = 平台授权已到期且只读缓冲期(License.readonly_days,缺省 7 天)已过,已回落基础。
可选值 ["package","license","expired"]
hold_sinteger必填 规则保持秒数;到期前仍超阈会自动续期,降下来就到期撤销。
kindstring— action=challenge 的挑战类型,缺省 js;其它动作须为空。
可选值 ["js","redirect","delay_jump","cookie","captcha","slide","click","rotate"]
max_per_siteinteger必填 同一站点同时生效的规则条数上限。
qpsinteger必填 某 URL 全网合计 QPS 不低于它(且达到平时的 baseline_ratio 倍)才触发。
rateinteger— action=limit 的每 IP 每 10 秒最多请求数;其它动作须为 0。
updated_atstring— 响应里的版本(没改过为空);修改时忽略,乐观锁用 expected_updated_at。

全网 URL 防护设置对象

字段类型必填说明
actionstring— 触发后对该 URL 的动作:挑战验证、拦截、每 IP 限速。
可选值 ["challenge","block","limit"]
baseline_ratiointeger— 触发还须达到平时的这么多倍(平时 = 该 URL 过去 1 小时的平均 QPS,不含最近 1 分钟);面板最小填 1,缺省 5;0 = 不看倍数(旧配置没有该字段,按 0 沿用原判定)。只管新触发,已在途规则续期只看 QPS。修改时不带则保持原值。
enabledboolean— 全局默认开关;站点未单独设置时按它。
expected_updated_atstring— 乐观锁:调用方读到的 updated_at(读到为空用 1970-01-01T00:00:00Z)。与库里当前值不等则回 409 stale_version、不保存;不带则不检查。
gatestring— WAF 增强(waf_enhanced)判定档:full 开通、readonly 到期只读缓冲内(License.readonly_days,缺省 7 天;照常生效、设置只读)、basic 未开通或已回落(不下发);修改时忽略。
只读可选值 ["full","readonly","basic"]
gate_expired_atstring— 仅管理员响应且 gate_reason=expired 时带:平台 WAF 增强授权的到期时刻;租户响应不带。
只读
gate_ownerWafGateOwner— 站点属主,仅管理员响应带;租户响应不带别人的信息。
只读
gate_packagesstring[]— 仅管理员响应带:属主名下未到期的套餐名(最多 20 个);租户响应不带。
只读
gate_reasonWafGateReason— WAF 增强(waf_enhanced)没生效的原因,gate 为 full 或 readonly 时不带。package = 平台已授权但属主没有未到期且含 WAF 增强的套餐;license = 平台没开通(从未授权、服务商撤销、授权被停用);expired = 平台授权已到期且只读缓冲期(License.readonly_days,缺省 7 天)已过,已回落基础。
只读可选值 ["package","license","expired"]
hold_sinteger— 规则保持秒数;到期前仍超阈会自动续期,降下来就到期撤销。
kindstring— action=challenge 的挑战类型,缺省 js;其它动作须为空。
可选值 ["js","redirect","delay_jump","cookie","captcha","slide","click","rotate"]
max_per_siteinteger— 同一站点同时生效的规则条数上限。
qpsinteger— 某 URL 全网合计 QPS 不低于它(且达到平时的 baseline_ratio 倍)才触发。
rateinteger— action=limit 的每 IP 每 10 秒最多请求数;其它动作须为 0。
updated_atstring— 响应里的版本(没改过为空);修改时忽略,乐观锁用 expected_updated_at。
只读