本產品（
Web 應用防火墻/2019-09-10）的OpenAPI采用RPC簽名風格，簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK，開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜，需花費 5個工作日左右。因此建議加入我們的服務釘釘群（11370001915），在專家指導下進行簽名對接。在使用API前，您需要準備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細節請參見獲取AccessKey。
實例信息
| API | 標題 | API概述 |
|---|---|---|
| DescribeInstanceInfo | 獲取WAF實例的當前信息 | 查詢當前阿里云賬號下WAF實例的詳情。 |
| DescribeInstanceSpecInfo | 獲取WAF實例的規格信息 | 查詢WAF實例的規格信息。 |
| DeleteInstance | 釋放Web應用防火墻（WAF）實例 | 釋放Web應用防火墻（WAF）按量付費實例或者到期的包年包月實例。 |
域名配置
| API | 標題 | API概述 |
|---|---|---|
| DescribeDomainNames | 獲取指定實例中已添加的域名名稱列表 | 獲取指定WAF實例中已添加的域名名稱列表。 |
| DescribeDomain | 獲取已添加的域名配置信息 | 查詢已添加到WAF防護的域名的配置信息。 |
| CreateDomain | 添加域名配置信息 | 將域名接入WAF實例進行防護。 |
| ModifyDomain | 修改指定域名配置信息 | 修改已創建的域名配置。 |
| DeleteDomain | 刪除指定域名配置信息 | 刪除指定域名配置信息。 |
| DescribeCertificates | 獲取指定域名可選證書 | 獲取指定域名可選的已有證書，即已在SSL證書中進行管理的證書。 |
| DescribeCertMatchStatus | 檢查域名上傳的證書和私鑰是否匹配 | 檢查指定域名配置上傳的證書和私鑰信息是否匹配。 |
| CreateCertificate | 為已添加域名上傳證書及私鑰信息 | 為已添加的域名配置記錄上傳證書及私鑰信息。 |
| CreateCertificateByCertificateId | 根據證書ID為指定域名創建證書 | 調用CreateCertificateByCertificateId接口根據證書ID為指定域名創建證書。 |
| DescribeDomainBasicConfigs | 獲取域名配置記錄的防護設置狀態 | 調用DescribeDomainBasicConfigs查詢已接入WAF防護的網站域名的基本配置。 |
| DescribeDomainAdvanceConfigs | 獲取已添加的域名配置記錄的詳細信息 | 調用DescribeDomainAdvanceConfigs查詢已添加到WAF防護的域名的詳細配置。 |
| DescribeDomainList | 查詢域名資產信息 | 調用DescribeDomainList分頁查詢已添加到WAF防護的域名列表。 |
防護配置
| API | 標題 | API概述 |
|---|---|---|
| DescribeProtectionModuleMode | 獲取域名當前的防護模式 | 獲取指定域名配置當前的防護模式，如正則防護引擎、大數據深度學習引擎、CC安全防護、數據風控、主動防御。 |
| ModifyDomainIpv6Status | 開啟或關閉域名配置的IPv6安全防護功能 | 開啟或關閉指定域名配置的IPv6安全防護功能。 |
| DescribeProtectionModuleStatus | 查詢WAF各防護功能狀態 | 查詢WAF各防護功能的狀態，包括Web入侵防護、數據安全、高級防護、Bot管理、訪問控制或限流等模塊。 |
| ModifyProtectionModuleStatus | 打開或關閉指定WAF防護功能 | 打開或關閉指定的WAF防護功能，如Web入侵防護、數據安全、高級防護、Bot管理、訪問控制或限流。 |
| ModifyProtectionModuleMode | 修改WAF防護模式 | 修改WAF防護模式，如正則防護引擎、大數據深度學習引擎、CC安全防護、數據風控、主動防御等模塊。 |
| DescribeProtectionModuleRules | 查詢WAF防護功能規則配置記錄 | 查詢WAF防護功能規則配置記錄，如Web入侵防護、數據安全、Bot管理、訪問控制或限流、網站白名單。 |
| CreateProtectionModuleRule | 在WAF防護功能模塊中創建配置規則 | 在指定的WAF防護功能模塊創建配置規則，如Web入侵防護、數據安全、高級防護、Bot、訪問控制、限流。 |
| ModifyProtectionModuleRule | 修改WAF防護功能配置規則 | 修改WAF防護功能的配置規則，如Web入侵防護、數據安全、高級防護、Bot、訪問控制、限流、白名單。 |
| ModifyProtectionRuleStatus | 啟用或禁用域名配置WAF防護功能模塊 | 啟用或禁用域名WAF防護功能模塊，如網站防篡改、合法爬蟲、爬蟲威脅情報、自定義防護策略、網站白名單。 |
| DescribeDomainRuleGroup | DescribeDomainRuleGroup | 調用DescribeDomainRuleGroup查詢域名綁定的防護規則組的ID及智能規則托管功能的啟用狀態。 |
| SetDomainRuleGroup | 為域名配置防護規則組 | 為指定域名配置選擇正則防護引擎使用的防護規則組，除系統默認的三種防護規則組外，也可以選擇自定義規則組。 |
| ModifyProtectionRuleCacheStatus | 更新網站防篡改規則所防護的頁面緩存 | 更新指定網站防篡改規則所防護的頁面的緩存。 |
| DeleteProtectionModuleRule | 刪除防護配置模塊的規則 | 調用DeleteProtectionModuleRule刪除指定防護模塊中配置的規則。 |
| DescribeProtectionModuleCodeConfig | 獲取WAF防護功能模塊代碼配置 | 調用DescribeProtectionModuleCodeConfig查詢WAF地域級IP黑名單中支持配置的地域代碼。 |
| DescribeRuleGroups | 分頁查詢正則規則組 | |
| DescribeRules | 分頁查詢正則規則組中的規則 |
日志管理
| API | 標題 | API概述 |
|---|---|---|
| ModifyLogRetrievalStatus | 為指定域名開啟或關閉日志檢索功能 | 為指定域名開啟或關閉日志檢索功能。 |
| ModifyLogServiceStatus | 開啟或關閉指定域名配置的日志采集功能 | 調用ModifyLogServiceStatus接口開啟或關閉指定域名配置的日志采集功能。 |
| DescribeLogServiceStatus | 查詢日志采集狀態 | 查詢已接入WAF進行防護的域名的日志采集狀態（是否開啟日志采集）。 |
系統管理
| API | 標題 | API概述 |
|---|---|---|
| DescribeWafSourceIpSegment | 獲取WAF實例的回源IP網段列表 | 查詢WAF防護集群使用的回源IP網段。 |
資源相關接口
| API | 標題 | API概述 |
|---|---|---|
| MoveResourceGroup | 將資源移動到新的資源組 | 將一個WAF資源轉移到其他資源組。 |