文档

API概览

更新时间:
本产品(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防护功能模块,如网站防篡改、合法爬虫、爬虫威胁情报、自定义防护策略、网站白名单。
DescribeDomainRuleGroupDescribeDomainRuleGroup调用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将资源移动到新的资源组调用MoveResourceGroup,将一个WAF资源转移到其他资源组。
  • 本页导读 (1)