文档首页/虚拟私有云 VPC/API参考/API V3/网络ACL/查询网络ACL列表
更新时间：2025-02-07 GMT+08:00
查看PDF
分享

查询网络ACL列表

功能介绍

查询网络ACL列表。

URI

GET /v3/{project_id}/vpc/firewalls

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

获取方式请参见获取项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

  • 功能说明：每页返回的个数。

  • 取值范围：0~2000。

marker

否

String

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

id

否

Array of strings

  • 功能说明：网络ACL唯一标识，填写后接口按照id进行过滤，支持多id同时过滤。

name

否

Array of strings

  • 功能说明：ACL名称，填写后按照名称进行过滤，支持多名称同时过滤。

status

否

String

  • 功能说明：ACL的状态，填写后按照状态进行过滤。

admin_state_up

否

Boolean

  • 功能说明：ACL管理状态，填写后按照管理状态进行过滤。

enterprise_project_id

否

Array of strings

  • 功能说明：企业项目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唯一标识。

  • 取值范围：合法UUID的字符串。

name

String

  • 功能说明：ACL名称。

  • 取值范围：0-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）。

description

String

  • 功能说明：ACL描述信息。

  • 取值范围：0-255个字符。

  • 约束：不能包含“<”和“>”。

project_id

String

  • 功能说明：资源所属项目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的状态。

enterprise_project_id

String

  • 功能说明：ACL企业项目ID。

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

tags

Array of ResourceTag objects

  • 功能描述：ACL资源标签。

associations

Array of FirewallAssociation objects

  • 功能说明：ACL绑定的子网列表。

表5 ResourceTag

参数

参数类型

描述

key

String

  • 功能说明：标签键。

  • 约束：同一资源的key值不能重复。

最小长度：1

最大长度：128

value

String

  • 功能说明：标签值。

最大长度：255

表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操作正常返回，更多状态码请参见状态码。

错误码

请参见错误码。

父主题：网络ACL