文档首页/ 云防火墙 CFW/ API参考/ API/ 流量过滤/ 开启或者关闭流量过滤的IP黑名单功能
更新时间:2025-08-12 GMT+08:00

开启或者关闭流量过滤的IP黑名单功能

功能介绍

开启或者关闭流量过滤功能,当前流量过滤是通过导入IP黑名单实现的。

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/ptf/ip-blacklist/switch

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,可以通过调用API获取,也可以从控制台获取。项目ID获取方式

表2 Query参数

参数

是否必选

参数类型

描述

fw_instance_id

String

防火墙ID,可通过防火墙ID获取方式获取

请求参数

表3 请求Body参数

参数

是否必选

参数类型

描述

status

Integer

打开或关闭IP黑名单功能 0:disable 1:enable

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data

Object

导入数据

请求示例

关闭project id为eefb11b22d5944f2aa067954516df1cf、instance id为e494f486-fa6f-410e-9cfa-8edacfb28970上的IP黑名单功能

https://{Endpoint}/v1/eefb11b22d5944f2aa067954516df1cf/ptf/ip-blacklist/switch?fw_instance_id=e494f486-fa6f-410e-9cfa-8edacfb28970

请求body体:
{
}

响应示例

SDK代码示例

SDK代码示例如下。

关闭project id为eefb11b22d5944f2aa067954516df1cf、instance id为e494f486-fa6f-410e-9cfa-8edacfb28970上的IP黑名单功能

 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 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.cfw.v1.region.CfwRegion;
import com.huaweicloud.sdk.cfw.v1.*;
import com.huaweicloud.sdk.cfw.v1.model.*;


public class EnableIpBlacklistSolution {

    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);

        CfwClient client = CfwClient.newBuilder()
                .withCredential(auth)
                .withRegion(CfwRegion.valueOf("<YOUR REGION>"))
                .build();
        EnableIpBlacklistRequest request = new EnableIpBlacklistRequest();
        try {
            EnableIpBlacklistResponse response = client.enableIpBlacklist(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());
        }
    }
}

关闭project id为eefb11b22d5944f2aa067954516df1cf、instance id为e494f486-fa6f-410e-9cfa-8edacfb28970上的IP黑名单功能

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcfw.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 = CfwClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CfwRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = EnableIpBlacklistRequest()
        response = client.enable_ip_blacklist(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

关闭project id为eefb11b22d5944f2aa067954516df1cf、instance id为e494f486-fa6f-410e-9cfa-8edacfb28970上的IP黑名单功能

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/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 := cfw.NewCfwClient(
        cfw.CfwClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

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

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

状态码

状态码

描述

200

打开或者关闭IP黑名单功能返回成功的响应,内部字段没有赋值。

401

Unauthorized,错误的请求

403

Forbidden,禁止访问

错误码

请参见错误码