更新时间:2025-08-12 GMT+08:00

查询防火墙列表

功能介绍

查询防火墙列表

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/firewalls/list

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。项目ID获取方式

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释

企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,可通过如何获取企业项目ID获取,用户未开启企业项目时为0

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。可通过如何获取用户Token获取。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释

企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,可通过如何获取企业项目ID获取,用户未开启企业项目时为0

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

key_word

String

参数解释

查询关键字,可为防火墙ID或防火墙名称的一部分。可通过防火墙ID获取方式获取

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

tags

Array of TagInfo objects

参数解释

标签列表,可通过查询标签服务查询标签接口获得,返回值即为标签列表

约束限制

不涉及

limit

Integer

参数解释

每页显示个数

约束限制

不涉及

取值范围

1-1024

默认取值

不涉及

offset

Integer

参数解释

偏移量:指定返回记录的开始位置

约束限制

不涉及

取值范围

大于或等于0

默认取值

0

表5 TagInfo

参数

是否必选

参数类型

描述

key

String

参数解释

标签键

约束限制

不涉及

values

Array of strings

参数解释

标签值列表

约束限制

不涉及

响应参数

状态码:200

表6 响应Body参数

参数

参数类型

描述

user_support_eps

Boolean

参数解释

是否支持企业项目

取值范围

  • true:是

  • false:否

has_ndr

Boolean

参数解释

是否存在NDR,NDR为原旁路版防火墙,现已停止售卖。

取值范围

  • true:是

  • false:不是

is_support_postpaid

Boolean

参数解释

是否支持按需购买

取值范围

  • true:是

  • false:不是

is_support_basic_version

Boolean

参数解释

是否支持基础版

取值范围

  • true:是

  • false:不是

is_support_buy_professional

Boolean

参数解释

是否支持购买专业版

取值范围

  • true:是

  • false:不是

data

HttpFirewallInstanceListResponseData object

参数解释

查询防火墙列表返回值data信息

取值范围

不涉及

表7 HttpFirewallInstanceListResponseData

参数

参数类型

描述

limit

Integer

参数解释

每页显示个数

约束限制

不涉及

取值范围

1-1024

offset

Integer

参数解释

偏移量:指定返回记录的开始位置

约束限制

不涉及

取值范围

大于或等于0

project_id

String

参数解释

租户项目ID

约束限制

不涉及

total

Integer

参数解释

防火墙总数量

约束限制

不涉及

records

Array of FirewallInstanceVO objects

参数解释

查询防火墙列表记录

约束限制

不涉及

表8 FirewallInstanceVO

参数

参数类型

描述

fw_instance_id

String

参数解释

防火墙实例id,创建云防火墙后用于标记防火墙由系统自动生成的id。

约束限制

不涉及

resource_id

String

参数解释

资源id,与防火墙实例id fw_instance_id相同。

约束限制

不涉及

name

String

参数解释

创建防火墙时的时间戳

约束限制

不涉及

fw_instance_name

String

参数解释

防火墙名称

约束限制

不涉及

enterprise_project_id

String

参数解释

企业项目id,用户支持企业项目后,由企业项目生成的id。

约束限制

不涉及

ha_type

Integer

参数解释

集群类型

约束限制

不涉及

取值范围

  • 0:主备模式,包含四个节点,2个主节点构成集群,剩余两个节点为主节点的备节点

  • 1:集群模式,仅拉起两个节点作为集群

charge_mode

Integer

参数解释

计费模式

约束限制

不涉及

取值范围

  • 0:包年/包月

  • 1:按需

默认取值

不涉及

service_type

Integer

参数解释

防火墙防护类型

约束限制

不涉及

取值范围

目前仅支持0,互联网防护

engine_type

Integer

参数解释

引擎类型

约束限制

不涉及

取值范围

  • 0:自研引擎

  • 1:山石引擎

  • 3:天融信引擎

flavor

Flavor object

参数解释

防火墙规格信息

约束限制

不涉及

status

Integer

参数解释

防火墙状态列表

约束限制

不涉及

