API概览_Web应用防火墙-阿里云帮助中心

本产品（Web 应用防火墙/2021-10-01）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

实例信息

API	标题	API概述
DescribeInstance	获取WAF实例详情	获取当前阿里云账号下WAF实例的详情。

接入配置

API	标题	API概述
CreateDomain	添加CNAME接入资源	将域名接入WAF实例进行防护。
ModifyDomain	修改CNAME接入资源	修改CNAME接入域名。
DeleteDomain	删除CNAME接入资源	删除CNAME接入域名。
DescribeDomainDetail	查询CNAME接入详情	查询域名接入详情。
DescribeDomains	查询CNAME接入列表	查询添加到 Web 应用防火墙的域名列表。
DescribeResourcePort	查询实例下的所有已接入WAF端口	查询实例下的所有已接入WAF端口。
DescribeWafSourceIpSegment	获取waf实例的回源IP网段列表	查询WAF回源网段。

防护配置

API	标题	API概述
防护对象	防护对象
CreateDefenseResourceGroup	创建防护组	创建防护对象组。
ModifyDefenseResourceGroup	修改防护对象组	修改防护对象组配置信息。
DeleteDefenseResourceGroup	删除防护对象组	删除防护对象组。
DescribeDefenseResourceGroup	查询单个防护对象组	查询单个防护对象组信息。
DescribeDefenseResources	分页查询防护对象	分页查询防护对象。
防护规则	防护规则
CreateDefenseTemplate	创建防护模板	创建防护模板。
ModifyDefenseTemplate	修改防护模板	修改防护模板。
DescribeDefenseTemplate	查询单个防护模板	查询单个防护模板。
ModifyDefenseTemplateStatus	修改防护模板状态	修改防护模板状态。
DeleteDefenseTemplate	删除防护模板	删除防护模板。
CreateDefenseRule	创建防护规则	创建防护规则。
ModifyDefenseRule	修改防护规则	修改防护规则配置信息。
ModifyDefenseRuleStatus	修改防护规则状态	修改防护规则状态。
DeleteDefenseRule	删除防护规则	删除防护规则。
DescribeDefenseRule	查询单个防护规则	查询单个防护规则。
DescribeDefenseRules	分页查询防护规则	分页查询防护规则。
ModifyTemplateResources	防护资源绑定或解绑防护模板	绑定或解绑防护资源与防护模板的关系。
DescribeTemplateResources	查询防护模板绑定的资源	查询防护模板绑定的资源。
DescribeRuleGroups	分页查询正则规则组	分页查询正则规则组。
重保场景	重保场景
CreateMajorProtectionBlackIp	添加重保场景防护IP黑名单	添加WAF重保场景防护IP黑名单。
ModifyMajorProtectionBlackIp	修改重保场景防护IP黑名单	修改重保场景黑IP。
DeleteMajorProtectionBlackIp	删除重保场景防护IP黑名单	删除重保场景黑IP。
ClearMajorProtectionBlackIp	清空重保场景防护IP黑名单	清空重保场景黑IP。
DescribeMajorProtectionBlackIps	分页查询重保防护IP黑名单	分页查询重保黑IP。

报表信息

API	标题	API概述
DescribeFlowChart	查看流量统计信息	查看流量统计信息。
DescribePeakTrend	查看QPS变化趋势	查看请求QPS的变化趋势。
DescribeResponseCodeTrendGraph	查看响应码的趋势图	查看WAF返回给客户端、源站返回给WAF的5XX、405、499、302、444等异常响应码的数量变化趋势。
DescribeVisitUas	查看流量访问Top 10的UA	查看发起请求次数最多的前10个User-Agent。
DescribeVisitTopIp	查看流量访问Top 10的IP	查看发起请求次数最多的前10个IP。
DescribeRuleHitsTopResource	查看命中防护规则的Top 10 防护对象	查看触发防护规则次数最多的前10个防护对象。
DescribeRuleHitsTopRuleId	查看命中防护规则的Top 10规则ID	查看触发防护规则次数最多的前10个规则ID。
DescribeRuleHitsTopTuleType	查看命中防护规则的Top 10防护类型	查看触发防护规则次数最多的前10个防护类型。
DescribeRuleHitsTopUrl	查看命中防护规则的Top 10 URL	查看触发防护规则次数最多的前10个URL。
DescribeRuleHitsTopClientIp	查看发动攻击次数Top 10的攻击源IP	查看发动攻击次数最多的前10个攻击源IP。
DescribeFlowTopResource	查看流量访问Top 10的防护对象	查看请求量最高的前10个防护对象。
DescribeRuleHitsTopUa	查看发动攻击次数Top 10的攻击UA	查看发动攻击次数最多的前10个User-Agent。
DescribeFlowTopUrl	查看流量访问Top 10的URL	查看发起请求次数最多的前10个URL。

日志配置

API	标题	API概述
ModifyResourceLogStatus	修改防护对象日志状态	修改防护对象日志状态。
DescribeResourceLogStatus	查询防护对象日志状态	查询防护对象日志状态。