All Products
Search
Document Center

Edge Security Acceleration:DescribeDcdnWafScenes

Last Updated:Oct 17, 2024

Queries the information about the type of the protection policy that you use.

Operation description

You can call this operation up to 20 times per second per user.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DefenseScenesstringNo

The types of the protection policies that you want to query. Separate multiple types with commas (,). Valid values:

  • waf_group: basic web protection
  • custom_acl: custom protection
  • whitelist: IP address whitelist
  • ip_blacklist: IP address blacklist
  • region_block: region blacklist
  • bot: bot management
Note If you do not set this parameter, all types of protection policies are queried.
waf_group,custom_acl,whitelist

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

3D7BB13C-DD84-5654-A835-B8E1385DE274
DefenseScenesarray<object>

The types of the protection policies.

DefenseSceneItemobject
PolicyCountinteger

The total number of policies of this type that were configured.

10
RuleCountinteger

The total number of protection rules that were configured in this type of the policy.

12
DefenseScenestring

The type of the protection policy, which is the same as the DefenseScenes parameter in request parameters.

waf_group

Examples

Sample success responses

JSONformat

{
  "RequestId": "3D7BB13C-DD84-5654-A835-B8E1385DE274",
  "DefenseScenes": [
    {
      "PolicyCount": 10,
      "RuleCount": 12,
      "DefenseScene": "waf_group"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.