文档首页/ 云防火墙 CFW/ API参考/ API/ 流量过滤/ 获取导入的IP黑名单列表信息
更新时间:2025-08-12 GMT+08:00

获取导入的IP黑名单列表信息

功能介绍

获取防火墙实例中已经导入的IP黑名单信息,标准版防火墙只会显示一条EIP的记录,专业版防火墙可能显示EIP、NAT或EIP和NAT的记录,根据导入的情况确定。

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/ptf/ip-blacklist

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

fw_instance_id

String

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

limit

Integer

在分页查询的情况下,每页查询的记录条数,范围为1-1024

offset

Integer

数据查询的偏移量,在分页查询的时候使用,指定查询记录的起始位置,必须为数字,取值范围为大于等于0

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

data

PageDataIpBlacklistsVo object

查询IP黑名单列表信息的HTTP响应

表4 PageDataIpBlacklistsVo

参数

参数类型

描述

limit

Integer

一次查询返回的记录条数,调用接口时赋值

offset

Integer

本次查询结果返回后下次查询的偏移

records

Array of IpBlacklistVO objects

查询出的IP黑名单列表信息

total

Integer

防火墙实例中IP黑名单的总数

表5 IpBlacklistVO

参数

参数类型

描述

name

String

IP黑名单的文件名,对应导出时的文件名

effect_scope

Array of integers

IP黑名单的生效范围,1表示EIP,2表示NAT

import_status

Integer

IP黑名单的导入状态,有三种状态:2:生成中、1:成功、0:失败。

import_time

Long

IP黑名单的导入时间

error_message

String

导入失败的错误信息

请求示例

查询项目ID为eefb11b22d5944f2aa067954516df1cf,防火墙实例ID为812f478c-940e-4e00-824f-7287250d76dc的防火墙上已经导入的IP黑名单列表信息。

https://{Endpoint}/v1/eefb11b22d5944f2aa067954516df1cf/ptf/ip-blacklist?fw_instance_id=812f478c-940e-4e00-824f-7287250d76dc&limit=50&offset=0

响应示例

状态码:200

查询成功的示例:
{
  "data": {
    "limit": 50,
    "offset": 0,
    "records": [
      {
        "name": "ip-blacklist-eip.txt",
        "effect_scope": [
          1 ],
        "import_status": 1,
        "import_time": 1740995060000,
        "error_message": "time out"
      }
    ],
    "total": 1
  }
}

SDK代码示例

SDK代码示例如下。

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

    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();
        ListIpBlacklistRequest request = new ListIpBlacklistRequest();
        try {
            ListIpBlacklistResponse response = client.listIpBlacklist(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
# 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 = ListIpBlacklistRequest()
        response = client.list_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)
 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.ListIpBlacklistRequest{}
	response, err := client.ListIpBlacklist(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

401

Unauthorized,错误的请求

403

Forbidden,禁止访问

错误码

请参见错误码