文档中心

Web应用防火墙

API 参考

API 列表

API 列表

本文为您列出当前支持的 API 功能及对应调用文档。

网站设置

API	说明
CreateDomain-通过 CNAME 方式接入	未配置负载均衡时，可通过 CNAME 方式接入云 WAF 实例。配置防护域名参数和 WAF 回源参数后，您只需要修改防护域名的 DNS 解析记录并放行火山引擎 Web 应用防火墙的回源 IP 地址，即可完成域名接入。
CreateDomain-通过应用型负载均衡（ALB）实例方式接入	如果您的防护域名已经接入到 ALB 实例，则防护规则按照域名生效；如果您的防护域名暂未接入到 ALB 实例，则 WAF 会统一创建默认防护站点，并以 ALB 的 ID 命名。
CreateDomain-通过负载均衡（CLB）7 层方式接入	如果您的业务接入了火山引擎负载均衡实例，且已为端口添加 HTTP 或 HTTPS 监听，则可以通过负载均衡（CLB） 7 层方式接入云 WAF 防护。
CreateDomain-通过负载均衡（CLB）4 层方式接入	如果您的业务接入了火山引擎负载均衡实例，且已为端口添加 TCP 监听，则可以通过负载均衡（CLB 4 层）方式接入云 WAF 防护。
UpdateDomain-更新云 WAF 实例的防护网站信息	更新已添加的域名防护信息，包括接入能力、回源配置等参数。
ListDomain-查询云 WAF 实例防护网站信息	查询指定防护网站的详细信息，支持模糊匹配和精确匹配两种查询模式。
DeleteDomain-删除云 WAF 实例防护网站	根据域名信息，删除指定的防护网站。
UpdateWafServiceControl-更新防护网站开关	修改指定防护网站的防护策略和日志服务的开启状态。
ListLoadBalancer-查询防护网站关联的负载均衡实例	查询防护网站关联的负载均衡或应用型负载均衡实例信息。

安全概览

API	说明
QueryAttackSecurityEvent-查询攻击事件列表	根据攻击类型、user-agent、被攻击域名或攻击源地理位置查询对应的攻击次数。
QueryFlowOverviewLb-查询流量概览数据	查询不同防护策略下的攻击源 IP 信息、命中规则和攻击次数。
QueryProtectionOverviewLb-查询防护概览数据	支持根据事件名称、域名或 IP 信息查询攻击事件列表。
QueryAttackAnalysisTermsAggLb-按不同分类查询攻击次数	查询流量概览信息，包括请求速率峰值、请求次数峰值、回源速率峰值和回源次数峰值。
QueryAttackAnalysisWithRuleAggLb-查询攻击源 IP	查询防护概览信息，包括防护网站数、防护攻击次数和拦截 IP 数。

访问管控

API	说明
CreateAclRule - 创建访问管控规则	创建访问管控规则，管控指定 IP 地址的访问。
UpdateAclRule - 更新访问管控规则	修改访问管控规则。
ListAclRule - 查询访问管控规则	查询访问管控规则信息详情。
DeleteAclRule - 删除访问管控规则	根据规则 ID 和访问管控类型，删除对应的访问管控规则。
CreateCustomPage-创建自定义响应拦截规则	创建自定义响应拦截规则，当满足条件的请求被 WAF 拦截时返回特定信息（CC 拦截除外），如自定义的响应码和响应页面。
UpdateCustomPage-更新自定义响应拦截规则	更新自定义响应拦截规则。
ListCustomPage-查询自定义响应拦截规则详情	查询指定域名下自定义响应拦截规则详情。
DeleteCustomPage-删除自定义响应拦截规则	根据域名和规则 ID，删除对应的自定义响应拦截规则。

CC 防护

