Help Center/ Web Application Firewall/ API Reference/ APIs/ Rule Management/ Updating an Information Leakage Prevention Rule
Updated on 2024-07-09 GMT+08:00

Updating an Information Leakage Prevention Rule

Function

This API is used to update an information leakage prevention rule.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/waf/policy/{policy_id}/antileakage/{rule_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. To obtain it, go to Huawei Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials. Then, in the Projects area, view Project ID of the corresponding project.

policy_id

Yes

String

Policy ID. It can be obtained by calling the ListPolicy API.

rule_id

Yes

String

Information leakage prevention rule ID. You can obtain it by calling the ListAntileakageRules API.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

You can obtain the ID by calling the ListEnterpriseProject API of EPS.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Content-Type

Yes

String

Content type.

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

url

Yes

String

URL the rule applies to.

category

Yes

String

Type. The value can be code for response code or sensitive for sensitive information.

contents

Yes

Array of strings

Content. The value can be an HTTP status code, phone for mobile phone numbers, id_card for personal identity card number, and/or email for email addresses.

action

No

action object

Protective action of the Antileakage rule

description

No

String

Rule description.

Table 5 action

Parameter

Mandatory

Type

Description

category

Yes

String

Protection type

  • block: WAF blocks attacks.

  • log: WAF only logs discovered attacks.

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

id

String

Rule ID.

policyid

String

Policy ID.

url

String

URL the rule applies to.

category

String

Type

contents

Array of strings

Value

status

Integer

Rule status. The value can be 0 or 1.

  • 0: The rule is disabled.

  • 1: The rule is enabled.

description

String

Rule description.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

The following example shows how to update a web tamper protection rule. The project ID is specified by project_id, the policy ID is specified by policy_id, and the rule ID is specified by rule_id. The URL for the rule is /attack, the content type is sensitive information, and the rule content is ID card number.

PUT https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/antileakage/{rule_id}?

{
  "url" : "/login",
  "category" : "sensitive",
  "contents" : [ "id_card" ]
}

Example Responses

Status code: 200

Request sent.

{
  "id" : "82c4f04f84fd4b2b9ba4b4ea0df8ee82",
  "policyid" : "2fcbcb23ef0d48d99d24d7dcff00307d",
  "description" : "demo",
  "status" : 1,
  "url" : "/login",
  "category" : "sensitive",
  "contents" : [ "id_card" ]
}

SDK Sample Code

The SDK sample code is as follows.

The following example shows how to update a web tamper protection rule. The project ID is specified by project_id, the policy ID is specified by policy_id, and the rule ID is specified by rule_id. The URL for the rule is /attack, the content type is sensitive information, and the rule content is ID card number.

 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
50
51
52
53
54
55
56
57
58
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.*;

import java.util.List;
import java.util.ArrayList;

public class UpdateAntileakageRuleSolution {

    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();
        UpdateAntileakageRuleRequest request = new UpdateAntileakageRuleRequest();
        request.withPolicyId("{policy_id}");
        request.withRuleId("{rule_id}");
        UpdateAntileakageRuleRequestBody body = new UpdateAntileakageRuleRequestBody();
        List<String> listbodyContents = new ArrayList<>();
        listbodyContents.add("id_card");
        body.withContents(listbodyContents);
        body.withCategory(UpdateAntileakageRuleRequestBody.CategoryEnum.fromValue("sensitive"));
        body.withUrl("/login");
        request.withBody(body);
        try {
            UpdateAntileakageRuleResponse response = client.updateAntileakageRule(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());
        }
    }
}

The following example shows how to update a web tamper protection rule. The project ID is specified by project_id, the policy ID is specified by policy_id, and the rule ID is specified by rule_id. The URL for the rule is /attack, the content type is sensitive information, and the rule content is ID card number.

 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
# 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 = UpdateAntileakageRuleRequest()
        request.policy_id = "{policy_id}"
        request.rule_id = "{rule_id}"
        listContentsbody = [
            "id_card"
        ]
        request.body = UpdateAntileakageRuleRequestBody(
            contents=listContentsbody,
            category="sensitive",
            url="/login"
        )
        response = client.update_antileakage_rule(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

The following example shows how to update a web tamper protection rule. The project ID is specified by project_id, the policy ID is specified by policy_id, and the rule ID is specified by rule_id. The URL for the rule is /attack, the content type is sensitive information, and the rule content is ID card number.

 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 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.UpdateAntileakageRuleRequest{}
	request.PolicyId = "{policy_id}"
	request.RuleId = "{rule_id}"
	var listContentsbody = []string{
        "id_card",
    }
	request.Body = &model.UpdateAntileakageRuleRequestBody{
		Contents: listContentsbody,
		Category: model.GetUpdateAntileakageRuleRequestBodyCategoryEnum().SENSITIVE,
		Url: "/login",
	}
	response, err := client.UpdateAntileakageRule(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 sent.

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.