Updated on 2025-09-17 GMT+08:00

Creating an IP Intelligence Rule

Function

This API is used to create an IP intelligence rule.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/waf/policy/{policy_id}/ip-reputation

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of the user.

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

Definition

Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS).

Constraints

N/A

Range

N/A

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 for obtaining a user token (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

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

name

No

String

Definition

Rule name.

Constraints

N/A

Range

N/A

Default Value

N/A

policyname

No

String

Definition

Policy name.

Constraints

N/A

Range

N/A

Default Value

N/A

description

No

String

Definition

Rule description.

Constraints

N/A

Range

N/A

Default Value

N/A

status

No

Integer

Definition

Rule status. 1: enabled. 0: disabled.

Constraints

N/A

Range

1: enabled. 0: disabled.

Default Value

N/A

action

No

action object

Definition

Protective action configuration.

Constraints

N/A

Range

N/A

Default Value

N/A

type

No

String

Definition

Rule type, for example, idc indicates the data center IP intelligence type.

Constraints

N/A

Range

N/A

Default Value

N/A

tags

No

Array of strings

Definition

Tag list. Tags are used to specify the associated intelligence identifiers.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 5 action

Parameter

Mandatory

Type

Description

category

No

String

Definition

Action type, for example, log indicates that attacks are logged only.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

id

String

Definition

Rule ID, which uniquely identifies a rule.

Constraints

N/A

Range

N/A

Default Value

N/A

policyid

String

Definition

Protection policy ID.

Constraints

N/A

Range

N/A

Default Value

N/A

name

String

Definition

Rule name.

Constraints

N/A

Range

N/A

Default Value

N/A

policyname

String

Definition

Policy name.

Constraints

N/A

Range

N/A

Default Value

N/A

timestamp

Integer

Definition

Rule creation timestamp (in ms).

Constraints

N/A

Range

N/A

Default Value

N/A

description

String

Definition

Rule description.

Constraints

N/A

Range

N/A

Default Value

N/A

status

Integer

Definition

Rule status. 1: enabled. 0: disabled.

Constraints

N/A

Range

N/A

Default Value

N/A

type

String

Definition

Rule type, for example, idc indicates the data center IP intelligence type.

Constraints

N/A

Range

N/A

Default Value

N/A

tags

Array of strings

Definition

Tag list, which is the associated intelligence IDs.

Constraints

N/A

Range

N/A

Default Value

N/A

action

action object

Definition

Protective action configuration.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 7 action

Parameter

Type

Description

category

String

Definition

Action type, for example, log indicates that attacks are logged only.

Constraints

N/A

Range

N/A

Default Value

N/A

Status code: 400

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: 401

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.

Status code: 500

Table 12 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 13 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Example Requests

POST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/ip-reputation?enterprise_project_id=0

{
  "name" : "name",
  "policyname" : "policy_name",
  "description" : "description",
  "status" : 1,
  "action" : {
    "category" : "log"
  },
  "type" : "idc",
  "tags" : [ "Google" ]
}

Example Responses

Status code: 200

OK

{
  "id" : "3e57a557e2274f2686416afa77d6438b",
  "policyid" : "6d392034d94c4e8a95a78c98127453b6",
  "name" : "name",
  "policyname" : "policy_name",
  "timestamp" : 1657851399563,
  "description" : "description",
  "status" : 1,
  "type" : "idc",
  "tags" : [ "Google" ],
  "action" : {
    "category" : "log"
  }
}

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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
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 CreateIpReputationRuleSolution {

    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();
        CreateIpReputationRuleRequest request = new CreateIpReputationRuleRequest();
        request.withPolicyId("{policy_id}");
        CreateIpReputationRuleRequestBody body = new CreateIpReputationRuleRequestBody();
        List<String> listbodyTags = new ArrayList<>();
        listbodyTags.add("Google");
        CreateIpReputationRuleRequestBodyAction actionbody = new CreateIpReputationRuleRequestBodyAction();
        actionbody.withCategory("log");
        body.withTags(listbodyTags);
        body.withType("idc");
        body.withAction(actionbody);
        body.withStatus(1);
        body.withDescription("description");
        body.withPolicyname("policy_name");
        body.withName("name");
        request.withBody(body);
        try {
            CreateIpReputationRuleResponse response = client.createIpReputationRule(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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# 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 = CreateIpReputationRuleRequest()
        request.policy_id = "{policy_id}"
        listTagsbody = [
            "Google"
        ]
        actionbody = CreateIpReputationRuleRequestBodyAction(
            category="log"
        )
        request.body = CreateIpReputationRuleRequestBody(
            tags=listTagsbody,
            type="idc",
            action=actionbody,
            status=1,
            description="description",
            policyname="policy_name",
            name="name"
        )
        response = client.create_ip_reputation_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)
 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
59
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.CreateIpReputationRuleRequest{}
	request.PolicyId = "{policy_id}"
	var listTagsbody = []string{
        "Google",
    }
	categoryAction:= "log"
	actionbody := &model.CreateIpReputationRuleRequestBodyAction{
		Category: &categoryAction,
	}
	typeCreateIpReputationRuleRequestBody:= "idc"
	statusCreateIpReputationRuleRequestBody:= int32(1)
	descriptionCreateIpReputationRuleRequestBody:= "description"
	policynameCreateIpReputationRuleRequestBody:= "policy_name"
	nameCreateIpReputationRuleRequestBody:= "name"
	request.Body = &model.CreateIpReputationRuleRequestBody{
		Tags: &listTagsbody,
		Type: &typeCreateIpReputationRuleRequestBody,
		Action: actionbody,
		Status: &statusCreateIpReputationRuleRequestBody,
		Description: &descriptionCreateIpReputationRuleRequestBody,
		Policyname: &policynameCreateIpReputationRuleRequestBody,
		Name: &nameCreateIpReputationRuleRequestBody,
	}
	response, err := client.CreateIpReputationRule(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

OK

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.