DescribeProtectionModuleStatus - 查询WAF各防护功能状态_Web应用防火墙(WAF)-阿里云帮助中心

查询WAF各防护功能的状态，包括Web入侵防护、数据安全、高级防护、Bot管理、访问控制或限流等模块。

接口说明

本接口用于查询指定的 WAF 防护功能模块的启用状态。您可以通过设置 DefenseType 参数值指定要查询的某个防护功能模块。具体参数值的含义，请参见请求参数 DefenseType 的描述。请注意，为确保系统稳定性。对单用户 QPS 限制为 50 次/秒。超过限制，API 调用将会被限流，这可能影响您的业务，请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
yundun-waf:DescribeProtectionModuleStatus	Read	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Domain	string	是	要查询的网站域名。说明您可以调用 DescribeDomainList 查询所有已接入 WAF 防护的域名。	www.aliyundoc.com
DefenseType	string	是	要查询的 WAF 防护功能模块。取值： waf：表示规则防护引擎。 dld：表示深度学习引擎。 tamperproof：表示网站防篡改。 dlp：表示防敏感信息泄漏。 normalized：表示主动防御。 bot_crawler：表示合法爬虫。 bot_intelligence：表示爬虫威胁情报。 antifraud：表示数据风控。 bot_algorithm：表示智能算法。 bot_wxbb：表示 App 防护。 bot_wxbb_pkg：表示 App 防护中的版本防护。 ac_cc：表示 CC 安全防护。 ac_blacklist：表示 IP 黑名单。 ac_highfreq：表示扫描防护中的高频 Web 攻击封禁。 ac_dirscan：表示扫描防护中的目录遍历防护。 ac_scantools：表示扫描防护中的扫描工具封禁。 ac_collaborative：表示扫描防护中的协同防御。 ac_custom：表示自定义防护策略。说明只支持设置一个功能模块。	waf
InstanceId	string	是	要查询的 WAF 实例的 ID。说明您可以调用 DescribeInstanceInfo 查询当前 WAF 实例的 ID。	waf-cn-zz11sr5****
ResourceGroupId	string	否	WAF 实例在资源管理服务中所属的资源组 ID。默认为空，即属于默认资源组。关于资源组的更多信息，请参见创建资源组。	rg-aek2hw7****ftqi
RegionId	string	否	WAF 实例所属地域。取值： cn-hangzhou：表示中国内地。 ap-southeast-1：表示非中国内地。	cn-hangzhou

调用 API 时，除了本文中该 API 的请求参数，还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍，请参见公共参数。

调用 API 的请求格式，请参见本文示例中的请求示例。

返回参数

名称	类型	描述	示例值
	object
ModuleStatus	integer	防护功能模块的启用状态。取值： 0：表示功能模块已关闭。 1：表示功能模块已开启。	1
RequestId	string	本次请求的 ID。	D7861F61-5B61-46CE-A47C-6B19160D5EB0

示例

正常返回示例

JSON格式

{
  "ModuleStatus": 1,
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0"
}

错误码

访问错误中心查看更多错误码。