API概览 - Web 应用防火墙

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

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

实例信息

API	标题	API概述
CreatePostpaidInstance	创建Web应用防火墙3.0（按量付费）实例	创建Web应用防火墙3.0（按量付费）实例。
DescribeInstance	获取WAF实例详情	获取当前阿里云账号下WAF实例的详情。
ReleaseInstance	释放实例	释放WAF3.0的实例。

接入配置

API	标题	API概述
云产品接入	云产品接入
DescribeAbnormalCloudResources	查询防护异常状态的云产品接入	查询异常的云产品接入资源。
ReCreateCloudResource	云产品重新接入WAF	云产品重新接入WAF，仅在云产品接入的状态为防护异常时使用。
SyncProductInstance	透明接入同步用户的ECS、CLB和NLB资产	同步用户的ECS、CLB和NLB资产。
DescribeCloudResources	查询云产品接入WAF的实例列表	查询接入到WAF的云产品列表情况。
DescribeProductInstances	查询已同步的云产品资产列表	查询已同步的云产品资产列表。
DescribeResourceSupportRegions	查询云产品接入的支持区域列表	查询云产品接入的支持区域列表，主要指CLB和ECS产品。
DescribeResourceRegionId	查询SDK集成的资源的地域ID	查询SDK集成的资源的地域ID，主要指ALB和MSE产品。
DescribeResourceInstanceCerts	查询云产品实例的证书列表	查询云产品实例的证书列表，该接口返回当前委派管理员和实例所属用户的证书列表，该接口仅在多账号场景下使用。如：用户A是委派管控员，有证书cert1，云产品实例lb-xx-1是成员用户B，有证书cert2，查询实例lb-xx-1时，接口返回cert1和cert2。
CreateCloudResource	云产品接入WAF	云产品接入WAF，当前只支持ECS和CLB。
ModifyCloudResource	修改云产品接入的配置	修改已接入WAF的产品配置。
DeleteCloudResource	取消云产品接入	取消云产品接入，当前仅支持ECS和CLB。
DescribeCloudResourceAccessedPorts	查询已接入WAF的云产品实例端口列表	查询已接入WAF的云产品实例的端口列表，只支持ECS和CLB。
DescribeCloudResourceAccessPortDetails	查询已接入WAF的云产品实例端口详情	查询已接入WAF的云产品实例端口详情。
CNAME 接入	CNAME 接入
DescribeDomainUsedPorts	查询用户域名所有使用的端口	查用户所有域名使用的端口，只包含CNAME接入的域名和混合云CNAME域名开启公网容灾的域名。
CreateDomain	添加CNAME接入资源	将域名接入WAF实例进行防护。
ModifyDomain	修改CNAME接入资源	修改CNAME接入域名。
DeleteDomain	删除CNAME接入资源	删除CNAME接入域名。
DescribeDomains	查询CNAME接入列表	查询添加到 Web 应用防火墙的域名列表。
DescribeDomainDetail	查询CNAME接入详情	查询域名接入详情。
DescribePunishedDomains	查询已接入WAF域名的未备案处罚信息	查询已接入WAF域名的未备案处罚信息。
ModifyDomainPunishStatus	重新接入未备案处罚状态的域名	重新接入未备案处罚状态的域名。
DescribeCertDetail	查询证书详细信息	查询证书详细信息，如证书名称、到期时间、签发时间，绑定域名等。
DescribeCerts	查询用户的可选证书列表	查询用户的证书列表。
DescribeDomainDNSRecord	查询CNAME域名DNS解析状态	查询域名DNS是否正确。
DescribeWafSourceIpSegment	获取waf实例的回源IP网段列表	查询WAF回源网段。
DescribeResourcePort	查询实例下的所有已接入WAF端口	查询实例下的所有已接入WAF端口。
DescribeDDoSStatus	查询当前DDoS攻击状态	当前WAF实例是否被DDoS攻击。
CreateSM2Cert	CNAME接入WAF上传国密证书	CNAME接入WAF上传国密证书。
DescribeCnameCount	查询已接入的域名总数	查询已接入WAF的域名总数，包含CNAME接入和混合云接入的域名。
DescribeDefaultHttps	查询默认SSL/TLS设置	查询默认SSL/TLS设置。
ModifyDefaultHttps	修改默认SSL/TLS设置	修改默认SSL/TLS设置。
CreateCerts	CNAME接入WAF上传证书（国际证书）	CNAME接入WAF上传证书（国际证书）。
混合云接入	混合云接入
DescribeHybridCloudResources	查询混合云CNAME接入列表	查询混合云域名列表。

防护配置

