全部产品
Search
文档中心

Web 应用防火墙:API概览

更新时间:Jun 14, 2024
本产品(Web 应用防火墙/2021-10-01)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

实例信息

API标题API概述
CreatePostpaidInstance创建Web应用防火墙3.0(按量付费)实例创建Web应用防火墙3.0(按量付费)实例。
DescribeInstance获取WAF实例详情获取当前阿里云账号下WAF实例的详情。

接入配置

API标题API概述
云产品接入云产品接入
SyncProductInstance透明接入同步用户的ECS和CLB资产同步用户的ECS和CLB资产。
DescribeCloudResources查询云产品接入WAF的实例列表查询接入到WAF的云产品列表情况。
DescribeProductInstances查询已同步的云产品资产列表查询已同步的云产品资产列表。
DescribeResourceSupportRegions查询云产品接入的支持区域列表查询云产品接入的支持区域列表,主要指CLB,ECS产品。
DescribeResourceRegionId查询服务化接入的资源的地域ID查询服务化接入的资源的地域ID,主要指ALB和MSE产品。
DescribeResourceInstanceCerts查询云产品实例的证书列表查询云产品实例的证书列表,该接口返回当前委派管理员和实例所属用户的证书列表,该接口仅在多账号场景下使用。 如:用户A是委派管控员,有证书cert1,云产品实例lb-xx-1是成员用户B,有证书cert2,查询实例lb-xx-1时,接口返回cert1和cert2。
CNAME接入CNAME接入
DescribePunishedDomains查询已接入WAF域名的未备案处罚信息查询已接入WAF域名的未备案处罚信息。
ModifyDomainPunishStatus重新接入未备案处罚状态的域名重新接入未备案处罚状态的域名。
DescribeCertDetail查询证书详细信息查询证书详细信息,如证书名称、到期时间、签发时间,绑定域名等。
CreateDomain添加CNAME接入资源将域名接入WAF实例进行防护。
ModifyDomain修改CNAME接入资源修改CNAME接入域名。
DeleteDomain删除CNAME接入资源删除CNAME接入域名。
DescribeDomainDetail查询CNAME接入详情查询域名接入详情。
DescribeDomains查询CNAME接入列表查询添加到 Web 应用防火墙的域名列表。
DescribeCerts查询用户的可选证书列表查询用户的证书列表。
DescribeWafSourceIpSegment获取waf实例的回源IP网段列表查询WAF回源网段。
DescribeDomainDNSRecord查询CNAME域名DNS解析状态查询域名DNS是否正确。
混合云接入混合云接入
DescribeHybridCloudResources查询混合云CNAME接入列表查询混合云域名列表。
DescribeResourcePort查询实例下的所有已接入WAF端口查询实例下的所有已接入WAF端口。

防护配置