取值范围

  • -1:等待支付

  • 0:创建中

  • 1,删除中

  • 2:运行中

  • 3:升级中

  • 4:删除完成

  • 5:冻结中

  • 6:创建失败

  • 7:删除失败

  • 8:冻结失败

  • 9:存储中

  • 10:存储失败

  • 11:升级失败

tags

String

参数解释

标签列表,标签键值map转化的json字符串,如"{"key":"value"}"

约束限制

不涉及

表9 Flavor

参数

参数类型

描述

version

Integer

参数解释

防火墙版本

取值范围

  • 0:标准版

  • 1:专业版

  • 3:基础版,

eip_count

Integer

参数解释

EIP数量

取值范围

不涉及

vpc_count

Integer

参数解释

VPC数量

取值范围

不涉及

bandwidth

Integer

参数解释

带宽,单位为mbps

取值范围

不涉及

log_storage

Integer

参数解释

日志存储,单位为byte

取值范围

不涉及

default_bandwidth

Integer

参数解释

默认防火墙带宽,单位为mbps

取值范围

包周期标准版为10,专业版为50,按需专业版为200

default_eip_count

Integer

参数解释

默认eip数

取值范围

包周期标准版为20,专业版为50,按需专业版为1000

default_log_storage

Integer

参数解释

默认日志存储,单位为byte

取值范围

不涉及

default_vpc_count

Integer

参数解释

默认vpc数

约束限制

包周期标准版为0,专业版为2,按需专业版为5

请求示例

查询项目id为14181c1245cf4fd786824efe1e2b9388,企业项目id为all_granted_eps的第一页的防火墙列表

https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/firewalls/list?enterprise_project_id=all_granted_eps

{
  "limit" : 10,
  "offset" : 0
}

响应示例

状态码:200

OK,查询防火墙列表返回值

{
  "data" : {
    "limit" : 1,
    "offset" : 0,
    "project_id" : "14181c1245cf4fd786824efe1e2b9388",
    "records" : [ {
      "fw_instance_id" : "ebf891cd-2163-48a0-9963-6309f99dd3c4",
      "resource_id" : "ebf891cd-2163-48a0-9963-6309f99dd3c4",
      "name" : "1709176078374",
      "fw_instance_name" : "test",
      "enterprise_project_id" : "default",
      "tags" : "{\"key_test3\":\"value_test3\"}",
      "ha_type" : 0,
      "charge_mode" : 0,
      "service_type" : 0,
      "engine_type" : 1,
      "flavor" : {
        "version" : 1,
        "eip_count" : 50,
        "vpc_count" : 6,
        "bandwidth" : 50,
        "log_storage" : 0,
        "default_eip_count" : 50,
        "default_vpc_count" : 2,
        "default_bandwidth" : 50,
        "default_log_storage" : 0
      },
      "status" : 2
    } ],
    "total" : 18
  },
  "has_ndr" : false,
  "is_support_basic_version" : true,
  "is_support_buy_professional" : false,
  "is_support_postpaid" : true,
  "user_support_eps" : false
}

SDK代码示例

SDK代码示例如下。

查询项目id为14181c1245cf4fd786824efe1e2b9388,企业项目id为all_granted_eps的第一页的防火墙列表

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

    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();
        ListFirewallListRequest request = new ListFirewallListRequest();
        QueryFireWallInstanceDto body = new QueryFireWallInstanceDto();
        body.withOffset(0);
        body.withLimit(10);
        request.withBody(body);
        try {
            ListFirewallListResponse response = client.listFirewallList(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为14181c1245cf4fd786824efe1e2b9388,企业项目id为all_granted_eps的第一页的防火墙列表

 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
# 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 = ListFirewallListRequest()
        request.body = QueryFireWallInstanceDto(
            offset=0,
            limit=10
        )
        response = client.list_firewall_list(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为14181c1245cf4fd786824efe1e2b9388,企业项目id为all_granted_eps的第一页的防火墙列表

 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
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.ListFirewallListRequest{}
	request.Body = &model.QueryFireWallInstanceDto{
		Offset: int32(0),
		Limit: int32(10),
	}
	response, err := client.ListFirewallList(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

OK,查询防火墙列表返回值

错误码

请参见错误码