API	说明
CreateCCRule-创建 CC 防护规则	创建 CC 防护规则，可根据网络访问 IP、Session 等各种 HTTP 请求对象进行请求限制，当满足设定的统计条件后，对其访问执行防护动作，以防止服务器资源被过度占用，确保正常访问业务不受影响。
UpdateCCRule-更新 CC 防护规则	编辑 CC 防护规则，包括规则名称、请求特征和统计条件等信息。
ListCCRule-查询 CC 防护规则详情	查询指定域名下的 CC 防护规则列表，展示规则组和规则信息。
DeleteCCRule-删除 CC 规则	根据域名和规则 ID，删除对应的 CC 规则。

漏洞防护

API	说明
ListVulnerabilityRule-查询漏洞规则详情	查询指定域名下的漏洞防护规则详情，包括规则类型、名称、ID、风险等级等信息。
GetVulnerabilityConfig-查看漏洞防护配置	查询指定域名的漏洞防护配置及对应的规则信息。
UpdateVulnerabilityConfig-更新托管漏洞规则	更新指定域名的托管漏洞规则配置，支持更新防护模式、防护动作和高级设置。
UpdateCustomSystemVulRule-更新自定义漏洞规则	更新自定义模式下各个规则的开启状态。

Bot 管理

API	说明
CreateCustomBotConfig-创建自定义 Bot 规则	创建防护域名的自定义 Bot 规则。
ListCustomBotConfig-查询自定义规则详情	查询自定义 bot 规则。

封禁管理

API	说明
AddProhibitionWhite-永久加白封禁列表 IP	将封禁列表中的 IP 永久加白。加白成功后，IP 的状态会变为“已永久加白”，且被添加至访问白名单。
DeleteProhibitionWhite-取消永久加白 IP	取消已经永久加白的攻击源 IP。取消永久加白后，IP 的状态会变为“已取消加白”。
AddProhibitionBlack-永久封禁 IP	将封禁列表中的 IP 永久封禁。封禁成功后，该 IP 状态将变成“已永久封禁”，且被添加至访问黑名单。
DeleteProhibitionBlack-取消永久封禁 IP	取消已经永久封禁的攻击源 IP。取消永久封禁后，IP 的状态会变为“已取消封禁”。
ListProhibition-查询封禁 IP 信息	查询符合条件的封禁 IP 列表信息，包括攻击源 IP、攻击次数和 IP 状态等信息。

日志管理

API	说明
GetTLSConfig-查询日志配置	获取日志配置信息，包括日志存储容量、告警阈值、存储时长以及采集域名范围等信息。
ModifyTLSConfig-修改日志配置	修改日志参数配置，例如是否开启容量告警、告警阈值大小，告警时间间隔、日志存储时长以及采集域名和字段范围等。
SearchLogs-查询日志详情	查询日志详情，需要调用日志服务对应接口。调用方法，请参考SearchLogs。

证书管理

API	说明
UploadWafServiceCertificate-上传证书	上传证书。
ListWafServiceCertificate-查看证书详情	查看证书详情，包括证书 ID、关联域名、证书名称等信息。
ListCertificateServices-查询证书关联域名	根据证书 ID 查询证书关联的域名。
DeleteWafServiceCertificate-删除证书	根据证书 ID 删除指定证书。

地址组管理

API	说明
AddIpGroup-创建地址组	通过手动添加的方式创建地址组。
UpdateIpGroup-更新地址组	更新指定地址组的 IP 信息。
ListAllIpGroups-查询所有地址组	查询当前账号下的地址组列表信息。
ListAllIpGroup-查询地址组详情	查询某个指定地址组下的 IP 详情。
DeleteIpGroup-删除地址组	确认对应规则不需要关联地址组后，可以删除相关地址组。

域名组管理

API	说明
AddHostGroup - 创建域名组	新将已经接入到 WAF 的域名加入到创建的域名组中，集中创建访问管控策略。
ListHostGroup - 查询域名组	查询域名组信息，包括域名组内的域名详情、关联的规则 ID 等信息
UpdateHostGroup - 更新域名组	更新指定域名组信息，包括域名组名称、域名组列表等
DeleteHostGroup - 删除域名组	删除指定 ID 对应的域名组，支持同时删除多个域名组。

最近更新时间：2026.05.21 12:03:05

这个页面对您有帮助吗？

有用

有用

无用

无用