虚拟私有云 VPC虚拟私有云 VPC

更新时间:2021/08/09 GMT+08:00
分享

查询所有网络ACL规则

功能介绍

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

调试

您可以在API Explorer中直接运行调试该接口。

URI

GET /v2.0/fwaas/firewall_rules

样例:

GET https://{Endpoint}/v2.0/fwaas/firewall_rules?name={firewall_rule_name}&tenant_id={tenant_id}&public={is_public}&protocol={protocol}&ip_version={ip_version}&action={action}&enabled={is_enabled}

分页查询样例:

GET https://{Endpoint}/v2.0/fwaas/firewall_rules?limit=2&marker=2a193015-4a88-4aa1-84ad-d4955adae707&page_reverse=False

参数说明请参见表1

表1 参数说明

名称

是否必选

参数类型

说明

id

String

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

name

String

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

description

String

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

ip_version

Integer

按照网络ACL规则的IP协议版本过滤查询

取值范围:4

action

String

按照网络ACL规则的行为过滤查询

取值范围:allow or deny

enabled

Boolean

按照网络ACL规则是否使能过滤查询

取值范围:true or false

tenant_id

String

按照安全组所属的项目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条及之后的所有资源记录。

limit

Integer

分页查询每页返回的记录个数,取值范围为0~intmax。

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

请求消息

无。

响应消息

表2 响应参数

参数名称

类型

说明

firewall_rules

Array of Firewall Rule objects

firewall rule对象列表,参见表4。单次查询最多返回2000条数据,超过2000后会返回分页标记,分页查询请参见分页查询

firewall_rules_links

Array of firewall_rules_link Object

分页信息,参见表3

表3 firewall_rules_link对象

参数名称

类型

说明

href

String

API链接

rel

String

API链接与该API版本的关系

表4 Firewall Rule对象

属性

类型

说明

id

String

网络ACL规则的uuid标识。

name

String

网络ACL规则名称。

description

String

网络ACL规则描述。

tenant_id

String

项目ID

public

Boolean

是否支持跨租户共享。

protocol

String

IP协议。

source_port

String

源端口号或者一段端口范围。

destination_port

String

目的端口号或者一段端口范围。

ip_version

Integer

IP协议版本。

source_ip_address

String

源地址或者CIDR。

destination_ip_address

String

目的地址或者CIDR。

action

String

对通过网络ACL的流量执行的操作。

enabled

Boolean

是否使能网络ACL规则。

project_id

String

项目ID,请参见获取项目ID

样例

请求样例

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

响应样例

{
    "firewall_rules": [
        {
            "protocol": "tcp", 
            "name": "crhfwruleupdate", 
            "mode": "normal", 
            "tenant_id": "f480f5d250824e5fafedcf05acf1419c", 
            "rule_profile": "", 
            "enabled": true, 
            "source_port": null, 
            "source_ip_address": null, 
            "destination_ip_address": null, 
            "firewall_policy_id": "b4f81251-c47a-4fe1-8579-6f9271d015d1", 
            "action": "deny", 
            "position": 1, 
            "ip_version": 4, 
            "shared": false, 
            "destination_port": null, 
            "id": "2a193015-4a88-4aa1-84ad-d4955adae707", 
            "description": "",
            "project_id": "f480f5d250824e5fafedcf05acf1419c"
        }, 
        {
            "protocol": "tcp", 
            "name": "update_firewall-role-tommy", 
            "mode": "mix", 
            "tenant_id": "a1c6f90c94334bd2953d9a61b8031a68", 
            "rule_profile": "", 
            "enabled": false, 
            "source_port": "20:50", 
            "source_ip_address": null, 
            "destination_ip_address": null, 
            "firewall_policy_id": null, 
            "action": "deny", 
            "position": null, 
            "ip_version": 4, 
            "shared": true, 
            "destination_port": "40:60", 
            "id": "db7a204c-9eb1-40a2-9bd6-ed5cfd3cff32", 
            "description": "update check parameter",
            "project_id": "a1c6f90c94334bd2953d9a61b8031a68"
        }
    ]
}

状态码

请参见状态码

错误码

请参见错误码

分享:

    相关文档

    相关产品