API	标题	API概述
防护对象	防护对象
CreateDefenseResource	创建防护对象	创建防护对象。
DeleteDefenseResource	删除防护对象	删除防护对象。
CreateDefenseResourceGroup	创建防护对象组	创建防护对象组。
ModifyDefenseResourceGroup	修改防护对象组	修改防护对象组配置信息。
DeleteDefenseResourceGroup	删除防护对象组	删除防护对象组。
DescribeDefenseResourceGroup	查询单个防护对象组	查询单个防护对象组信息。
DescribeDefenseResourceGroups	分页查询防护对象组	分页查询防护对象组。
DescribeDefenseResourceGroupNames	查询防护对象组名称列表	查询防护对象组名称列表。
DescribeDefenseResource	查询单个防护对象	查询单个防护对象。
DescribeDefenseResources	分页查询防护对象	分页查询防护对象。
DescribeDefenseResourceNames	查询防护对象名称列表	分页查询防护对象名称列表。
DescribeDefenseResourceOwnerUid	查询防护对象资产归属账号	多账号统一管理场景中，用于查询防护对象的资产归属账号。
ModifyDefenseResourceXff	修改防护对象的客户端IP和cookie设置	修改防护对象的客户端IP和cookie设置。
DescribePauseProtectionStatus	获取WAF防护状态	获取WAF防护状态。
防护规则	防护规则
DeleteDefenseRuleBlockIp	解封扫描防护封禁IP	解封扫描防护封禁IP。
DescribeIpAbroadCountryInfos	获取IP区域封禁支持的海外国家及区域	获取IP区域封禁支持的海外国家及区域。
ModifyDefenseRuleCache	更新网页防篡改防护规则缓存	更新网页防篡改防护规则缓存。
DescribeDefenseResourceTemplates	查询防护对象或防护组的防护模板	查询防护对象或防护组的防护模板。
DescribeDefenseTemplateValidGroups	查询防护模板待生效的防护对象组名称列表	查询防护模板待生效的防护对象组名称列表。
DescribeDefenseTemplates	分页查询防护模板列表	分页查询防护模板列表。
CreateDefenseTemplate	创建防护模板	创建防护模板。
CopyDefenseTemplate	复制防护模板	复制当前防护模板，并生成一个新的防护模板。
ModifyDefenseTemplate	修改防护模板	修改防护模板。
DescribeDefenseTemplate	查询单个防护模板	查询单个防护模板。
ModifyDefenseTemplateStatus	修改防护模板状态	修改防护模板状态。
DeleteDefenseTemplate	删除防护模板	删除防护模板。
CreateDefenseRule	创建Web核心防护规则	创建防护规则。
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	标题	API概述
DeleteApisecAbnormals	批量删除API安全风险	批量删除API安全风险。
ModifyApisecAbnormals	批量修改API安全风险状态	批量修改API安全风险状态。
DescribeApisecAssetTrend	查询API安全API资产趋势	查询API安全API资产趋势。
DescribeApisecAbnormalDomainStatistic	查询API安全风险域名统计数据	查询API安全风险域名统计数据。
DescribeApisecEventDomainStatistic	查询API安全事件域名统计	查询API安全事件域名统计。
DescribeApisecSensitiveDomainStatistic	查询API安全敏感数据域名统计	查询API安全敏感数据域名统计。
ModifyApisecEvents	批量修改API安全事件状态	批量修改API安全事件状态。
DeleteApisecEvents	批量删除API安全事件	批量删除API安全事件。
ModifyApisecLogDeliveryStatus	修改API安全日志订阅状态	修改API安全日志订阅状态。
CreateApiExport	创建API安全数据导出任务	创建API安全数据导出任务。
DescribeApiExports	查询API安全导出任务列表	查询API安全导出任务列表。
DescribeApisecAbnormals	查询API安全风险列表	查询API安全风险列表。
DescribeApisecApiResources	查询API安全资产列表	查询API安全资产列表。
ModifyApisecStatus	修改API安全生效状态	修改API安全生效防护对象或防护对象组状态。
ModifyApisecModuleStatus	修改API安全防护模块生效状态	修改API安全防护模块生效防护对象或防护对象组状态。
ModifyApisecApiResource	修改API安全API资产的标注	修改API安全API资产的标注。
DescribeUserEventType	查询API安全用户安全事件类型和统计	查询API安全用户安全事件类型和统计。
DescribeUserEventTrend	查询API安全攻击走势	查询API安全攻击走势。
DescribeUserAsset	查询API安全用户资产统计	查询API安全用户资产统计。
DescribeUserApiRequest	查询API接口的流量统计	查询API接口的流量统计。
DescribeUserAbnormalType	查询API安全用户风险类型和统计	查询API安全用户风险类型和统计。
DescribeUserAbnormalTrend	查询API安全风险走势	查询API安全风险走势。
DescribeSensitiveStatistic	查询溯源审计的敏感数据统计	查询溯源审计的敏感数据统计。
DescribeSensitiveRequests	查询敏感数据溯源结果	查询敏感数据溯源结果。
DescribeSensitiveRequestLog	查询敏感数据的访问日志信息	查询敏感数据的访问日志信息。
DescribeSensitiveOutboundTrend	查询个人信息数据出境走势	查询个人信息数据出境走势。
DescribeSensitiveOutboundStatistic	查询个人信息出境类型统计	查询个人信息出境类型统计。
DescribeSensitiveOutboundDistribution	查询个人信息出境流量分布	查询个人信息出境流量分布。
DescribeSensitiveDetectionResult	查询API安全合规要求检测结果	查询API安全合规要求检测结果。
DescribeSensitiveApiStatistic	查询个人信息涉及站点及接口统计	查询个人信息涉及站点及接口统计。
DescribeFreeUserEvents	查询API安全基础检测的安全事件列表	查询API安全基础检测的安全事件列表。
DescribeFreeUserEventTypes	查询API安全基础检测的安全事件类型	查询API安全基础检测的安全事件类型。
DescribeFreeUserEventCount	查询API安全基础检测的安全事件统计	查询API安全基础检测的安全事件统计。
DescribeFreeUserAssetCount	查询API安全基础检测的资产统计信息	查询API安全基础检测的资产统计信息。
DescribeApisecUserOperations	查询API安全用户操作记录	查询API安全用户操作记录。
DescribeApisecSuggestions	查询API资产的防护建议	查询API资产的防护建议。
DescribeApisecStatistics	查询API安全检测统计信息	查询API安全风险或安全事件的检测统计信息。
DescribeApisecRules	查询API安全策略配置规则	查询API安全策略配置规则。
DescribeApisecProtectionResources	查询API安全防护对象生效列表	查询API安全防护对象生效列表。
DescribeApisecProtectionGroups	查询API安全防护对象组的生效列表	查询API安全防护对象组的生效列表。
DescribeApisecMatchedHosts	查询API安全检测的域名列表	查询API安全检测的域名列表。
DescribeApisecEvents	查询API安全事件列表	查询API安全事件列表。

