本文汇总了Web应用防火墙(WAF)服务所有可调用的API。

实例信息

API 描述
DescribeInstanceInfo 查询已购买的WAF实例的基本信息,例如实例ID、实例的类型和状态等。
DescribeInstanceSpecInfo 查询已购买的WAF实例的规格信息。
DeleteInstance 释放已开通的按量付费WAF实例或者已到期的包年包月WAF实例。

域名配置

API 描述
DescribeDomainNames 查询所有已添加到WAF防护的域名名称列表。
说明 该接口只能一次性返回所有域名。推荐您调用 DescribeDomainList接口进行分页查询。
DescribeDomainList 分页查询已添加到WAF防护的域名名称列表。
说明 该接口支持按条件查询及分页返回结果。对于域名数量较多的场景,推荐您调用该接口。
DescribeDomain 查询WAF实例中已添加的域名配置信息。
CreateDomain 添加域名配置信息,将您的域名接入WAF实例进行防护。
ModifyDomain 修改指定的域名配置信息。
DeleteDomain 删除指定的域名配置信息。
DescribeCertificates 查询指定域名关联的已有证书,即已在SSL证书服务中进行管理的证书。
DescribeCertMatchStatus 查询域名配置中上传的证书和私钥信息是否匹配。
CreateCertificate 为已添加的域名配置上传证书及私钥信息。
CreateCertificateByCertificateId 根据证书ID为指定的域名配置上传证书。
DescribeDomainBasicConfigs 查询已添加的域名配置的防护设置状态。
DescribeDomainAdvanceConfigs 查询已添加的域名配置的详细信息。

防护配置

API 描述
ModifyDomainIpv6Status 为域名配置开启或关闭IPv6安全防护功能。
DescribeProtectionModuleStatus 查询指定的WAF防护功能模块(包括Web入侵防护、数据安全、高级防护、Bot管理、访问控制或限流等模块)的开关状态。
ModifyProtectionModuleStatus 为域名配置开启或关闭WAF防护功能模块(包括Web入侵防护、数据安全、高级防护、Bot管理、访问控制或限流等模块)。
DescribeProtectionModuleMode 查询域名配置中各WAF防护功能模块(包括规则防护引擎、深度学习引擎、CC安全防护、数据风控、主动防御等模块)当前采用的防护模式。
ModifyProtectionModuleMode 修改指定的WAF防护功能模块(包括规则防护引擎、深度学习引擎、CC安全防护、数据风控、主动防御等模块)的防护模式。
DescribeProtectionModuleRules 查询指定的WAF防护功能模块(包括Web入侵防护、数据安全、Bot管理、访问控制或限流、网站白名单等模块)的规则配置记录。
CreateProtectionModuleRule 在指定的WAF防护功能模块(包括Web入侵防护、数据安全、Bot管理、访问控制或限流、网站白名单等模块)中创建规则配置。
ModifyProtectionModuleRule 修改指定的WAF防护功能模块(包括Web入侵防护、数据安全、高级防护、Bot管理、访问控制或限流、白名单等模块)的配置规则。
ModifyProtectionRuleStatus 为域名配置开启或关闭WAF防护功能模块(包括网站防篡改、合法爬虫、爬虫威胁情报、自定义防护策略、网站白名单等模块)中已创建的规则。
DescribeDomainRuleGroup 查询域名配置当前使用的规则防护引擎的防护规则组ID。
SetDomainRuleGroup 为域名配置选择规则防护引擎使用的防护规则组(除系统默认的三种防护规则组外,也可以选择自定义规则组)。
ModifyProtectionRuleCacheStatus 更新指定的网站防篡改规则所防护页面的缓存。
DeleteProtectionModuleRule 删除指定的防护模块下已创建的规则配置。
DescribeProtectionModuleCodeConfig 查询WAF地域级IP黑名单中支持配置的地域代码。

日志管理

API 描述
ModifyLogServiceStatus 为域名配置开启或关闭日志采集功能。
ModifyLogRetrievalStatus 为域名配置开启或关闭日志检索功能。
DescribeLogServiceStatus 查询已接入WAF进行防护的域名的日志采集状态(是否开启了日志采集)。

系统管理

API 描述
DescribeWafSourceIpSegment 查询WAF防护集群使用的回源IP网段。