獲取指定域名配置當前的防護模式,如正則防護引擎、大數據深度學習引擎、CC安全防護、數據風控、主動防御。
接口說明
本接口用于查詢網站防護配置中,指定防護模塊(包括規則防護引擎、深度學習引擎、CC 安全防護、數據風控、主動防御)當前使用的防護模式。 您可以通過設置 DefenseType 參數值指定要查詢的防護模塊。具體參數值的含義,請參見請求參數 DefenseType 的描述。 調用接口前,您必須已經調用 CreateDomain 創建了網站接入配置,將網站域名接入 WAF 防護。 請注意,為了確保系統的文檔性,對單用戶 QPS 限制為 10 次/秒。超過限制,API 調用將會被限流,這可能影響您的業務,請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
yundun-waf:DescribeProtectionModuleMode | Read |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Domain | string | 是 | 要查詢的網站域名。 說明
網站域名必須已經接入 WAF 防護。您可以調用 DescribeDomainList 查詢所有已接入 WAF 防護的網站域名。
| www.aliyundoc.com |
DefenseType | string | 是 | 要查詢其模式的防護模塊。取值:
| waf |
InstanceId | string | 是 | WAF 實例的 ID。 說明
您可以調用 DescribeInstanceInfo 查詢當前 WAF 實例的 ID。
| waf-cn-tl32ast**** |
ResourceGroupId | string | 否 | 網站域名在資源管理服務中所屬的資源組 ID。不設置該參數表示默認資源組。 | rg-atstuj3rtop**** |
調用 API 時,除了本文中該 API 的請求參數,還需加入阿里云 API 公共請求參數。公共請求參數的詳細介紹,請參見公共參數。 調用 API 的請求格式,請參見本文示例中的請求示例。
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "DE14845A-F46F-59BE-B8F7-6ED7A787D213",
"Mode": 0
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。