Help Center/ Web Application Firewall/ API Reference/ APIs/ Managing Rules/ Querying All CC Attack Protection Rules
Updated on 2026-05-12 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying All CC Attack Protection Rules

Function

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

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/waf/rule/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

The value contains 32 characters. Only letters and digits are supported.

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

policyids

No

String

Definition

Policy ID list. Obtain the policy ID by calling the ListPolicy API. Policies are separated by commas (,).

Constraints

N/A

Range

N/A

Default Value

N/A

enterprise_project_id

No

String

Definition

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.

Constraints

N/A

Range

  • 0: the default enterprise project.

  • all_granted_eps: all enterprise projects.

  • A specific enterprise project ID: Enter a maximum of 36 characters.

Default Value

0

page

No

Integer

Definition

Page number of the data to be returned in a query.

Constraints

N/A

Range

The valid range of page depends on the total data volume and the value of pagesize. The value cannot be greater than the total number of pages.

Default Value

1

pagesize

No

Integer

Definition

Number of results per page in a query.

Constraints

N/A

Range

[0, Total data volume]

Default Value

1000

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

Definition

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the 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

Query all CC attack protection rules.

GET https://{endpoint}/v1/{project_id}/waf/rule/cc?enterprise_project_id=0

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.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
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 ListCcPolicyRulesSolution {

    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();
        ListCcPolicyRulesRequest request = new ListCcPolicyRulesRequest();
        try {
            ListCcPolicyRulesResponse response = client.listCcPolicyRules(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());
        }
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# 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 = ListCcPolicyRulesRequest()
        response = client.list_cc_policy_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)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
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.ListCcPolicyRulesRequest{}
	response, err := client.ListCcPolicyRules(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