文档首页/ 云防火墙 CFW/ API参考 (联盟区域) / API/ 防火墙管理/ 查询防火墙列表
更新时间：2025-12-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询防火墙列表

功能介绍

查询防火墙列表

URI

POST /v1/{project_id}/firewalls/list

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

Content-Type

是

String

内容类型，只有application/json的值是适用的
表4 请求Body参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

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

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，true表示是，false表示不是，NDR为原旁路版防火墙，现已停止售卖。

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，默认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）和集群（1）两种方式，主备模式包含四个节点，2个主节点构成集群，剩余两个节点为主节点的备节点，集群模式仅拉起两个节点作为集群。

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

防火墙版本，1：专业版

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，默认为0

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

查询防火墙列表返回值

{
  "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
}

状态码

状态码

描述

200

查询防火墙列表返回值

错误码

请参见错误码。

父主题： 防火墙管理