API标题API概述
防护对象防护对象
CreateDefenseResourceGroup创建防护对象组创建防护对象组。
ModifyDefenseResourceGroup修改防护对象组修改防护对象组配置信息。
DeleteDefenseResourceGroup删除防护对象组删除防护对象组。
DescribeDefenseResourceGroup查询单个防护对象组查询单个防护对象组信息。
DescribeDefenseResourceGroups分页查询防护对象组分页查询防护对象组。
DescribeDefenseResourceGroupNames查询防护对象组名称列表查询防护对象组名称列表。
DescribeDefenseResource查询单个防护对象查询单个防护对象。
DescribeDefenseResources分页查询防护对象分页查询防护对象。
DescribeDefenseResourceNames查询防护对象名称列表分页查询防护对象名称列表。
ModifyDefenseResourceXff修改防护对象的客户端IP和cookie设置修改防护对象的客户端IP和cookie设置。
防护规则防护规则
ModifyDefenseRuleCache更新网页防篡改防护规则缓存更新网页防篡改防护规则缓存。
DescribeDefenseResourceTemplates查询防护对象或防护组的防护模板查询防护对象或防护组的防护模板。
DescribeDefenseTemplateValidGroups查询防护模板待生效的防护对象组名称列表查询防护模板待生效的防护对象组名称列表。
DescribeDefenseTemplates分页查询防护模板列表分页查询防护模板列表。
CreateDefenseTemplate创建防护模板创建防护模板。
CopyDefenseTemplate复制防护模板复制当前防护模板,并生成一个新的防护模板。
ModifyDefenseTemplate修改防护模板修改防护模板。
DescribeDefenseTemplate查询单个防护模板查询单个防护模板。
ModifyDefenseTemplateStatus修改防护模板状态修改防护模板状态。
DeleteDefenseTemplate删除防护模板删除防护模板。
CreateDefenseRule创建防护规则创建防护规则。
ModifyDefenseRule修改防护规则修改防护规则配置信息。
ModifyDefenseRuleStatus修改防护规则状态修改防护规则状态。
DeleteDefenseRule删除防护规则删除防护规则。
DescribeDefenseRule查询单个防护规则查询单个防护规则。
DescribeDefenseRules分页查询防护规则分页查询防护规则。
ModifyTemplateResources防护资源绑定或解绑防护模板绑定或解绑防护资源与防护模板的关系。
DescribeTemplateResources查询防护模板绑定的资源查询防护模板绑定的资源。
DescribeTemplateResourceCount查询防护模板生效的防护资源个数查询防护模板生效的防护资源个数。
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概述
DescribeUserSlsLogRegions查询用户可用的日志存储地域查询用户可用的日志存储地域。
DescribeUserWafLogStatus查询用户WAF日志服务查询用户WAF日志服务的状态、RegionId,状态修改时间等。
DescribeSlsAuthStatus查询日志库授权状态查询日志库授权状态。
DescribeSlsLogStoreStatus查询日志库状态查询SLS日志库的状态。
DescribeSlsLogStore查询日志库信息查看日志库总容量,存储时长,已使用容量等信息。
ModifyResourceLogStatus修改防护对象日志状态修改防护对象日志状态。
DescribeResourceLogStatus查询防护对象日志状态查询防护对象日志状态。

混合云集群管理

API标题API概述
ModifyHybridCloudClusterBypassStatus修改混合云服务化集群手动Bypass开关修改混合云服务化集群手动Bypass开关。
DescribeHybridCloudUser查询混合云客户端口查询混合云接入,客户允许使用的端口范围,内容返回包括HTTP和HTTPS两类端口。
DescribeHybridCloudGroups查询混合云集群下节点组列表查询添加到Web应用防火墙的混合云节点组列表。

多账号统一管理

API标题API概述
CreateMemberAccounts添加成员账号多账号统一管理功能中添加WAF成员账号。
ModifyMemberAccount修改成员账号多账号统一管理中修改成员账号信息。
DeleteMemberAccount删除成员账号多账号统一管理中删除WAF成员账号。
DescribeAccountDelegatedStatus查询用户是否是WAF委派管理员多账号统一管理中,查询用户是否是WAF的委派管理员。
DescribeMemberAccounts查询所有成员账号多账号统一管理中,查询WAF所有成员账号信息。

标签管理

API标题API概述
TagResources为指定的资源创建并绑定标签指定一个或多个资源创建并绑定标签。
ListTagKeys查询标签键查询标签键。
UntagResources 解绑并删除标签为指定的一个或多个资源统一解绑并删除标签。
ListTagResources查询资源已经绑定的标签查询资源已经绑定的标签。
ListTagValues查询指定标签键对应的标签值查询指定标签键对应的标签值。

其他

API标题API概述
DescribeApisecSensitiveDomainStatistic查询API安全敏感数据域名统计查询API安全敏感数据域名统计
DeleteApisecEvent删除API安全事件删除API安全事件
DescribeApisecEventDomainStatistic查询API安全事件域名统计查询API安全事件域名统计。
DeleteApisecAbnormal删除API安全风险删除API安全风险
DescribeApisecAbnormalDomainStatistic查询API安全风险域名统计数据查询API安全风险域名统计数据。
DescribeApisecAssetTrend查询API资产趋势图查询API资产趋势图。