文档首页/ 虚拟私有云 VPC/ API参考/ API（OpenStack Neutron V2.0 原生）/ 网络ACL/ 查询所有网络ACL组
更新时间：2024-10-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询所有网络ACL组

功能介绍

查询提交请求的租户有权限操作的所有网络ACL组信息。单次查询最多返回2000条数据，超过2000后会返回分页标记。

URI

GET /v2.0/fwaas/firewall_groups

分页查询样例：

GET https://{Endpoint}/v2.0/fwaas/firewall_groups?limit=2&marker=cd600d47-0045-483f-87a1-5041ae2f513b&page_reverse=False

参数说明请参见表1。

表1 参数说明

名称

是否必选

参数类型

说明

id

否

String

按照网络ACL组对应的ID过滤查询

name

否

String

按照网络ACL组的名称过滤查询

description

否

String

按照网络ACL组的描述过滤查询

admin_state_up

否

Boolean

按照网络ACL组的管理状态过滤查询

取值范围：true or false

tenant_id

否

String

按照网络ACL组所属的项目ID过滤查询

marker

否

String

分页查询的起始资源ID，表示从指定资源的下一条记录开始查询。

marker需要和limit配合使用：

  • 若不传入marker和limit参数，查询结果返回第一页全部资源记录。
  • 若不传入marker参数，limit为10，查询结果返回第1~10条资源记录。
  • 若marker为第10条记录的资源ID，limit为10，查询结果返回第11~20条资源记录。
  • 若marker为第10条记录的资源ID，不传入limit参数，查询结果返回第11~2000条（limit默认值2000）资源记录。

limit

否

Integer

分页查询每页返回的记录个数，取值范围为0~intmax（2^31-1），默认值2000。

limit需要和marker配合使用，详细规则请见marker的参数说明。

请求参数

无。

请求示例

GET https://{Endpoint}/v2.0/fwaas/firewall_groups

响应参数

表2 响应参数

参数名称

类型

说明

firewall_groups

Array of Firewall Group objects

firewall group对象列表。请参见表3。

firewall_groups_links

Array of firewall_groups_link objects

firewall_groups_link对象列表。请参见表4。

只有在使用limit过滤，并且资源个数超过limit或者资源个数超过2000时（limit默认值），该参数的rel和href取值才会显示为next和其对应的link。
表3 Firewall Group对象

属性

类型

说明

id

String

网络ACL组的uuid标识。

name

String

网络ACL组名称。

description

String

网络ACL组描述。

tenant_id

String

项目ID

ingress_firewall_policy_id

String

入方向网络ACL策略。

egress_firewall_policy_id

String

出方向网络ACL策略。

ports

Array of strings

网络ACL组绑定的端口列表。

public

Boolean

是否支持跨租户共享。

status

String

网络ACL组的状态。

取值范围：

  • ACTIVE：正常
  • INACTIVE：未激活
  • ERROR：错误
  • PENDING_CREATE：创建中
  • PENDING_UPDATE：更新中
  • PENDING_DELETE：删除中

admin_state_up

Boolean

网络ACL的管理状态。

project_id

String

项目ID，请参见获取项目ID。

created_at

String

资源创建时间，UTC时间

格式：yyyy-MM-ddTHH:mm:ss

updated_at

String

资源更新时间，UTC时间

格式：yyyy-MM-ddTHH:mm:ss
表4 firewall_groups_link对象

名称

参数类型

说明

href

String

API链接

rel

String

API链接与该API版本的关系

响应示例

{
    "firewall_groups": [
        {
            "status": "INACTIVE", 
            "public": false, 
            "egress_firewall_policy_id": null, 
            "name": "", 
            "admin_state_up": true, 
            "ports": [ ], 
            "tenant_id": "23c8a121505047b6869edf39f3062712", 
            "id": "cd600d47-0045-483f-87a1-5041ae2f513b", 
            "ingress_firewall_policy_id": null, 
            "description": "",
            "project_id": "23c8a121505047b6869edf39f3062712",
            "created_at": "2018-09-12T08:24:14",
            "updated_at": "2018-09-12T08:24:14"
        }, 
        {
            "status": "INACTIVE", 
            "public": false, 
            "egress_firewall_policy_id": "d939df29-fe76-4089-90c3-3778e4d53141", 
            "name": "fwg-1475475043", 
            "admin_state_up": true, 
            "ports": [ ], 
            "tenant_id": "0af57070695044ea9a70f04779e6aa1f", 
            "id": "ca971b45-70ce-4879-9734-b6cac1d00845", 
            "ingress_firewall_policy_id": "d939df29-fe76-4089-90c3-3778e4d53141", 
            "description": "",
            "project_id": "0af57070695044ea9a70f04779e6aa1f",
            "created_at": "2018-09-12T08:24:14",
            "updated_at": "2018-09-12T08:24:14"
        } 
    ],
    "firewall_groups_links": [
       {    "rel": "previous", 
            "href": "https://{Endpoint}/v2.0/fwaas/firewall_groups?marker=cd600d47-0045-483f-87a1-5041ae2f513b&page_reverse=True"
        }
    ]
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 网络ACL