Help Center/ Web Application Firewall/ API Reference/ APIs/ Managing Rules/ Querying CC Attack Protection Rules

Updated on 2026-05-12 GMT+08:00

View PDF

Querying CC Attack Protection Rules

Function

This API is used to query the list of CC attack protection rules.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/waf/policy/{policy_id}/cc

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. To obtain it, log in to the Huawei Cloud console, click the username, choose My Credentials, and find the project ID in the Projects list. Constraints N/A Range N/A Default Value N/A
policy_id	Yes	String	Definition Protection policy ID. You can call the ListPolicy API to obtain the policy ID. Constraints N/A Range N/A Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). To obtain the resource details in all enterprise projects of a user, set this parameter to all_granted_eps.
offset	No	Integer	Definition Offset. The records after this offset will be queried. This parameter is used together with limit. Constraints N/A Range [0, 65535] Default Value N/A
limit	No	Integer	Definition Maximum number of records that can be returned. This parameter is used together with offset. If offset is not set, limit is invalid. Constraints N/A Range [1, 65535] Default Value 10
page	No	Integer	Definition Current page number. This parameter is used together with pagesize. Constraints N/A Range [1, RecordCount/pagesize] Default Value 1
pagesize	No	Integer	Definition Number of records displayed on each page. This parameter is used together with page. Constraints N/A Range [0, 2147483647] Default Value 1000
name	No	String	Rule name.
status	No	Integer	Rule status. 1: enabled. 0: disabled.
category	No	String	Definition Protective action. Range block: WAF blocks requests that trigger the rate limit set in the rule. log: WAF logs requests that trigger the rate limit set in the rule but does not block them. captcha: If the request exceeds the rate limit you configure, a verification code is displayed for human-machine verification. The request will not be allowed unless the verification is successful. Currently, verification code supports English. dynamic_block: Requests that trigger the rule are blocked based on the allowable frequency you configure after the first rate limit period is over. advanced_captcha: If your website visitor triggers the rate limit you set, CAPTCHA verification is required. js_challenge: requires the client to execute or verify a script to validate its identity.
tag_type	No	String	Definition Rate limiting mode. It specifies the way to identify an individual web visitor. Constraints N/A Range ip: IP-based rate limiting. Website visitors are identified by their IP addresses. cookie: Cookie-based rate limiting. Website visitors are identified by the key value of their cookies. header: Header-based rate limiting. Website visitors are identified by their headers. other: Referer-based rate limiting. Website visitors are identified by the Referer field (user-defined request source). policy: rule-based rate limiting domain: domain name-based rate limiting url: URL rate limiting Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Constraints N/A Range N/A Default Value N/A
Content-Type	Yes	String	Definition Content type. Constraints N/A Range N/A Default Value application/json;charset=utf8

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Number of rules in the policy
items	Array of CcrulesListInfo objects	Array of Cc rules

