調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
yundun-waf:DescribeRules | Read |
|
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
SourceIp | string | 否 | 請求源 IP。無需填寫,系統(tǒng)自動獲取。 | 42.84.*.* |
PageSize | integer | 否 | 分頁查詢時,每頁的行數(shù)。默認值為 10。 | 10 |
PageNumber | integer | 否 | 當前頁碼。默認值:1。 | 1 |
RuleIdKey | string | 否 | 規(guī)則的 id,支持模糊查詢 | 1131*0 |
CveIdKey | string | 否 | CVE ID | CVE-*-*5 |
ProtectionType | integer | 否 | 防護類型。取值如下:
| 11 |
ApplicationType | integer | 否 | 應用類型。取值如下:
| 0 |
RiskLevel | integer | 否 | 要查詢的檢查項風險等級。取值:
| 0 |
RuleGroupId | long | 是 | 正則規(guī)則組 ID | 1012 |
Lang | string | 否 | 設置規(guī)則名稱的語言屬性,取值:
| zh |
InstanceId | string | 是 | WAF 實例 ID。 說明
您可以通過調(diào)用 DescribeInstance 接口查看當前 WAF 實例 ID。
| waf-cn-* |
Region | string | 否 | 地域 ID。取值:
| cn |
ResourceGroupId | string | 否 | WAF 實例在資源管理服務中所屬的資源組 ID。默認為空,即屬于默認資源組。 關(guān)于資源組的更多信息,請參見創(chuàng)建資源組。 | rg-* |
RegionId | string | 否 | WAF 實例所屬地域。取值:
| cn-hangzhou |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RuleGroupTemplateId": "1012",
"RuleGroupName": "test111",
"RequestId": "D7861F61-5B61-46CE-A47C-*",
"TotalCount": 1,
"RuleGroupTemplateName": "rule_group_test",
"IsSubscribe": 1,
"Rules": [
{
"RiskLevel": 0,
"UpdateTime": 1684120148,
"Description": "默認",
"CveUrl": "https://avd.aliyun.com/",
"ApplicationType": 15,
"CveId": "CVE-2021-*",
"ProtectionType": 11,
"RuleName": "rules_41",
"RuleId": 42755
}
]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。