Web应用防火墙随着防护引擎的升级,全面更新API接口,版本升级至2019-09-10,开放的接口和参数都有所调整。

  • 如果您的Web应用防火墙实例已升级至新版防护引擎,请参见新版防护引擎API接口相关文档进行调用。

    关于新版防护引擎的更多信息,请参见防护引擎全面升级

  • 如果您尚未升级至新版防护引擎,且仍在使用旧版API接口,请参见旧版防护引擎API接口相关文档进行调用。
    说明 您可以登录Web应用防火墙管理控制台,在系统管理 > 产品信息页面查看您的实例的防护引擎版本。
    • 如果软件版本号低于5.0.0.0(例如,4.5.1.1),表示当前实例为旧版引擎。
    • 如果在产品信息页面不显示软件版本号,表示当前实例为新版引擎。
    软件版本号

本次更新后,开放的API接口与上一版本(2018-01-17)相比,有以下调整。

说明 API接口的具体请求参数与返回参数均有所调整,详情请参见各API接口文档。
API(2019-09-10版本) API(2018-01-17版本) 说明
实例信息
DescribeInstanceInfo DescribePayInfo 用于获取当前WAF实例信息。
DescribeInstanceSpecInfo 新增接口。用于获取当前WAF实例详细规格信息。
DescribeRegions 取消该接口。新版API通过服务请求地址(Endpoint)自动识别WAF实例地域信息。
DescribeWafSourceIpSegment 取消该接口。建议您通过控制台获取WAF实例的回源IP网段信息。
域名配置
CreateDomain CreateDomainConfig 用于添加域名配置信息,将域名接入WAF实例进行防护。
DescribeDomain DescribeDomainConfig 更新接口。新版接口可获取更完整的WAF实例中已添加的域名配置信息。
ModifyDomain ModifyDomainConfig 用于修改指定域名配置信息。
DeleteDomain DeleteDomainConfig 用于删除指定域名配置信息。
DescribeDomainNames DescribeDomainNames 用于获取WAF实例中已添加的域名名称列表。
ModifyLogServiceStatus 新增接口。用于开启或关闭指定域名配置的日志实时查询分析的日志采集功能。
ModifyLogRetrievalStatus 新增接口。用于开启或关闭指定域名配置的日志检索功能。
DescribeDomainBasicConfigs 新增接口。用于获取域名配置记录的防护设置状态。
DescribeDomainAdvanceConfigs 用于获取已添加的域名配置记录详细信息。
CreateCertificate CreateCertAndKey 用于为已添加的域名配置记录上传证书及私钥信息。
CreateCertificateByCertificateId 新增接口。用于根据证书ID为指定域名上传证书。
DescribeCertMatchStatus 新增接口。用于检查为指定域名配置上传的证书和私钥信息是否匹配。
DescribeCertificates 新增接口。用于获取指定域名可选的已有证书。
防护配置
说明 防护配置相关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 ModifyProtectionRuleStatus 更新接口。用于启用或禁用指定域名配置的WAF防护功能模块(包括网站防篡改、合法爬虫、爬虫威胁情报、自定义防护策略、网站白名单等模块)中的指定规则。
DescribeDomainRuleGroup 新增接口。用于获取指定域名配置当前使用的正则防护引擎的防护规则组ID。
SetDomainRuleGroup 新增接口。用于为指定域名配置选择正则防护引擎使用的防护规则组,除系统默认的三种防护规则组外,也可以选择自定义规则组。
ModifyProtectionRuleCacheStatus ModifyProtectionRuleCacheStatus 用于更新指定网站防篡改规则所防护的页面的缓存。