**Table 5** CcrulesListInfo
Parameter	Type	Description
policyname	String	Definition Policy Name. Constraints N/A Range N/A Default Value N/A
priority	Integer	Priority of the rule. A smaller value indicates a higher priority. If the values are the same, the rule created earlier has a higher priority. The value ranges from 0 to 65535.
name	String	Rule name.
id	String	Rule ID.
policyid	String	Policy ID.
url	String	When mode is set to 0, a value will be returned for this parameter. URL to which the rule applies, excluding the domain name.
prefix	Boolean	Whether the path uses prefix mode. If the protected URL ends with an asterisk (), the prefix mode is used. When mode* is set to 0, a value will be returned for this parameter.
mode	Integer	CC rule protection mode, which corresponds to the mode on the console. Currently, only the advanced CC rule protection mode can be created. 0: Standard. Only the protection path of a domain name can be restricted. 1: Advanced. The path, IP address, cookie, header, and params fields can all be restricted.
status	Integer	Definition Rule status, which is used to specify whether a rule is enabled or disabled. Constraints N/A Range 0: disabled 1: enabled Default Value N/A
conditions	Array of CcCondition objects	Rate limit condition of the CC attack protection rule. This parameter is mandatory when the CC attack protection rule is in advanced mode (mode is set to 1).
action	action object	Action to take if the number of requests reaches the upper limit.
tag_type	String	Definition Rate limiting mode. It specifies the way to identify an individual web visitor. Constraints N/A Range ip: IP-based rate limiting. Website visitors are identified by their IP addresses. cookie: Cookie-based rate limiting. Website visitors are identified by the key value of their cookies. header: Header-based rate limiting. Website visitors are identified by their headers. other: Referer-based rate limiting. Website visitors are identified by the Referer field (user-defined request source). policy: rule-based rate limiting domain: domain name-based rate limiting url: URL rate limiting Default Value N/A
tag_index	String	User identifier. This parameter is required when the rate limiting mode is cookie- or header-based rate limiting. If cookie is selected, you need to configure an attribute variable name in the cookie that can uniquely identify a web visitor based on your website requirements. This field does not support regular expressions. Only complete matches are supported. For example, if a website uses the name field in the cookie to uniquely identify a website visitor, select name. If header is selected, you need to configure the HTTP header that can identify web visitors based on your website requirements.
tag_condition	tag_condition object	User tag. This parameter is mandatory when the rate limit mode is set to other. other: A website visitor is identified by the Referer field (user-defined request source).
limit_num	Integer	Rate limiting frequency. Range: 1 to 2,147,483,647 requests.
limit_period	Integer	Rate limiting period, in seconds. Range: 1 to 3,600.
unlock_num	Integer	Allowable frequency. The value ranges from 0 to 2,147,483,647 requests. This parameter is mandatory only when the protective action is set to dynamic_block.
lock_time	Integer	Block duration, in seconds. Range: 0 to 65,535. The period within which access is blocked. An error page is displayed during this period.
domain_aggregation	Boolean	Whether to enable domain name aggregation statistics.
region_aggregation	Boolean	Whether to enable global counting.
description	String	Rule description.
total_num	Integer	This parameter is reserved for future function expansion. You can ignore it currently.
unaggregation	Boolean	This parameter is reserved for future function expansion. You can ignore it currently.
aging_time	Integer	Rule aging time. This parameter is reserved for future function expansion. You can ignore it currently.
producer	Integer	Object for creating a rule. This parameter is reserved for future function expansion. Ignore it currently.
timestamp	Long	Timestamp when the rule was created.

**Table 6** CcCondition
Parameter	Type	Description
category	String	Definition Field type. Constraints N/A Range url ip ipv6 asn params cookie referer user-agent header response_code response_header response_body request_body method tls_fingerprint tls_ja3_fingerprint Default Value N/A
logic_operation	String	Condition matching logic. If the field type category is url, the matching logic can be contain, not_contain, equal, not_equal, prefix, not_prefix, suffix, not_suffix, contain_any, not_contain_all, equal_any, not_equal_all, equal_any, not_equal_all, prefix_any, not_prefix_all, suffix_any, not_suffix_all, len_greater, len_less, len_equal, or len_not_equal. If the field type category is ip or ipv6, the matching logic can be equal, not_equal, equal_any, or not_equal_all. If the field type category is params, cookie, or header, the matching logic can be contain, not_contain, equal, not_equal, prefix, not_prefix, suffix, not_suffix, contain_any, not_contain_all, equal_any, not_equal_all, equal_any, not_equal_all, prefix_any, not_prefix_all, suffix_any, not_suffix_all, len_greater, len_less, len_equal, len_not_equal, num_greater, num_less, num_equal, num_not_equal, exist, or not_exist.
contents	Array of strings	Content for the matching logic in the condition list. This parameter is mandatory when the value of logic_operation does not end with any or all.
value_list_id	String	ID of the reference table. This parameter is mandatory when the value of logic_operation ends with any or all. Note that the reference table type must be consistent with the category type.
index	String	Subfield. If category is set to params, cookie, or header, this parameter is mandatory. Set this parameter based on the site requirements.

