分頁查詢防護規則。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-waf:DescribeDefenseRules

list

*全部資源

*

acs:ResourceGroupId

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	WAF 執行個體 ID。說明您可以通過調用 DescribeInstance 介面查看當前 WAF 執行個體 ID。	waf_cdnsdf3****
RuleType	string	否	防護規則類型。取值： whitelist：白名單規則 defense（預設）：防護規則說明僅當 DefenseType 為 template 時，需要傳入該參數。	whitelist
Query	string	否	查詢條件，以一系列參數構造的 JSON 格式轉化成字串。說明根據不同的查詢條件，查詢到的防護規則結果不同。詳細資料，請參見Query 參數描述。	{\"name\":\"IP壓制_20220822_10\",\"scene\":\"custom_acl\",\"templateId\":5327}
PageNumber	integer	否	分頁查詢時，返回第幾頁資料。預設值為 1，表示返回第 1 頁資料。	1
PageSize	integer	否	分頁查詢時，每頁包含多少條結果。預設值為 10，表示每頁包含 10 條結果。	10
DefenseType	string	否	防護規則類型。取值： template（預設）：表示模板防護規則。 resource：表示防護對象維度規則。 global：表示全域維度規則。枚舉值： template : template resource : resource global : global	template
RegionId	string	否	WAF 執行個體所屬地區。取值： cn-hangzhou：表示中國內地。 ap-southeast-1：表示非中國內地。	cn-hangzhou
ResourceManagerResourceGroupId	string	否	阿里雲資源群組 ID。	rg-acfm***q

Query 參數詳解

模版防護規則（template）

當防護規則類型 DefenseType 為 template 時，具體的參數描述如下。

參數描述

名稱	類型	是否必選	樣本值	描述
name	String	可選	test	要查詢的防護規則名稱。您可以設定該參數，精確查詢某條防護規則。
nameId	String	可選	test1	要查詢的防護規則 ID 或名稱。您可以設定該參數，模糊查詢某條防護規則。
nameLike	String	可選	test.aliyundoc.c	要查詢的防護規則名稱。您可以設定該參數，模糊查詢某條防護規則。
scene	String	可選	waf_group	要查詢的防護情境。您可以設定該參數，精確查詢某個防護情境的防護規則。取值： - waf_group：表示基礎防護的正則規則。 - waf_base：表示新版 Web 核心防護規則。 - waf_base_compliance：表示基礎防護的協議合規規則。 - waf_base_sema：表示基礎防護的語義規則。 - cc：表示 cc 防護。 - antiscan_dirscan：表示掃描防護中的目錄遍曆封鎖。 - antiscan_highfreq：表示掃描防護中的高頻掃描封鎖。 - antiscan_scantools：表示掃描防護中的掃描工具封鎖。 - ip_blacklist：表示 IP 黑名單。 - custom_acl：表示自訂規則。 - region_block：表示地區封鎖。 - tamperproof：表示網頁防篡改。 - dlp：表示資訊洩漏防護。 - custom_response_block：表示自訂響應。
ruleId	Long	可選	33444	要查詢的防護規則 ID。您可以設定該參數，精確查詢某條防護規則。
ruleIdIn	Array	可選	[3334455643,345555]	要查詢的防護規則 ID 範圍。您可以設定該參數，查詢多個防護規則。多個防護規則之間使用英文逗號（,）分隔。
templateId	Long	可選	24354	要查詢的防護模板 ID。您可以設定該參數，查詢某個防護模板中的防護規則。
orderBy	String	可選	name	設定防護規則排序方式。取值： - name : 表示按防護規則名稱排序。 - gmtModified : 表示按防護規則修改時間排序。 - id : 表示按規則 ID 排序。 - templateId : 表示按防護模板 ID 排序。
desc	Boolean	可選	true	設定排序次序。取值： - false : 表示正序顯示。 - true : 表示倒序顯示。

樣本

{
    "name": "test",
    "nameId ": "test1,
    "nameLike": "test.aliyundoc.c",
    "nameIn": "test.aliyundoc.c",
    "InstaneId": "test1.aliyundoc.com,test2.aliyundoc.com",
    "templateId": 24354
}

防護對象維度規則（resource）

當防護規則類型 DefenseType 為 resource 時，具體的參數描述如下。

參數描述

名稱	類型	是否必選	樣本值	描述
resource	String	可選	sec****-waf	規則對應的防護對象。
scene	String	可選	waf_group	要查詢的防護情境。您可以設定該參數，精確查詢某個防護情境的防護規則。取值： - account_identifier：表示帳號擷取規則。 - custom_response：表示新版自訂響應。

樣本

{
    "resource": "sec****-waf",
    "scene ": "account_identifier"
}

全域維度規則（global）

當防護規則類型 DefenseType 為 global 時，具體的參數描述如下。

參數描述

名稱	類型	是否必選	樣本值	描述
scene	String	可選	regular_custom	要查詢的防護情境。您可以設定該參數，精確查詢某個防護情境的防護規則。取值： - regular_custom：表示自訂正則規則。 - custom_response：表示新版自訂響應。
detectType	String	可選	sqli	要查詢的檢測模組，取值： - sqli：表示 SQL 注入。 - xss：表示跨站指令碼（XSS）。 - cmdi：表示 OS 命令注入。 - expression_injection：表示運算式注入。 - java_deserialization：表示 Java 還原序列化。 - dot_net_deserialization：表示.net 還原序列化。 - php_deserialization：表示 PHP 還原序列化。 - code_exec：表示代碼執行。 - ssrf：表示 SSRF（伺服器端請求偽造）。 - path_traversal：表示路徑穿越。 - arbitrary_file_uploading：表示任意檔案上傳。 - webshell：表示 webshell。 - rfilei：表示遠程檔案包含（RFI）。 - lfilei：表示本地檔案包含（LFI）。 - protocol_violation：表示協議違背。 - scanner_behavior：表示掃描器行為。 - logic_flaw：表示商務邏輯缺陷。 - arbitrary_file_reading：表示任意檔案讀取。 - arbitrary_file_download：表示任意檔案下載。 - xxe：表示外部實體注入。 - csrf：表示跨站請求偽造。 - crlf：表示 CRLF。 - other：表示其他。重要僅當防護情境(scene)為自訂正則規則（regular_custom）時，支援查詢。
riskLevel	String	可選	strict	要查詢的風險等級。取值： - super_strict：超嚴格。 - strict：嚴格。 - medium：中等。 - loose：寬鬆。重要僅當防護情境(scene)為自訂正則規則（regular_custom）時，支援查詢。
templateId	Long	可選	24354	要查詢的防護模板 ID。您可以設定該參數，查詢某個防護模板中的防護規則。重要僅當防護情境(scene)為自訂正則規則（regular_custom）時，支援查詢。

樣本

{
    "detectType": "sqli",
    "riskLevel ": "strict",
    "templateId": 24354
}

返回參數

名稱	類型	描述	樣本值
	object	請求結果。
TotalCount	integer	返回結果的總數。	2
RequestId	string	請求 ID。	80736FA5-FA87-55F6-AA69-C5477C6FE6D0
Rules	array<object>	防護規則列表。
	object	防護規則列表。
Status	integer	防護規則狀態。取值： 0：表示已禁用。 1：表示已啟用。	1
DefenseOrigin	string	防護來源。取值： custom：使用者自訂。 system：系統自動產生。	custom
Config	string	防護規則詳情，以一系列參數構造的 JSON 格式轉化成字串。更多資訊，請參見 CreateDefenseRule 的Rule 參數具體說明。	{\"policyId\":1012,\"action\":\"block\"}
RuleId	integer	防護規則 ID。	42755
DefenseScene	string	防護情境。當入參防護規則類型 DefenseType 為 template 時，取值： waf_group：表示基礎防護的正則規則。 waf_base：表示新版 Web 核心防護。 waf_base_compliance：表示基礎防護的協議合規規則。 waf_base_sema：表示基礎防護的語義規則。 cc：表示 cc 防護。 antiscan_dirscan：表示掃描防護中的目錄遍曆封鎖。 antiscan_highfreq：表示掃描防護中的高頻掃描封鎖。 antiscan_scantools：表示掃描防護中的掃描工具封鎖。 ip_blacklist：表示 IP 黑名單。 custom_acl：表示自訂規則。 region_block：表示地區封鎖。 tamperproof：表示網頁防篡改。 dlp：表示資訊洩漏防護。 custom_response_block：表示自訂響應。 spike_throttle：表示洪峰限流。當入參防護規則類型 DefenseType 為 resource 時，取值： account_identifier：表示帳號提取。 custom_response：表示新版自訂響應。 waf_codec：表示解碼。當入參防護規則類型 DefenseType 為 global 時，取值： regular_custom：表示自訂正則。 address_book：表示地址簿。 custom_response：表示新版自訂響應。	waf_group
GmtModified	integer	防護規則修改時間。	1665460629000
RuleName	string	防護規則名稱。	rules_41
TemplateId	integer	防護規則模板 ID。	5673
GmtCreate	integer	防護規則建立時間。	1665460629000
Resource	string	規則所屬的防護對象。說明僅當入參 DefenseType 為 resource 時，會返回對應參數。	rencs***-waf
DefenseType	string	防護規則類型。取值： template（預設）：表示模板防護規則。 resource：表示防護對象維度規則。 global：表示全域維度規則。	template
Description `deprecated`	string	廢棄欄位，無實際含義。	rule description
RuleType `deprecated`	string	廢棄欄位，無實際含義。	custom_cc
ActionExternal `deprecated`	string	廢棄欄位，無實際含義。	42755
DetailRuleIds `deprecated`	string	廢棄欄位，無實際含義。	42755
ExternalInfo `deprecated`	string	廢棄欄位，無實際含義。	{\"DetectType\":\"sqli\"}

樣本

正常返回樣本

JSON格式

{
  "TotalCount": 2,
  "RequestId": "80736FA5-FA87-55F6-AA69-C5477C6FE6D0",
  "Rules": [
    {
      "Status": 1,
      "DefenseOrigin": "custom",
      "Config": "{\\\"policyId\\\":1012,\\\"action\\\":\\\"block\\\"}",
      "RuleId": 42755,
      "DefenseScene": "waf_group",
      "GmtModified": 1665460629000,
      "RuleName": "rules_41",
      "TemplateId": 5673,
      "GmtCreate": 1665460629000,
      "Resource": "rencs***-waf",
      "DefenseType": "template",
      "Description": "rule description",
      "RuleType": "custom_cc",
      "ActionExternal": "42755",
      "DetailRuleIds": "42755",
      "ExternalInfo": "{\\\"DetectType\\\":\\\"sqli\\\"}"
    }
  ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。