本文介紹防護規則(DefenseRule)配置相關OpenAPI的通用參數。
conditions配置說明
|
名稱 |
類型 |
是否必選 |
樣本值 |
描述 |
|
key |
String |
必選 |
IP |
匹配欄位。取值:URL、URLPath、IP、Referer、User-Agent、Params、Cookie、Content-Type、Content-Length、X-Forwarded-For、Post-Body、Http-Method、Header、Extension、Filename、Server-Port、Host、Cookie-Exact、Query-Arg、Post-Arg。 Bot管理進階自訂規則特有欄位:Client-ID、Ja3-Fingerprint、Ja4-Fingerprint、Http2-Fingerprint、Isp-ID、WebSdk、AppSdk。 重要
不同的 WAF 版本支援的匹配欄位不同,請以 WAF 控制台對應類型規則中匹配欄位為準。 |
|
subKey |
String |
可選 |
abc |
自訂子匹配欄位。 說明
並不是每一個自訂規則的匹配欄位(key)都有自訂子匹配欄位(subKey)。關於不同匹配欄位是否支援自訂子匹配欄位,請以 WAF 控制台對應類型規則中匹配欄位和自訂匹配欄位的關係為準。 |
|
opValue |
String |
必選 |
contain |
邏輯符。取值:
說明
並不是每一個自訂規則的匹配欄位(key)都能對應配置全部的邏輯符(opValue)。關於不同匹配欄位支援使用的邏輯符,請以 WAF 控制台對應類型規則中匹配欄位和邏輯符的關聯關係為準。 |
|
values |
String |
必選 |
abc |
匹配內容,根據需要填寫相應的內容,多個值之間使用英文逗號(,)分隔。 說明
匹配條件參數中的邏輯符(opValue)、匹配內容(values)參數取值範圍與所指定的匹配欄位(key)相關。 |
ratelimit配置說明
|
名稱 |
類型 |
是否必選 |
樣本值 |
描述 |
|
target |
String |
必選 |
remote_addr |
統計物件類型。取值:
以下參數僅 Bot 進階自訂規則支援:
|
|
subKey |
String |
可選 |
abc |
統計對象的子特徵。當 target 參數值為 cookie、header 、queryarg 或postarg 時,必須在 subkey 參數中填寫對應的資訊。 |
|
interval |
Integer |
必選 |
60 |
統計時間長度,單位為秒。即訪問次數的統計周期,與閾值(threshold)參數配合。 |
|
threshold |
Integer |
必選 |
200 |
在檢測時間長度內,允許單個統計對象訪問被防護地址的次數閾值。 |
|
ttl |
Integer |
必選 |
1800 |
處置動作的生效時間長度,單位為秒。 |
|
status |
JSON |
可選 |
{"code":404,"count":200} |
響應碼頻率設定。以 JSON 字串格式進行描述,具體包含以下參數:
|
|
distinctStat |
Array |
可選 |
[{"key":"URL","opValue":"gt","values":"1"}] |
去重統計條件配置。 說明
僅 Bot進階自訂規則支援。具體配置資訊,請參見 distinctStat 詳細配置。 |
distinctStat 配置說明
|
名稱 |
類型 |
是否必選 |
樣本值 |
描述 |
|
key |
String |
必選 |
IP |
匹配欄位。取值:URL、URLPath、IP、Cookie-Exact、Post-Arg、Header、Query-Arg、Ja3-Fingerprint、Ja4-Fingerprint、Http2-Fingerprint、WebSdk、AppSdk。 重要
去重統計的匹配欄位與購買的Bot管理防護功能相關,具體支援情況以WAF控制台支援的匹配欄位為準。 |
|
subKey |
String |
可選 |
abc |
自訂去重條件子匹配欄位。 說明
並不是每一個去重統計條件規則的匹配欄位(key)都有自訂子匹配欄位(subKey)。關於不同匹配欄位是否支援子匹配欄位,請以 WAF 控制台 BOT 進階自訂規則中去重統計條件配置下匹配欄位和自訂匹配欄位的關係為準。 |
|
opValue |
String |
必選 |
Equal |
邏輯符。取值:
|
|
value |
String |
必選 |
abc |
匹配欄位的值。 |
grayConfig配置說明
|
名稱 |
類型 |
是否必選 |
樣本值 |
描述 |
|
grayTarget |
String |
必選 |
80 |
灰階物件類型。取值:
以下參數僅 Bot 進階自訂規則支援:
|
|
graySubKey |
String |
可選 |
abc |
統計對象的子特徵。當 grayTarget 參數值為 cookie、header 或 queryarg 時,必須在 graySubKey 參數中填寫對應的資訊。 |
|
grayRate |
Integer |
必選 |
20 |
灰階生效百分比。取值範圍為:1~100。 |
timeConfig配置說明
|
名稱 |
類型 |
是否必選 |
樣本值 |
描述 |
|
timeScope |
String |
必選 |
period |
規則生效時間範圍。取值:
|
|
timeZone |
Integer |
必選 |
8 |
規則生效的時區,預設為 8,取值範圍:-12~12,其中 0 表示世界時間,8 表示 UTC+8 東八區,-8表示 UTC-8 西八區。 |
|
timePeriods |
Array |
可選 |
[{"start":1758771729787,"end":1758816000000}] |
規則生效的時間段。當 timeScope 參數值為 period 時,必須設定該參數,支援設定多個時間段。具體包含以下參數:
|
|
weekTimePeriods |
Array |
可選 |
[{"day":"1","dayPeriods":[{"start":0,"end":51644084}]},{"day":"1,2,5","dayPeriods":[{"start":0,"end":42928908}]}] |
規則周期性生效的時間段。當 timeScope 參數值為 cycle 時,必須設定該參數,支援設定多個時間段。具體包含以下參數:
|