API概览

最近更新时间: 2024-10-18 10:38:29

API版本

V3

Bot 行为管理相关接口

接口名称 接口功能
DescribeFlowTrend 获取waf流量访问趋势
ModifyApiAnalyzeStatus api分析页面开关

IP 管理相关接口

接口名称 接口功能
AddDomainWhiteRule 增加域名规则白名单
DeleteDomainWhiteRules 删除域名规则白名单
DeleteIpAccessControl Waf IP黑白名单Delete接口
DescribeAutoDenyIP 描述WAF自动封禁IP详情
DescribeBatchIpAccessControl Waf 多域名ip黑白名单查询
DescribeDomainWhiteRules 获取域名的规则白名单
DescribeIpAccessControl Waf ip黑白名单查询
DescribeIpHitItems Waf IP封堵状态查询
DescribeWafAutoDenyRules 查询ip惩罚规则
DescribeWafAutoDenyStatus 描述WAF自动封禁模块详情
DescribeWafThreatenIntelligence 描述WAF威胁情报封禁模块配置详情
ModifyDomainWhiteRule 更改某一条规则
ModifyWafAutoDenyRules 修改ip惩罚规则
ModifyWafThreatenIntelligence 配置WAF威胁情报封禁模块详情
UpsertIpAccessControl Waf IP黑白名单Upsert接口

其他接口

接口名称 接口功能
AddCustomRule 增加访问控制(自定义策略)
AddCustomWhiteRule 添加精准白名单规则
DeleteAntiInfoLeakRule 信息防泄漏删除规则
DeleteCCRule Waf CC V2 Delete接口
DeleteCustomRule 删除自定义规则
DeleteCustomWhiteRule 删除精准白名单规则
DeleteHost 删除CLB-WAF防护域名
DescribeDomainCountInfo 获取域名概况
DescribeFindDomainList 获取发现域名列表接口
DescribeHost 获取防护域名详情
DescribeHostLimit 验证添加的域名是否已经存在
DescribeHosts 获取防护域名列表
DescribeInstances 查询用户所有实例的详细信息
DescribeTlsVersion 查询用户TLS版本
DescribeUserDomainInfo 查询saas和clb的域名信息
DescribeWafInfo 获取负载均衡绑定的WAF信息
DescribeWebshellStatus 获取域名webshell状态
FreshAntiFakeUrl 刷新防篡改url
GetInstanceQpsLimit 获取套餐实例的弹性qps上限
ModifyAntiFakeUrlStatus 切换防篡改开关
ModifyAreaBanStatus 修改地域封禁状态
ModifyBotStatus Bot_V2 bot总开关更新
ModifyDomainsCLSStatus 修改域名列表的访问日志开关
ModifyHost 编辑防护域名
ModifyHostFlowMode 设置防护域名的流量模式
ModifyHostMode 设置防护域名防护状态
ModifyHostStatus 设置防护域名WAF开关
ModifyInstanceElasticMode 修改实例的QPS弹性计费开关
ModifyInstanceName 修改实例名称
ModifyInstanceQpsLimit 设置套餐实例的弹性qps上限
ModifyInstanceRenewFlag 修改实例的自动续费开关
ModifySpartaProtection 修改域名配置
ModifyWebshellStatus 设置webshell状态
UpsertCCRule Waf CC V2 Upsert接口
UpsertSession Waf 会话定义 Upsert接口
WafCreateResourceAfterPay 购买WAF

安全概览相关接口

接口名称 接口功能
DescribeAttackOverview 攻击总览
DescribeAttackType 查询TOP N攻击类型
DescribeHistogram 查询多种聚类分析
DescribePeakPoints 查询业务和攻击概要趋势
DescribePeakValue 获取业务和攻击概览峰值
DescribePolicyStatus 获取防护状态以及生效的实例id
DescribeTopAttackDomain 查询Top5的攻击域名

接入相关接口