报表信息

API	标题	API概述
DescribeNetworkFlowTimeSeriesMetric	查询网络流量时序数据	查询所有流量的时序统计数据，包含恶意请求和正常的业务请求。
DescribeSecurityEventTopNMetric	查询攻击流量top统计数据	查询攻击流量top统计数据，攻击流量按照一定维度聚合统计并排序后返回topN数据。
DescribeSecurityEventTimeSeriesMetric	查询攻击流量时序数据	查询攻击流量时序数据，攻击请求指的是命中规则并且被判定为有风险的请求。
DescribeSecurityEventLogs	查询攻击流量详情日志列表	查询攻击流量的详情日志列表，每条日志中包含了一条请求命中的详细信息。
DescribeNetworkFlowTopNMetric	查询网络流量top统计数据	查询所有流量按照不同维度聚合统计并进行排序后的top统计数据，包含恶意请求和正常的业务请求。
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概述
DescribeHybridCloudServerRegions	查询混合云支持的区域列表	查询混合云支持的运营商、大州、城市等区域信息字典表。
DescribeHybridCloudUnassignedMachines	查询混合云集群未分配服务器列表	查询混合云集群未分配服务器列表。
ModifyHybridCloudClusterBypassStatus	修改混合云SDK集成集群手动Bypass开关	修改混合云SDK集成集群手动Bypass开关。
DescribeHybridCloudUser	查询混合云客户端口	查询混合云接入，客户允许使用的端口范围，内容返回包括HTTP和HTTPS两类端口。
DescribeHybridCloudGroups	查询混合云集群下节点组列表	查询添加到Web应用防火墙的混合云节点组列表。
CreateHybridCloudGroup	创建混合云集群节点组信息	创建混合云集群节点组信息。
DescribeHybridCloudClusterRule	获取混合云集群规则信息	获取混合云集群规则信息。
DescribeHybridCloudClusters	查询混合云集群列表	查询混合云集群列表。
ModifyHybridCloudClusterRule	修改混合云集群规则信息	修改混合云集群规则信息。
ModifyHybridCloudGroup	修改集群组信息	修改集群组信息。
ModifyHybridCloudGroupExpansionServer	集群分组中添加节点	集群分组中添加节点。
ModifyHybridCloudGroupShrinkServer	集群分组删除节点	集群分组删除节点。
ModifyHybridCloudSdkPullinStatus	修改混合云SDK引流状态	修改混合云SDK引流状态。
ModifyHybridCloudServer	修改混合云节点信息	修改混合云节点信息。
DeleteHybridCloudClusterRule	删除混合云集群规则	删除集群规则信息
CreateHybridCloudClusterRule	创建集群规则信息	新增集群规则信息
DescribeHybridCloudClusterRules	查询混合云集群规则列表	集群规则列表

多账号统一管理

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

资源组管理

API	标题	API概述
ChangeResourceGroup	更换资源组	修改防护对象所属的资源组。

标签管理

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

其他

API	标题	API概述
DescribeApisecLogDeliveries	查询API安全日志订阅列表	查询API安全日志订阅列表。
DescribeApisecSlsLogStores	查询日志服务SLS的LogStore列表	查询日志服务SLS中以apisec-开头的LogStore列表。
DescribeApisecSlsProjects	查询日志服务SLS的Project列表	查询日志服务SLS中以apisec-开头的Project列表。
ModifyApisecLogDelivery	修改API安全日志订阅	修改API安全日志订阅。
ModifyPauseProtectionStatus	修改WAF防护状态	修改WAF防护状态。