doc-exports/docs/waf/api-ref/waf_02_0042.html

Querying CC Attack Protection Rules

Function Description

This API is used to query all CC attack protection rules in a policy.

URI

• URI format

  GET /v1/{project_id}/waf/policy/{policy_id}/cc?offset={offset}&limit={limit}

• Parameter description

  Table 1 Path parameters

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Specifies the project ID.
  policy_id	Yes	String	Specifies the policy ID.
  offset	No	Long	Specifies the number of returned pages. Its value ranges from 0 to 65535. The default value is 0.
  limit	No	Long	Specifies the maximum number of records displayed on each page. Its value ranges from 0 to 50. The default value is 10.

Request

Request parameters

None

Response

Response parameters

Table 2 Parameter description

Parameter	Type	Description
total	Integer	Specifies the total number of CC attack protection rules in a policy.
items	Table 3	Specifies the CC attack protection rule objects.

Table 3 items

Parameter	Type	Description
id	String	Specifies the ID of a CC attack protection rule.
policy_id	String	Specifies the ID of the policy to which the rule belongs.
path	String	Specifies the URL to which the rule applies, excluding a domain name. Prefix match: The path ending with * indicates that the path is used as a prefix. For example, if the path to be protected is /admin/test.php or /adminabc, set Path to /admin*. Exact match: The path to be entered must match the path to be protected. If the path to be protected is /admin, set url to /admin.
limit_num	Integer	Specifies the number of requests allowed from a web visitor in a rate limiting period.
limit_period	Integer	Specifies the rate limiting period.
lock_time	Integer	Specifies the lock duration. The value ranges from 0 seconds to 232 seconds.
tag_type	String	Specifies the rate limit mode. ip: A web visitor is identified by the IP address. cookie: A web visitor is identified by the cookie key value. other: A web visitor is identified by the Referer field (user-defined request source).
tag_index	String	If tag_type is set to cookie, this parameter indicates cookie name.
tag_condition	Table 4	Specifies the Referer (customized request source) field. This field is returned when tag_type is set to other.
action	Table 5	Specifies the action taken when the number of requests reaches the upper limit.
timestamp	Long	Specifies the time when a CC attack protection rule is added.
default	Boolean	Specifies whether the rule is the default CC attack protection rule. true: The rule is the default CC attack protection rule created by the system when creating a domain name. false: The rule is created by users.

Table 4 tag_condition

Parameter	Type	Description
category	String	Specifies the category. The value is Referer.
contents	List	Specifies the category content. For example, http://www.xxx.com.

Table 5 action

Parameter	Type	Description
category	String	Specifies the action. The default value is block. block: block the requests. captcha: Verification code. The user needs to enter the correct verification code after blocking to restore the correct access page. The default value is block.
detail	Table 6	Specifies the action details. If detail is null, the default block page is displayed by default.

Table 6 detail

Parameter	Type	Description
response	Table 7	Specifies the returned page.

Table 7 response

Parameter	Type	Description
content_type	String	Specifies the type of the returned page. The options are application/json, text/html, and text/xml.
content	String	Specifies the content of the returned page.

Example

total with a value of 2 is used as an example.

Response example

{
  "total": 2,
  "items": [{
      "id": "3a9b5c0f96784ec8abd8ba61a98064ef",
      "policy_id": "9tre832yf96784ec8abd8ba61a98064ef",
      "path": "/abc1",
      "limit_num": 10,
      "limit_period": 60,
      "lock_time": 10,
      "tag_type": "cookie",
      "tag_index": "sesssionid",
      "action": {
        "category": "block",
        "detail": {
          "response": {
              "content_type": "application/json",
              "content": "{\"error\":\"forbidden\"}"
          }
        }
      },
      "timestamp": 1499817600,
      "default": true
    }, {
      "id": "3d7bea768b10480984f98c6b69d43d0f",
      "policy_id": "9tre832yf96784ec8abd8ba61a98064ef",
      "path": "/efgh",
      "limit_num": 10,
      "limit_period": 60,
      "lock_time": 5,
      "tag_type": "other",
      "tag_condition":{
          "category": "referer",
         "contents": ["http://www.example.com"]
       }
      "action": {
        "category": "block",
      },
      "timestamp": 1499817600,
      "default": true
    }
  ]
}

Status Code

Table 8 describes the normal status code returned by the API.

Table 8 Status code

Status Code	Description	Meaning
200	OK	The request has succeeded.

For details about error status codes, see Status Codes.

Parent topic: CC Attack Protection Rules