接口名称 接口功能
AddSpartaProtection 添加SaaS型WAF防护域名
CreateHost 添加负载均衡型WAF防护域名
DeleteSpartaProtection 删除Saas型WAF防护域名
DescribeCiphersDetail 查询加密套件信息
DescribeDomainDetailsClb 获取负载均衡型WAF域名详情
DescribeDomainDetailsSaas 查询单个Saas型WAF域名详情
DescribePorts 获取Saas型WAF防护端口列表
DescribeUserCdcClbWafRegions 获取CDC场景下对客户已经开放的负载均衡型WAF(cdc-clb-waf)的地域
DescribeUserClbWafRegions 获取对客户已经开放的负载均衡型WAF(clb-waf)的地域
DescribeVipInfo 查询VIP信息
ModifyDomainIpv6Status 切换ipv6开关
RefreshAccessCheckResult 刷新接入检查的结果
SwitchDomainRules 切换域名的规则开关

日志服务相关接口

接口名称 接口功能
CreateAccessExport 创建访问日志导出
DeleteAccessExport 删除访问日志导出
DeleteAttackDownloadRecord 删除攻击日志下载任务记录
DeleteDownloadRecord 删除访问日志下载记录
DescribeAccessExports 获取访问日志导出列表
DescribeAccessFastAnalysis 访问日志快速分析统计
DescribeAccessHistogram 访问日志柱状趋势图
DescribeAccessIndex 获取访问日志索引配置信息
GetAttackDownloadRecords 查询下载攻击日志任务记录列表
GetAttackHistogram 攻击日志统计
GetAttackTotalCount 攻击总次数
ModifyAccessPeriod 修改访问日志保存期限等字段信息
PostAttackDownloadTask 创建搜索下载攻击日志任务
SearchAccessLog 搜索访问日志
SearchAttackLog 搜索CLS新版本攻击日志

计费相关接口

接口名称 接口功能
GenerateDealsAndPayNew 计费资源购买、续费下单接口
ModifyGenerateDeals 计费下单接口

资产中心相关接口

接口名称 接口功能
DescribeDomains 获取域名列表

防护设置相关接口

接口名称 接口功能
AddAntiFakeUrl 添加防篡改url
AddAntiInfoLeakRules 添加信息防泄漏规则
AddAttackWhiteRule 增加规则引擎白名单
DeleteAntiFakeUrl 删除防篡改url
DeleteAttackWhiteRule 删除规则引擎白名单
DeleteSession 删除CC攻击的session设置
DescribeAntiFakeRules 获取防篡改信息
DescribeAntiFakeUrl 获取防篡改url
DescribeAntiInfoLeakRules 获取信息防泄漏规则列表【老接口】
DescribeAntiInfoLeakageRules 获取信息防泄漏规则列表
DescribeAttackWhiteRule 获取用户规则白名单列表
DescribeCCAutoStatus Waf 斯巴达版本查询cc自动封堵状态
DescribeCCRule Waf CC V2 Query接口
DescribeCCRuleList 查询CC规则
DescribeCertificateVerifyResult 获取证书的检查结果
DescribeCustomRuleList 查询访问控制规则
DescribeCustomWhiteRule 查询精准白名单规则
DescribeDomainRules 拉取域名的防护规则列表
DescribeDomainVerifyResult 获取添加域名操作的结果
DescribeModuleStatus 查询waf各个模块接口的开关状态
DescribeObjects 查看防护对象列表
DescribeRuleLimit 获取规格限制
DescribeSession Waf 会话定义查询接口
DescribeSpartaProtectionInfo waf斯巴达-获取防护域名信息
DescribeUserLevel 获取用户防护规则等级
DescribeUserSignatureRule 获取用户特征规则列表
ModifyAntiFakeUrl 编辑防篡改url
ModifyAntiInfoLeakRuleStatus 信息防泄漏切换规则开关
ModifyAntiInfoLeakRules 编辑信息防泄漏规则
ModifyAttackWhiteRule 修改规则引擎白名单
ModifyCustomRule 编辑自定义规则
ModifyCustomRuleStatus 开启或禁用访问控制(自定义策略)
ModifyCustomWhiteRule 编辑精准白名单
ModifyCustomWhiteRuleStatus 开启或禁用精准白名单
ModifyModuleStatus 设置某个domain下基础安全模块的开关
ModifyObject 修改防护对象
ModifyProtectionStatus waf斯巴达-waf开关
ModifySpartaProtectionMode 设置waf防护状态
ModifyUserLevel 修改用户防护规则等级
ModifyUserSignatureRule 修改用户防护规则
SwitchElasticMode 切换弹性QPS的开关
UpsertCCAutoStatus Waf 斯巴达版本更新cc自动封堵状态