Web 应用防火墙_API文档

Web 应用防火墙 - OpenAPI 概览2021-10-01
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
实例信息
OpenAPI 名称描述操作
CreatePostpaidInstancehot创建Web应用防火墙3.0(按量付费)实例查看文档去调试
DescribeInstancehot获取当前阿里云账号下WAF实例的详情查看文档去调试
ReleaseInstance释放WAF3.0的实例查看文档去调试
接入配置
OpenAPI 名称描述操作
云产品接入
SyncProductInstance同步用户的ECS和CLB资产查看文档去调试
CreateCloudResource云产品接入WAF,当前只支持ECS和CLB查看文档去调试
DescribeCloudResources查询接入到WAF的云产品列表情况查看文档去调试
DescribeProductInstances查询已同步的云产品资产列表查看文档去调试
DescribeResourceSupportRegions查询云产品接入的支持区域列表,主要指CLB,ECS产品查看文档去调试
DescribeResourceRegionId查询SDK集成的资源的地域ID,主要指ALB和MSE产品查看文档去调试
DescribeResourceInstanceCerts查询云产品实例的证书列表,该接口返回当前委派管理员和实例所属用户的证书列表,该接口仅在多账号场景下使用。 如:用户A是委派管控员,有证书cert1,云产品实例lb-xx-1是成员用户B,有证书cert2,查询实例lb-xx-1时,接口返回cert1和cert2查看文档去调试
DescribeCloudResourceAccessedPorts查询已接入WAF的云产品实例的端口列表,只支持ECS和CLB查看文档去调试
DescribeCloudResourceAccessPortDetails当前已接入WAF的云产品端口信息,只支持ECS和CLB查看文档去调试
ModifyCloudResource修改已接入WAF的产品配置查看文档去调试
DeleteCloudResource取消云产品接入,当前仅支持ECS和CLB查看文档去调试
CNAME接入
CreateDomainhot将域名接入WAF实例进行防护查看文档去调试
CreateSM2CertCNAME接入WAF上传国密证书查看文档去调试
DescribeDomainshot查询添加到 Web 应用防火墙的域名列表查看文档去调试
DescribeDomainDetailhot查询域名接入详情查看文档去调试
DescribePunishedDomains查询已接入WAF域名的未备案处罚信息查看文档去调试
DescribeCertDetail查询证书详细信息,如证书名称、到期时间、签发时间,绑定域名等查看文档去调试
DescribeCerts查询用户的证书列表查看文档去调试
DescribeDomainDNSRecord查询域名DNS是否正确查看文档去调试
DescribeWafSourceIpSegment查询WAF回源网段查看文档去调试
DescribeResourcePort查询实例下的所有已接入WAF端口查看文档去调试
DescribeDDoSStatus当前WAF实例是否被DDoS攻击查看文档去调试
DescribeCnameCount查询已接入WAF的域名总数,包含CNAME接入和混合云接入的域名查看文档去调试
DescribeDefaultHttps查询默认SSL/TLS设置查看文档去调试
ModifyDomain修改CNAME接入域名查看文档去调试
ModifyDomainPunishStatus重新接入未备案处罚状态的域名查看文档去调试
ModifyDefaultHttps修改默认SSL/TLS设置查看文档去调试
DeleteDomain删除CNAME接入域名查看文档去调试
混合云接入
DescribeHybridCloudResources查询混合云域名列表查看文档去调试
防护配置
OpenAPI 名称描述操作
防护对象
CreateDefenseResourceGroup创建防护对象组查看文档去调试
DescribeDefenseResourceGroup查询单个防护对象组信息查看文档去调试
DescribeDefenseResourceGroups分页查询防护对象组查看文档去调试
DescribeDefenseResourceGroupNames查询防护对象组名称列表查看文档去调试
DescribeDefenseResource查询单个防护对象查看文档去调试
DescribeDefenseResources分页查询防护对象查看文档去调试
DescribeDefenseResourceNames分页查询防护对象名称列表查看文档去调试
DescribePauseProtectionStatus获取WAF防护状态查看文档去调试
ModifyDefenseResourceGroup修改防护对象组配置信息查看文档去调试
ModifyDefenseResourceXff修改防护对象的客户端IP和cookie设置查看文档去调试
ModifyPauseProtectionStatus修改WAF防护状态查看文档去调试
DeleteDefenseResourceGroup删除防护对象组查看文档去调试
防护规则
CreateDefenseTemplate创建防护模板查看文档去调试
CopyDefenseTemplate复制当前防护模板,并生成一个新的防护模板查看文档去调试
CreateDefenseRulehot创建防护规则查看文档去调试
DescribeDefenseResourceTemplates查询防护对象或防护组的防护模板查看文档去调试
DescribeDefenseTemplateValidGroups查询防护模板待生效的防护对象组名称列表查看文档去调试
DescribeDefenseTemplates分页查询防护模板列表查看文档去调试
DescribeDefenseTemplate查询单个防护模板查看文档去调试
DescribeDefenseRulehot查询单个防护规则查看文档去调试
DescribeDefenseRuleshot分页查询防护规则查看文档去调试
DescribeTemplateResources查询防护模板绑定的资源查看文档去调试
DescribeTemplateResourceCount查询防护模板生效的防护资源个数查看文档去调试
DescribeRuleGroups分页查询正则规则组查看文档去调试
ModifyDefenseRuleCache更新网页防篡改防护规则缓存查看文档去调试
ModifyDefenseTemplate修改防护模板查看文档去调试
ModifyDefenseTemplateStatus修改防护模板状态查看文档去调试
ModifyDefenseRulehot修改防护规则配置信息查看文档去调试
ModifyDefenseRuleStatus修改防护规则状态查看文档去调试
ModifyTemplateResources绑定或解绑防护资源与防护模板的关系查看文档去调试
DeleteDefenseTemplate删除防护模板查看文档去调试
DeleteDefenseRule删除防护规则查看文档去调试
重保场景
CreateMajorProtectionBlackIp添加WAF重保场景防护IP黑名单查看文档去调试
DescribeMajorProtectionBlackIps分页查询重保黑IP查看文档去调试
ModifyMajorProtectionBlackIp修改重保场景黑IP查看文档去调试
DeleteMajorProtectionBlackIp删除重保场景黑IP查看文档去调试
ClearMajorProtectionBlackIp清空重保场景黑IP查看文档去调试
API安全
OpenAPI 名称描述操作
CreateApiExport创建API安全数据导出任务查看文档去调试
DescribeApisecAssetTrend查询API安全API资产趋势查看文档去调试
DescribeApisecAbnormalDomainStatistic查询API安全风险域名统计数据查看文档去调试
DescribeApisecEventDomainStatistic查询API安全事件域名统计查看文档去调试
DescribeApisecSensitiveDomainStatistic查询API安全敏感数据域名统计查看文档去调试
DescribeApisecLogDeliveries查询API安全日志订阅列表查看文档去调试
DescribeApisecSlsLogStores查询日志服务SLS中以apisec-开头的LogStore列表查看文档去调试
DescribeApisecSlsProjects查询日志服务SLS中以apisec-开头的Project列表查看文档去调试
DescribeApiExports查询API安全导出任务列表查看文档去调试
DescribeApisecAbnormals查询API安全风险列表查看文档去调试
DescribeApisecApiResources查询API安全资产列表查看文档去调试
DescribeUserEventType查询API安全用户安全事件类型和统计查看文档去调试
DescribeUserEventTrend查询API安全攻击走势查看文档去调试
DescribeUserAsset查询API安全用户资产统计查看文档去调试
DescribeUserApiRequest查询API接口的流量统计查看文档去调试
DescribeUserAbnormalType查询API安全用户风险类型和统计查看文档去调试
DescribeUserAbnormalTrend查询API安全风险走势查看文档去调试
DescribeSensitiveStatistic查询溯源审计的敏感数据统计查看文档去调试
DescribeSensitiveRequests查询敏感数据溯源结果查看文档去调试
DescribeSensitiveRequestLog查询敏感数据的访问日志信息查看文档去调试
DescribeSensitiveOutboundTrend查询个人信息数据出境走势查看文档去调试
DescribeSensitiveOutboundStatistic查询个人信息出境类型统计查看文档去调试
DescribeSensitiveOutboundDistribution查询个人信息出境流量分布查看文档去调试
DescribeSensitiveDetectionResult查询API安全合规要求检测结果查看文档去调试
DescribeSensitiveApiStatistic查询个人信息涉及站点及接口统计查看文档去调试
DescribeFreeUserEvents查询API安全基础检测的安全事件列表查看文档去调试
DescribeFreeUserEventTypes查询API安全基础检测的安全事件类型查看文档去调试
DescribeFreeUserEventCount查询API安全基础检测的安全事件统计查看文档去调试
DescribeFreeUserAssetCount查询API安全基础检测的资产统计信息查看文档去调试
DescribeApisecUserOperations查询API安全用户操作记录查看文档去调试
DescribeApisecSuggestions查询API资产的防护建议查看文档去调试
DescribeApisecStatistics查询API安全风险或安全事件的检测统计信息查看文档去调试
DescribeApisecRules查询API安全策略配置规则查看文档去调试
DescribeApisecProtectionResources查询API安全防护对象生效列表查看文档去调试
DescribeApisecProtectionGroups查询API安全防护对象组的生效列表查看文档去调试
DescribeApisecMatchedHosts查询API安全检测的域名列表查看文档去调试
DescribeApisecEvents查询API安全事件列表查看文档去调试
ModifyApisecAbnormals批量修改API安全风险状态查看文档去调试
ModifyApisecEvents批量修改API安全事件状态查看文档去调试
ModifyApisecLogDeliveryStatus修改API安全日志订阅状态查看文档去调试
ModifyApisecLogDelivery修改API安全日志订阅查看文档去调试
ModifyApisecStatus修改API安全生效防护对象或防护对象组状态查看文档去调试
ModifyApisecModuleStatus修改API安全防护模块生效防护对象或防护对象组状态查看文档去调试
ModifyApisecApiResource修改API安全API资产的标注查看文档去调试
DeleteApisecAbnormals批量删除API安全风险查看文档去调试
DeleteApisecEvents批量删除API安全事件查看文档去调试
报表信息
OpenAPI 名称描述操作
DescribeFlowCharthot查看流量统计信息查看文档去调试
DescribePeakTrend查看请求QPS的变化趋势查看文档去调试
DescribeResponseCodeTrendGraph查看WAF返回给客户端、源站返回给WAF的5XX、405、499、302、444等异常响应码的数量变化趋势查看文档去调试
DescribeVisitUas查看发起请求次数最多的前10个User-Agent查看文档去调试
DescribeVisitTopIp查看发起请求次数最多的前10个IP查看文档去调试
DescribeRuleHitsTopResource查看触发防护规则次数最多的前10个防护对象查看文档去调试
DescribeRuleHitsTopRuleId查看触发防护规则次数最多的前10个规则ID查看文档去调试
DescribeRuleHitsTopTuleType查看触发防护规则次数最多的前10个防护类型查看文档去调试
DescribeRuleHitsTopUrl查看触发防护规则次数最多的前10个URL查看文档去调试
DescribeRuleHitsTopClientIp查看发动攻击次数最多的前10个攻击源IP查看文档去调试
DescribeFlowTopResource查看请求量最高的前10个防护对象查看文档去调试
DescribeRuleHitsTopUa查看发动攻击次数最多的前10个User-Agent查看文档去调试
DescribeFlowTopUrl查看发起请求次数最多的前10个URL查看文档去调试
日志配置
OpenAPI 名称描述操作
DescribeUserSlsLogRegions查询用户可用的日志存储地域查看文档去调试
DescribeUserWafLogStatus查询用户WAF日志服务的状态、RegionId,状态修改时间等查看文档去调试
DescribeSlsAuthStatus查询日志库授权状态查看文档去调试
DescribeSlsLogStoreStatus查询SLS日志库的状态查看文档去调试
DescribeSlsLogStore查看日志库总容量,存储时长,已使用容量等信息查看文档去调试
DescribeResourceLogStatus查询防护对象日志状态查看文档去调试
ModifyResourceLogStatus修改防护对象日志状态查看文档去调试
混合云集群管理
OpenAPI 名称描述操作
DescribeHybridCloudServerRegions查询混合云支持的运营商、大州、城市等区域信息字典表查看文档去调试
DescribeHybridCloudUnassignedMachines查询混合云集群未分配服务器列表查看文档去调试
DescribeHybridCloudUser查询混合云接入,客户允许使用的端口范围,内容返回包括HTTP和HTTPS两类端口查看文档去调试
DescribeHybridCloudGroups查询添加到Web应用防火墙的混合云节点组列表查看文档去调试
ModifyHybridCloudClusterBypassStatus修改混合云SDK集成集群手动Bypass开关查看文档去调试
多账号统一管理
OpenAPI 名称描述操作
CreateMemberAccounts多账号统一管理功能中添加WAF成员账号查看文档去调试
DescribeAccountDelegatedStatus多账号统一管理中,查询用户是否是WAF的委派管理员查看文档去调试
DescribeMemberAccounts多账号统一管理中,查询WAF所有成员账号信息查看文档去调试
ModifyMemberAccount多账号统一管理中修改成员账号信息查看文档去调试
DeleteMemberAccount多账号统一管理中删除WAF成员账号查看文档去调试
资源组管理
OpenAPI 名称描述操作
ChangeResourceGroup修改防护对象所属的资源组查看文档去调试
标签管理
OpenAPI 名称描述操作
ListTagKeys查询标签键查看文档去调试
ListTagResources查询资源已经绑定的标签查看文档去调试
ListTagValues查询指定标签键对应的标签值查看文档去调试
UntagResources为指定的一个或多个资源统一解绑并删除标签查看文档去调试
TagResources指定一个或多个资源创建并绑定标签查看文档去调试
其他
OpenAPI 名称描述操作
ModifyHybridCloudClusterRule修改混合云集群规则信息查看文档去调试
CreateHybridCloudGroup创建混合云集群节点组信息查看文档去调试
DescribeHybridCloudClusterRule获取混合云集群规则信息查看文档去调试
ModifyHybridCloudServer修改混合云节点信息查看文档去调试
ModifyHybridCloudGroupExpansionServer集群分组中添加节点查看文档去调试
ModifyHybridCloudGroup修改集群组信息查看文档去调试
ModifyHybridCloudGroupShrinkServer集群分组删除节点查看文档去调试
ModifyHybridCloudSdkPullinStatus修改混合云SDK引流状态查看文档去调试
DescribeHybridCloudClusters查询混合云集群列表查看文档去调试
2024年08月20日