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
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 Enter 32 characters. Only letters and digits are allowed. 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 Enter 32 characters. Only letters and digits are allowed. Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
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
Default Value 0 |
offset |
Yes |
Integer |
Definition Start position of the pagination query. This parameter specifies from which record you want to retrieve (counting starts from 0). Constraints N/A Range N/A Default Value 0 |
limit |
Yes |
Integer |
Definition Maximum number of records that can be returned. Constraints N/A Range N/A Default Value N/A |
Request 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
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
Number of rules in the policy |
items |
Array of CcrulesListInfo objects |
Array of Cc rules |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Definition Rule name. Range N/A |
id |
String |
Definition Rule ID. Range N/A |
policyid |
String |
Definition Protection policy ID. Range N/A |
url |
String |
Definition When the value of mode is 0, this parameter has a return value. Specifies the URL to which the rule applies, excluding a domain name. Range N/A |
prefix |
Boolean |
Definition Whether the path is in prefix mode. If the protected URL ends with an asterisk (*), the prefix mode is used. When the value of mode is 0, this parameter has a return value. Range N/A |
mode |
Integer |
Definition CC rule protection mode, which corresponds to the mode on the console. Currently, only the advanced CC rule protection mode can be created. Range
|
status |
Integer |
Definition Rule status. Range
|
conditions |
Array of CcCondition objects |
Definition 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). Range N/A |
action |
action object |
Action to take if the number of requests reaches the upper limit. |
tag_type |
String |
Definition Rate limit mode. Range
|
tag_index |
String |
Definition User identifier. This parameter is required when the rate limiting mode is cookie- or header-based rate limiting. Range
|
tag_condition |
tag_condition object |
User tag. This parameter is mandatory when the rate limit mode is set to other.
|
limit_num |
Integer |
Definition Rate limit frequency. Range The value ranges from 1 to 2,147,483,647, in times. |
limit_period |
Integer |
Definition Rate limit period. Range The value ranges from 1 to 3,600, in seconds. |
unlock_num |
Integer |
Definition Allowable frequency. This parameter is mandatory only when the protective action is set to dynamic_block. Range The value ranges from 0 to 2,147,483,647, in times. |
lock_time |
Integer |
Definition Block duration. The period within which access is blocked. An error page is displayed during this period. Range The value ranges from 0 to 65,535, in seconds. |
domain_aggregation |
Boolean |
Definition Whether to enable domain name aggregation statistics. Range N/A |
region_aggregation |
Boolean |
Definition Whether to enable global counting. Range N/A |
description |
String |
Definition Rule description. Range N/A |
total_num |
Integer |
Definition This parameter is reserved for future function expansion. Ignore it currently. Range N/A |
unaggregation |
Boolean |
Definition This parameter is reserved for future function expansion. Ignore it currently. Range N/A |
aging_time |
Integer |
Definition Rule aging time. This parameter is reserved for future function expansion. Ignore it currently. Range N/A |
producer |
Integer |
Definition Object for creating a rule. This parameter is reserved for future function expansion. Ignore it currently. Range N/A |
timestamp |
Long |
Definition Timestamp when the rule was created. Range 13-bit millisecond timestamp. |
Parameter |
Type |
Description |
---|---|---|
category |
String |
Definition Field type. Range
|
logic_operation |
String |
Definition Condition List Matching Logic Range
|
contents |
Array of strings |
Definition 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. Range N/A |
value_list_id |
String |
Definition 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 the same as the category type. Range N/A |
index |
String |
Definition Subfield. Range If category is set to params, cookie, or header, this parameter is mandatory. Set this parameter based on the site requirements. |
Parameter |
Type |
Description |
---|---|---|
category |
String |
Definition Action type. The options are as follows: Range
|
detail |
detail object |
Definition Information of the blocking page. This parameter is mandatory when category is set to block or dynamic_block.
Range N/A |
Parameter |
Type |
Description |
---|---|---|
content_type |
String |
Definition Content type. The value can be application/json, text/html, or text/xml. Range
|
content |
String |
Definition Block page content. Range N/A |
Parameter |
Type |
Description |
---|---|---|
category |
String |
Definition User identifier field. The value is fixed at referer. Range
|
contents |
Array of strings |
Definition User identifier field content. Range N/A |
Status code: 400
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. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes of the downstream service. |
error_msg |
String |
Error messages of the downstream service. |
Status code: 401
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. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes of the downstream service. |
error_msg |
String |
Error messages of the downstream service. |
Status code: 500
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. |
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", "timestamp" : 1678873040603, "name" : "test", "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 48 |
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()); } } } |
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 |
# 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) |
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 |
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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := waf.NewWafClient( waf.WafClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) 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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot