Querying the Built-in Rules in Basic Web Protection

Function

This API is used to query the built-in rules in basic web protection.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/waf/policy/basic-protection/default-rules

**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 can contain 32 characters. Only letters and digits are allowed. Default Value N/A

**Table 2** Query Parameters
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 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
offset	No	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	No	Integer	Definition Number of records returned on each page of a paginated query. This parameter specifies how many records you want to retrieve each time. Constraints N/A Range N/A Default Value 10
from	No	Long	Definition Start time (13-digit timestamp in ms). This parameter must be used together with parameter to. Constraints N/A Range N/A Default Value N/A
to	No	Long	Definition End time (13-digit timestamp, in ms). This parameter must be used together with parameter from. Constraints N/A Range N/A Default Value N/A
level	No	Integer	Definition Protection level of the rule set. If you select a loose rule set, there will be fewer false positives, but also more false negatives. If you select a tight rule set, the opposite is true. Constraints N/A Range 1: loose 2: medium 3: Tight Default Value N/A
id	No	String	Definition Rule ID. A rule ID uniquely identifies a rule. Constraints N/A Range 6 characters. Default Value N/A
description	No	String	Definition Rule description. Constraints N/A Range N/A Default Value N/A
cve_number	No	String	Definition CVE ID. Constraints N/A Range N/A Default Value N/A
risk_level	No	Integer	Definition Risk severity. Constraints N/A Range 1: high risk 2: medium risk 3: low risk Default Value N/A
protection_type_names	No	String	Definition Protection type. Constraints N/A Range vuln: Others xss: Cross-site scripting (XSS) attacks cmdi: command injection attacks lfi: local file inclusion attacks rfi: remote file inclusion attacks webshell: website Trojans robot: malicious crawlers sqli: SQL injections Default Value N/A
application_type_names	No	String	Definition Application type. Constraints N/A Range For details, go to the Basic Web Protection page on the WAF console. 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
X-Language	No	String	Definition Language. The default value is zh-cn. zh-cn: Chinese; en-us: English Constraints N/A Range zh-cn: Chinese en-us: English zh-cn Default Value

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Number of built-in basic web protection rules in the policy.
items	Array of WebBasicProtectionRulesItem objects	Array of built-in basic web protection rules.

**Table 5** WebBasicProtectionRulesItem
Parameter	Type	Description
id	String	Definition Rule ID. Each rule has a unique ID. Range N/A
description	String	Definition Rule description. Range N/A
cve_number	String	Definition CVE ID. Range N/A
risk_level	Integer	Definition Risk severity. 1: high risk 2: medium risk 3: low risk 1 2 3 Range
application_type	String	Definition Application type. Range N/A
protection_type	String	Definition Protection type. Range N/A
effective_time	Integer	Definition Effective time. Range N/A
create_time	Integer	Definition Creation time. Range N/A
update_time	Integer	Definition Update time. Range N/A

Status code: 400

**Table 6** 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 7** 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 8** 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 9** 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 10** 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 11** 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 details of the basic web protection rule set for a project. The project ID is project_id.

GET https://{endpoint}/v1/{project_id}/waf/policy/basic-protection/default-rules

Example Responses

Status code: 200

Request succeeded.

{
  "total" : 1,
  "items" : [ {
    "id" : 12298,
    "description" : "Nmap command injection attack",
    "cve_number" : null,
    "risk_level" : 1,
    "application_type" : null,
    "protection_type" : "cmdi",
    "effective_time" : 0,
    "create_time" : 1618539073821,
    "update_time" : 1749738600000
  } ]
}

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 ListWebBasicProtectionRulesSolution {

    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();
        ListWebBasicProtectionRulesRequest request = new ListWebBasicProtectionRulesRequest();
        try {
            ListWebBasicProtectionRulesResponse response = client.listWebBasicProtectionRules(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 = ListWebBasicProtectionRulesRequest()
        response = client.list_web_basic_protection_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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := waf.NewWafClient(
        waf.WafClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

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

          

        

      
     