You can call this operation to query the DescribeProtectionModuleStatus status of each protection module, including Web intrusion prevention, data security, advanced protection, Bot management, and access control or throttling.

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

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

Element 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: the RegEx protection engine
  • dld: the big data deep learning engine
  • tamperproof: tamper protection
  • antihijack: web page anti-hijacking
  • dlp: data leakage prevention
  • normalized: positive security model
  • bot_crawler: valid crawlers
  • bot_intelligence: Bot Threat Intelligence
  • antifraud: data risk control
  • bot_algorithm: intelligent algorithm
  • bot_wxbb: App Protection
  • bot_wxbb_pkg: version protection in App protection
  • cc: HTTP flood protection
  • ac_blacklist: the IP blacklist.
  • ac_highfreq: block high-frequency Web attacks in the scanning protection module
  • ac_dirscan: directory traversal protection
  • ac_scantools: scan tools in the scan protection module are blocked.
  • ac_collaborative: collaborative defense
  • ac_custom: custom protection policies
Domain String Yes www.example.com

The domain name that has been added to WAF.

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

The ID of the WAF instance.

Note You can call the DescribeInstanceInfo operation to query the ID of the WAF instance.

Response parameters

Element Type Sample response Description
ModuleStatus Integer 1

Indicates whether the module is enabled. Valid values:

  • 0: indicates that log backups are disabled.
  • 1: indicates enabled.
RequestId String D7861F61-5B61-46CE-A47C-6B19160D5EB0

The ID of the request.

Examples

Sample request

http(s)://[Endpoint]/? Action=DescribeProtectionModuleStatus
&Domain=www.example.com
&InstanceId=waf_elasticity-cn-0xl****
&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.