更新时间:2024-11-08 GMT+08:00

创建黑白名单规则

功能介绍

创建黑白名单规则

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/waf/policy/{policy_id}/whiteblackip

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,对应控制台用户名->我的凭证->项目列表->项目ID

policy_id

String

防护策略id,您可以通过调用查询防护策略列表(ListPolicy)获取策略id

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type

String

内容类型

表4 请求Body参数

参数

是否必选

参数类型

描述

name

String

规则名称只能由字母、数字、-、_和.组成,长度不能超过64个字符

addr

String

黑白名单ip地址,需要输入标准的ip地址或地址段,例如:42.123.120.66或42.123.120.0/16

description

String

黑白名单规则描述

white

Integer

防护动作:

  • 0 拦截

  • 1 放行

  • 2 仅记录

ip_group_id

String

创建的Ip地址组id,该参数与addr参数只能使用一个;Ip地址组可在控制台中对象管理->地址组管理中添加。

time_mode

String

生效模式,默认为permanent(立即生效),创建自定义生效规则时请输入:customize

start

Integer

规则生效开始时间,生效模式为自定义时,此字段才有效,请输入时间戳

terminal

Integer

规则生效结束时间,生效模式为自定义时,此字段才有效,请输入时间戳

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

id

String

规则id

name

String

黑白名单规则名称

policyid

String

策略id

addr

String

黑白名单ip地址,需要输入标准的ip地址或地址段,例如:42.123.120.66或42.123.120.0/16

white

Integer

防护动作:

  • 0 拦截

  • 1 放行

  • 2 仅记录

time_mode

String

生效模式,默认为permanent(立即生效)

start

Long

规则生效的开始时间,生效模式为自定义时,此字段才有效

terminal

Long

规则生效的结束时间,生效模式为自定义时,此字段才有效

ip_group

Ip_group object

Ip地址组

status

Integer

规则状态,0:关闭,1:开启

description

String

规则描述

timestamp

Long

创建规则的时间戳,13位毫秒时间戳

表6 Ip_group

参数

参数类型

描述

id

String

Ip地址组id,在新增Ip地址组时系统自动生成的唯一标识

name

String

Ip地址组名

size

Long

Ip地址组中包含Ip/Ip段的数量

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表8 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码: 401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表10 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码: 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表12 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

请求示例

在项目id为project_id,防护策略id为policy_id的防护策略下创建黑白名单规则,规则名称为"demo",防护动作为"拦截",描述为‘demo”,黑白名单ip地址为“x.x.x.x”。

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

{
  "name" : "demo",
  "white" : 0,
  "description" : "demo",
  "addr" : "x.x.x.x"
}

响应示例

状态码: 200

OK

{
  "id" : "5d43af25404341058d5ab17b7ba78b56",
  "policyid" : "38ff0cb9a10e4d5293c642bc0350fa6d",
  "name" : "demo",
  "timestamp" : 1650531872900,
  "description" : "demo",
  "status" : 1,
  "addr" : "x.x.x.x",
  "white" : 0
}

SDK代码示例

SDK代码示例如下。

在项目id为project_id,防护策略id为policy_id的防护策略下创建黑白名单规则,规则名称为"demo",防护动作为"拦截",描述为‘demo”,黑白名单ip地址为“x.x.x.x”。

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

    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();
        CreateWhiteblackipRuleRequest request = new CreateWhiteblackipRuleRequest();
        request.withPolicyId("{policy_id}");
        CreateWhiteBlackIpRuleRequestBody body = new CreateWhiteBlackIpRuleRequestBody();
        body.withWhite(0);
        body.withDescription("demo");
        body.withAddr("x.x.x.x");
        body.withName("demo");
        request.withBody(body);
        try {
            CreateWhiteblackipRuleResponse response = client.createWhiteblackipRule(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());
        }
    }
}

在项目id为project_id,防护策略id为policy_id的防护策略下创建黑白名单规则,规则名称为"demo",防护动作为"拦截",描述为‘demo”,黑白名单ip地址为“x.x.x.x”。

 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
# 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 = CreateWhiteblackipRuleRequest()
        request.policy_id = "{policy_id}"
        request.body = CreateWhiteBlackIpRuleRequestBody(
            white=0,
            description="demo",
            addr="x.x.x.x",
            name="demo"
        )
        response = client.create_whiteblackip_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)

在项目id为project_id,防护策略id为policy_id的防护策略下创建黑白名单规则,规则名称为"demo",防护动作为"拦截",描述为‘demo”,黑白名单ip地址为“x.x.x.x”。

 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
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.CreateWhiteblackipRuleRequest{}
	request.PolicyId = "{policy_id}"
	descriptionCreateWhiteBlackIpRuleRequestBody:= "demo"
	addrCreateWhiteBlackIpRuleRequestBody:= "x.x.x.x"
	request.Body = &model.CreateWhiteBlackIpRuleRequestBody{
		White: int32(0),
		Description: &descriptionCreateWhiteBlackIpRuleRequestBody,
		Addr: &addrCreateWhiteBlackIpRuleRequestBody,
		Name: "demo",
	}
	response, err := client.CreateWhiteblackipRule(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码