Queries the status of a Web Application Firewall (WAF) protection module. WAF protection modules include web intrusion prevention, data security, advanced mitigation, bot management, and access control or throttling.

You can set the DefenseType parameter to specify a protection module. For more information about the values of this parameter, see the description of DefenseType.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeProtectionModuleStatus

The operation that you want to perform. Set the value to DescribeProtectionModuleStatus.

DefenseType String Yes waf

The protection module. Valid values:

  • waf: RegEx protection engine
  • dld: big data deep learning engine
  • tamperproof: website tamper-proofing
  • antihijack: web page anti-hijacking
  • dlp: data leak prevention
  • normalized: positive security model
  • bot_crawler: legitimate crawler
  • bot_intelligence: bot threat intelligence
  • antifraud: data risk control
  • bot_algorithm: intelligent aglorithm
  • bot_wxbb: app protection
  • bot_wxbb_pkg: version protection
  • ac_cc: HTTP flood protection
  • ac_blacklist: IP address blacklist
  • ac_highfrep: high-frequency web attack blocking
  • ac_dirscan: directory traversal protection
  • ac_scantool: scan tool blocking
  • ac_collaborative: collaborative protection
  • ac_custom: custom protection policy
Domain String Yes www.example.com

The domain name that is added to WAF.

InstanceId String Yes waf_elasticity-cn-0xldbqt****

The ID of the WAF instance.

Note You can query the ID by calling DescribeInstanceInfo.

Response parameters

Parameter Type Example Description
ModuleStatus Integer 1

Indicates whether the module is enabled. Valid values:

  • 0: disabled
  • 1: enabled
RequestId String D7861F61-5B61-46CE-A47C-6B19160D5EB0

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeProtectionModuleStatus
&Domain=www.example.com
&InstanceId=waf_elasticity-cn-0xldbqt****
&DefenseType=waf
&<Common request parameters>

Sample success responses

XML format

<ModifyProtectionRuleCacheStatusResponse>
      <ModuleStatus>1</ModuleStatus>
      <RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>
</ModifyProtectionRuleCacheStatusResponse>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.