调用DescribeProtectionModuleStatus查询指定的WAF防护功能模块的启用状态。
使用说明
本接口用于查询指定的WAF防护功能模块的启用状态。您可以通过设置DefenseType参数值指定要查询的某个防护功能模块。具体参数值的含义,请参见请求参数DefenseType的描述。
QPS限制
本接口的单用户QPS限制为50次/秒。超过限制,API调用将会被限流,这可能影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeProtectionModuleStatus |
要执行的操作。取值:DescribeProtectionModuleStatus。 |
Domain | String | 是 | www.aliyundoc.com |
要查询的网站域名。 说明 您可以调用DescribeDomainList查询所有已接入WAF防护的域名。
|
DefenseType | String | 是 | waf |
要查询的WAF防护功能模块。取值:
说明 只支持设置一个功能模块。
|
InstanceId | String | 是 | waf-cn-zz11sr5**** |
要查询的WAF实例的ID。 说明 您可以调用DescribeInstanceInfo查询当前WAF实例的ID。
|
调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数。
调用API的请求格式,请参见本文示例中的请求示例。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ModuleStatus | Integer | 1 |
防护功能模块的启用状态。取值:
|
RequestId | String | D7861F61-5B61-46CE-A47C-6B19160D5EB0 |
本次请求的ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeProtectionModuleStatus
&Domain=www.aliyundoc.com
&DefenseType=waf
&InstanceId=waf-cn-zz11sr5****
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeProtectionModuleStatusResponse>
<ModuleStatus>1</ModuleStatus>
<RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>
</DescribeProtectionModuleStatusResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"ModuleStatus" : 1,
"RequestId" : "D7861F61-5B61-46CE-A47C-6B19160D5EB0"
}
错误码
访问错误中心查看更多错误码。