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

本产品（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防护功能模块，如网站防篡改、合法爬虫、爬虫威胁情报、自定义防护策略、网站白名单。
DescribeDomainRuleGroup	DescribeDomainRuleGroup	调用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	将资源移动到新的资源组	将一个WAF资源转移到其他资源组。