更新时间:2026-01-09 GMT+08:00

查询网络ACL列表

功能介绍

当您的网络ACL创建成功后,您可以通过调用该接口查询所有网络ACL信息,包括网络ACL的名称、状态等。

调用方法

请参见如何调用API

URI

GET /v3/{project_id}/vpc/firewalls

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

网络ACL所属的项目ID。

取值范围

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

参数解释

每页返回的资源个数。

取值范围

0~2000。

marker

String

参数解释

分页查询起始的资源ID,为空时查询第一页。

取值范围

网络ACL的资源ID。

id

Array of strings

参数解释

网络ACL的资源ID,填写后按照ID进行过滤,支持传入多个ID过滤。

取值范围

不涉及。

name

Array of strings

参数解释

网络ACL的名称,填写后按照名称进行过滤,支持传入多个名称过滤。

取值范围

不涉及。

status

String

参数解释

网络ACL的状态,表示是否已绑定至子网,填写后按照状态进行过滤。

取值范围

  • ACTIVE:过滤出已绑定子网的网络ACL。

  • INACTIVE:过滤出未绑定子网的网络ACL。

admin_state_up

Boolean

参数解释

网络ACL的管理状态,表示网络ACL处于启用还是停用状态,填写后按照管理状态进行过滤。

取值范围

  • true:过滤出开启状态的网络ACL。

  • false:过滤出关闭状态的网络ACL。

enterprise_project_id

Array of strings

参数解释

网络ACL所属的企业项目ID,可以使用该字段过滤某个企业项目下的网络ACL。

取值范围

  • 最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。“0”表示默认企业项目。

  • 若需要查询当前用户所有企业项目绑定的网络ACL,请传参all_granted_eps。

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

firewalls

Array of ListFirewallDetail objects

参数解释

查询网络ACL列表的响应体、

取值范围

不涉及。

page_info

PageInfo object

参数解释

分页信息。

取值范围

不涉及。

request_id

String

参数解释

请求ID。

取值范围

不涉及。

表4 ListFirewallDetail

参数

参数类型

描述

id

String

参数解释

网络ACL的资源ID。网络ACL创建成功后,会生成一个网络ACL ID,是网络ACL对应的唯一标识。

取值范围

带“-”的标准UUID格式。

name

String

参数解释

网络ACL的名称。

取值范围

1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)。

description

String

参数解释

网络ACL的描述信息。

取值范围

0-255个字符,不能包含“<”和“>”。

project_id

String

参数解释

网络ACL所属的项目ID。

取值范围

不涉及。

created_at

String

参数解释

网络ACL的创建时间,系统自动生成。

取值范围

UTC时间格式,yyyy-MM-ddTHH:mm:ssZ。

updated_at

String

参数解释

网络ACL的最近一次更新的时间,系统自动生成。

取值范围

UTC时间格式,yyyy-MM-ddTHH:mm:ssZ。

admin_state_up

Boolean

参数解释

网络ACL的管理状态。

取值范围

  • true:表示网络ACL处于开启状态。

  • false:表示网络ACL处于关闭状态。

status

String

参数解释

网络ACL的状态。

取值范围

  • ACTIVE:表示网络ACL已绑定子网。

  • INACTIVE:表示网络ACL未绑定子网。

enterprise_project_id

String

参数解释

网络ACL所属的企业项目ID。

取值范围

最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。“0”表示默认企业项目。

tags

Array of ResponseTag objects

参数解释

网络ACL的标签信息,包括标签键和标签值,可用来分类和标识资源。详情请参见Tag对象。

取值范围

不涉及。

associations

Array of FirewallAssociation objects

参数解释

网络ACL绑定的子网列表。

取值范围

不涉及。

表5 ResponseTag

参数

参数类型

描述

key

String

参数解释

标签键。

取值范围

  • 最大长度128个unicode字符, key不能为空。

  • 同一资源的key不能重复。

  • 可以包含的字符范围:

    • 英文字母

    • 数字

    • 特殊字符:下划线(_)、点(.)、冒号(:)、加号(+)、中划线(-)、等号(=)

value

String

参数解释

标签值。

取值范围

  • 每个值最大长度255个unicode字符,value可以为空。

  • 可以包含的字符范围:

    • 英文字母

    • 数字

    • 特殊字符:下划线(_)、冒号(:)、加号(+)、中划线(-)、等号(=)

表6 FirewallAssociation

参数

参数类型

描述

virsubnet_id

String

参数解释

网络ACL绑定的子网ID。

取值范围

  • 网络ACL的type为normal时,只支持绑定普通子网;

  • 网络ACL的type为CloudDCN时,只支持绑定CloudDCN子网。

表7 PageInfo

参数

参数类型

描述

previous_marker

String

参数解释

当前页的第一条记录。

取值范围

不涉及。

current_count

Integer

参数解释

当前页的资源总数。

取值范围

不涉及。

next_marker

String

参数解释

当前页的最后一条记录,最后一页时无next_marker字段。

取值范围

不涉及。

请求示例

查询网络ACL列表。

GET https://{Endpoint}/v3/{project_id}/vpc/firewalls

响应示例

状态码:200

GET操作正常返回,更多状态码请参见状态码

{
  "firewalls" : [ {
    "id" : "e9a7731d-5bd9-4250-a524-b9a076fd5629",
    "name" : "network_acl_test1",
    "description" : "network_acl_test1",
    "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12",
    "created_at" : "2022-04-07T07:30:46.000+00:00",
    "updated_at" : "2022-04-07T07:30:46.000+00:00",
    "admin_state_up" : true,
    "enterprise_project_id" : "158ad39a-dab7-45a3-9b5a-2836b3cf93f9",
    "status" : "ACTIVE",
    "tags" : [ ],
    "associations" : [ {
      "virsubnet_id" : "8359e5b0-353f-4ef3-a071-98e67a34a143"
    } ]
  } ]
}

状态码

状态码

描述

200

GET操作正常返回,更多状态码请参见状态码

错误码

请参见错误码