**Table 7** action
Parameter	Type	Description
category	String	Action type: captcha: Verification code. WAF requires visitors to enter a correct verification code to continue their access to the requested page on your website. block: WAF blocks requests hit rules in the policy. log: WAF only logs detected attacks. dynamic_block: Requests that trigger the rule are blocked based on the allowable frequency you configure after the first rate limit period is over. Note: dynamic_block can be set only when the advanced mode is used in CC attack protection rules.
detail	detail object	Block page information. This parameter is mandatory when category is set to block or dynamic_block. If you want to use the default block page, skip this parameter. If you want to configure a custom block page, set this parameter.

**Table 8** detail
Parameter	Type	Description
response	response object	Block page.

**Table 9** response
Parameter	Type	Description
content_type	String	Definition Content type. Constraints N/A Range text/html text/xml application/json Default Value N/A
content	String	Block page content.

**Table 10** tag_condition
Parameter	Type	Description
category	String	User identifier field. The value is fixed at referer.
contents	Array of strings	User identifier field content.

Status code: 400

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.
details	Array of IAM5ErrorDetails objects	The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

**Table 12** IAM5ErrorDetails
Parameter	Type	Description
error_code	String	Error codes of the downstream service.
error_msg	String	Error messages of the downstream service.

Status code: 401

**Table 13** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.
details	Array of IAM5ErrorDetails objects	The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

**Table 14** IAM5ErrorDetails
Parameter	Type	Description
error_code	String	Error codes of the downstream service.
error_msg	String	Error messages of the downstream service.

Status code: 500

**Table 15** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.
details	Array of IAM5ErrorDetails objects	The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

**Table 16** IAM5ErrorDetails
Parameter	Type	Description
error_code	String	Error codes of the downstream service.
error_msg	String	Error messages of the downstream service.

Example Requests

The following example shows how to query the CC attack protection rule list. Details about the query are specified by project_id and policy_id.

GET https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/cc?offset=0&limit=1

Example Responses

Status code: 200

Request succeeded.

{
  "total" : 1,
  "items" : [ {
    "id" : "f88c5eabff9b4ff9ba6e7dd8e38128ba",
    "policyid" : "d471eef691684f1c8d7784532fd8f4bd",
    "name" : "test",
    "timestamp" : 1678873040603,
    "description" : "",
    "status" : 1,
    "mode" : 1,
    "conditions" : [ {
      "category" : "url",
      "contents" : [ "/url" ],
      "logic_operation" : "contain"
    } ],
    "action" : {
      "category" : "captcha"
    },
    "producer" : 1,
    "unaggregation" : false,
    "total_num" : 0,
    "limit_num" : 10,
    "limit_period" : 60,
    "lock_time" : 0,
    "tag_type" : "ip",
    "aging_time" : 0,
    "region_aggregation" : false,
    "domain_aggregation" : false
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

     package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.waf.v1.region.WafRegion;
import com.huaweicloud.sdk.waf.v1.*;
import com.huaweicloud.sdk.waf.v1.model.*;


public class ListCcRulesSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        WafClient client = WafClient.newBuilder()
                .withCredential(auth)
                .withRegion(WafRegion.valueOf("<YOUR REGION>"))
                .build();
        ListCcRulesRequest request = new ListCcRulesRequest();
        request.withPolicyId("{policy_id}");
        try {
            ListCcRulesResponse response = client.listCcRules(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 
 
  

     # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkwaf.v1.region.waf_region import WafRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkwaf.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = WafClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(WafRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListCcRulesRequest()
        request.policy_id = "{policy_id}"
        response = client.list_cc_rules(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 
 
  

     package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := waf.WafClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := waf.NewWafClient(hcClient)

    request := &model.ListCcRulesRequest{}
	request.PolicyId = "{policy_id}"
	response, err := client.ListCcRules(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}
 
 
  

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code	Description
200	Request succeeded.
400	Request failed.
401	The token does not have required permissions.
500	Internal server error.

Error Codes

See Error Codes.

Parent Topic: Managing Rules

Previous topic: Obtaining the Built-in Rule Type by Protection Rule Type

Next topic: Creating a CC Attack Protection Rule

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot