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