文档首页/ 云防火墙 CFW/ API参考/ API/ ACL规则管理/ 查询防护规则
更新时间：2025-05-26 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询防护规则

功能介绍

查询防护规则

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/acl-rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以从调API处获取，也可以从控制台获取。项目ID获取方式

约束限制：

不涉及

取值范围：

32位UUID

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

object_id

是

String

参数解释：

防护对象ID，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志ID，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得

约束限制：

type为0时，object_id为互联网边界防护对象ID，type为1时，object_id为VPC边界防护对象ID，type可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得

取值范围：

32位UUID

默认取值：

不涉及

type

否

Integer

参数解释：

规则类型，用于区分不同防护对象设置规则类型。

约束限制：

不涉及

取值范围：

0：互联网边界规则，源（source）和目的（destination）地址需要为公网IP或域名；

1：VPC间规则，源（source）和目的（destination）地址需要为私有ip；

2：NAT规则，源（source）地址需要为私网IP，目的地址为公网IP或域名。

默认取值：

不涉及

ip

否

String

参数解释：

IP地址信息

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

name

否

String

参数解释：

规则名称，由用户定义，用于标识规则

约束限制：

字符串长度为0到255

取值范围：

不涉及

默认取值：

不涉及

direction

否

Integer

参数解释：

规则方向，用于指定规则是从云上至云下，还是云下至云上

约束限制：

当规则type=0（互联网规则）或者type= 2（nat规则）时方向值必填

取值范围：

0表示外到内（云下到云上），1表示内到外（云上到云下），

默认取值：

不涉及

status

否

Integer

参数解释：

规则启用状态，用于区分规则是否启用

约束限制：

仅能使用数字0和1

取值范围：

0表示启用，1表示禁用

默认取值：

不涉及

action_type

否

Integer

参数解释：

规则动作类型，用于区分规则对流量的动作

约束限制：

仅能使用数字0和1

取值范围：

0表示允许通行（permit），1表示拒绝通行（deny）

默认取值：

不涉及

address_type

否

Integer

参数解释：

IP地址的互联网协议类型，用于指定IP地址的互联网协议，由客户指定

约束限制：

不涉及

取值范围：

0表示IPv4，1表示IPv6

默认取值：

不涉及

limit

是

Integer

参数解释：

每页显示个数

约束限制：

必须为数字

取值范围：

1-1024

默认取值：

不涉及

offset

是

Integer

参数解释：

偏移量：指定返回记录的开始位置

约束限制：

必须为数字

取值范围：

大于或等于0

默认取值：

不涉及

enterprise_project_id

否

String

参数解释：

企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，配置后可根据企业项目过滤不同企业项目下的资产，可通过如何获取企业项目ID获取

约束限制：

不涉及

取值范围：

不涉及

默认取值：

0

fw_instance_id

否

String

参数解释：

防火墙ID，用户创建防火墙实例后产生的唯一ID，配置后可区分不同防火墙，可通过防火墙ID获取方式获取

约束限制：

不涉及

取值范围：

32位UUID

默认取值：

不涉及

tags_id

否

String

参数解释：

规则标签id，创建规则时产生。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

source

否

String

参数解释：

源地址。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

destination

否

String

参数解释：

目的地址。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

service

否

String

参数解释：

服务端口

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

application

否

String

参数解释：

规则应用协议列表

约束限制：

不涉及

取值范围：

规则应用类型包括：“HTTP”，"HTTPS"，"TLS1"，“DNS”，“SSH”，“MYSQL”，“SMTP”，“RDP”，“RDPS”，“VNC”，“POP3”，“IMAP4”，“SMTPS”，“POP3S”，“FTPS”，“ANY”，“BGP”等。

默认取值：

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token，用于携带用户身份信息，配置后可通过接口鉴权，可通过如何获取用户Token获取。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

data

data object

参数解释：

查询规则列表返回值数据
表5 data

参数

参数类型

描述

offset

Integer

参数解释：

偏移量：指定返回记录的开始位置

取值范围：

大于或等于0

limit

Integer

参数解释：

每页显示个数

取值范围：

1-1024

total

Integer

参数解释：

查询规则列表总条数

取值范围：

大于0

object_id

String

参数解释：

防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，type为0时，object_id为互联网边界防护对象ID，type为1时，object_id为VPC边界防护对象ID，type可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得

取值范围：

32位UUID

up_rules_count

Integer

参数解释：

顶部规则数量

取值范围：

不涉及

records

Array of records objects

参数解释：

查询规则列表记录
表6 records

参数

参数类型

描述

rule_id

String

参数解释：

规则ID

取值范围：

不涉及

order_id

Integer

参数解释：

排序id

取值范围：

不涉及

applications

Array of strings

参数解释：

应用列表

取值范围：

不涉及

address_type

Integer

参数解释：

地址类型0 IPv4，1 IPv6

取值范围：

不涉及

name

String

参数解释：

规则名称

取值范围：

不涉及

direction

Integer

参数解释：

规则方向

取值范围：

0：外到内1：内到外

action_type

Integer

参数解释：

规则动作类型，用于区分规则对流量的动作

取值范围：

0表示允许通行（permit），1表示拒绝通行（deny）

status

Integer

参数解释：

规则启用状态，用于区分规则是否启用

取值范围：

0表示启用，1表示禁用

description

String

参数解释：

规则描述，用于描述规则的用途。

取值范围：

不涉及

long_connect_time

Long

参数解释：

长连接时长（s）。

取值范围：

1-86400000。

long_connect_enable

Integer

参数解释：

用于表示是否支持长连接。

取值范围：

0表示不支持，1表示支持

long_connect_time_hour

Long

参数解释：

长连接时长对应小时数（h）。

取值范围：

0-24000。

long_connect_time_minute

Long

参数解释：

长连接时长对应分钟数（min）。

取值范围：

0-60。

long_connect_time_second

Long

参数解释：

长连接时长对应秒数（s）。

取值范围：

0-60。

source

RuleAddressDtoForResponse object

参数解释：

源地址对象。

destination

RuleAddressDtoForResponse object

参数解释：

目的地址对象。

service

RuleServiceDtoForResponse object

参数解释：

目的地址对象

type

Integer

参数解释：

规则类型，用于区分不同防护对象设置规则类型。

取值范围：

0：互联网边界规则，源（source）和目的（destination）地址需要为公网IP或域名；

1：VPC间规则，源（source）和目的（destination）地址需要为私有ip；

2：NAT规则，源（source）地址需要为私网IP，目的地址为公网IP或域名。

created_date

String

参数解释：

规则创建时间。

取值范围：

不涉及

modified_date

String

参数解释：

规则修改时间。

取值范围：

不涉及

last_open_time

String

参数解释：

规则最后开启时间。

取值范围：

不涉及

tag

TagsVO object

参数解释：

规则附带标签对象。
表7 RuleAddressDtoForResponse

参数

参数类型

描述

type

Integer

参数解释：

地址输入类型，用于区分不同的输入类型

约束限制：

不涉及

取值范围：

0手动输入，1关联IP地址组，2域名，3地理位置，4域名组，5多对象，6域名组-网络型，7域名组-应用型。

默认取值：

不涉及

address_type

Integer

参数解释：

IP地址互联网协议类型，用于区分不同互联网协议

约束限制：

不涉及

取值范围：

地址类型0 IPv4，1 IPv6。

默认取值：

不涉及

address

String

参数解释：

IP地址信息，用于明确规则IP地址

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

address_set_id

String

参数解释：

关联IP地址组ID，用于明确规则IP地址组id，可通过查询地址组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

address_set_name

String

参数解释：

关联IP地址组名称，用于明确规则IP地址组名称，可通过查询地址组列表接口查询获得，通过返回值中的data.records.name（.表示各对象之间层级的区分）获得。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

domain_address_name

String

参数解释：

域名名称或引用域名组名称，用于明确规则引用域名或域名组名称

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

region_list_json

String

参数解释：

规则地域列表json值，用于明确规则引用地域名称列表

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

region_list

Array of IpRegionDto objects

参数解释：

规则地域列表传输值

约束限制：

不涉及

domain_set_id

String

参数解释：

域名组id，用于明确规则引用域名组。可通过查询域名组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

domain_set_name

String

参数解释：

域名组名称，用于明确规则引用域名组。可通过查询域名组列表接口查询获得，通过返回值中的data.records.name（.表示各对象之间层级的区分）获得。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

ip_address

Array of strings

参数解释：

IP地址列表，用于明确规则引用IP地址列表。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

address_group

Array of strings

参数解释：

地址组id列表，用于明确规则引用地址组id列表。地址组id可通过查询地址组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。查询条件中query_address_set_type需要设置为0自定义地址组。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

address_group_names

Array of AddressGroupVO objects

参数解释：

地址组名称列表

约束限制：

不涉及

address_set_type

Integer

参数解释：

地址组类型，用于明确规则引用地址组类型。

约束限制：

不涉及

取值范围：

0表示自定义地址组，1表示WAF回源IP地址组，3表示NAT64转换地址组

默认取值：

不涉及
表8 IpRegionDto

参数

参数类型

描述

region_id

String

参数解释：

区域ID，用于明确规则引用地域，可通过获取账号、IAM用户、项目、用户组、区域、委托的名称和ID获取。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

description_cn

String

参数解释：

区域中文描述，仅当区域为中国区域时使用，可通过地域信息表获取

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

description_en

String

参数解释：

区域英文描述，仅当区域为非中国区域时使用，可通过地域信息表获取。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

region_type

Integer

参数解释：

区域类型

约束限制：

不涉及

取值范围：

0表示国家，1表示省份，2表示大洲

默认取值：

不涉及
表9 AddressGroupVO

参数

参数类型

描述

address_set_type

Integer

地址组类型，0表示自定义地址组，1表示WAF回源IP地址组，2表示DDoS回源IP地址组，3表示NAT64转换地址组

name

String

关联IP地址组名称，可通过查询地址组列表接口查询获得，通过返回值中的data.records.name（.表示各对象之间层级的区分）获得。

set_id

String

关联IP地址组ID，可通过查询地址组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。
表10 RuleServiceDtoForResponse

参数

参数类型

描述

type

Integer

服务输入类型，0为手动输入类型，1为自动输入类型

protocol

Integer

协议类型：TCP为6，UDP为17，ICMP为1，ICMPV6为58，ANY为-1,手动类型不为空，自动类型为空

protocols

Array of integers

协议列表，协议类型：TCP为6，UDP为17，ICMP为1，ICMPV6为58，ANY为-1,手动类型不为空，自动类型为空

source_port

String

源端口

dest_port

String

目的端口

service_set_id

String

服务组id

service_set_name

String

服务组名称

custom_service

Array of ServiceItem objects

自定义服务

service_group

Array of strings

服务组id列表

service_group_names

Array of ServiceGroupVO objects

服务组名称列表

service_set_type

Integer

服务组类型，0表示自定义服务组，1表示常用WEB服务，2表示常用远程登录和PING，3表示常用数据库
表11 ServiceItem

参数

参数类型

描述

protocol

Integer

参数解释：

协议类型，用于明确规则网络协议

约束限制：

RuleServiceDto.type为0时，此处不能为空。

取值范围：

TCP为6，UDP为17，ICMP为1，ICMPv6为58，Any为-1

默认取值：

不涉及

source_port

String

参数解释：

源端口，会话发起方的端口。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

dest_port

String

参数解释：

目的端口，会话接收方的端口。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

description

String

参数解释：

服务（协议、源端口、目的端口）成员

约束限制：

字符串长度0-255

取值范围：

不涉及

默认取值：

不涉及

name

String

参数解释：

服务（协议、源端口、目的端口）成员

约束限制：

字符串长度0-255

取值范围：

不涉及

默认取值：

不涉及
表12 ServiceGroupVO

参数

参数类型

描述

name

String

参数解释：

服务（协议、源端口、目的端口）组的名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

protocols

Array of integers

参数解释：

协议列表

约束限制：

不涉及

取值范围：

协议类型：TCP为6，UDP为17，ICMP为1，ICMPv6为58，Any为-1

默认取值：

不涉及

service_set_type

Integer

参数解释：

服务（协议、源端口、目的端口）组的类型

约束限制：

不涉及

取值范围：

0表示自定义服务组，1表示预定义服务组

默认取值：

不涉及

set_id

String

参数解释：

服务组ID，可通过获取服务组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表13 TagsVO

参数

参数类型

描述

tag_id

String

参数解释：

规则ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

tag_key

String

参数解释：

规则标签键

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

tag_value

String

参数解释：

规则标签值

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

状态码：400

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

查询项目id为9d80d070b6d44942af73c9c3d38e0429，防护对象id为e12bd2cd-ebfc-4af7-ad6f-ebe6da398029的第一页，limit为10的数据

示例URL https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rules?object_id=e12bd2cd-ebfc-4af7-ad6f-ebe6da398029&limit=10&offset=0

响应示例

状态码：200

查询规则列表返回值

{
  "data" : {
    "limit" : 10,
    "object_id" : "cfebd347-b655-4b84-b938-3c54317599b2",
    "offset" : 0,
    "records" : [ {
      "action_type" : 0,
      "address_type" : 0,
      "destination" : {
        "address" : "0.0.0.0/0",
        "address_type" : 0,
        "type" : 0
      },
      "direction" : 1,
      "long_connect_enable" : 0,
      "created_date" : "2024-02-27 04:01:17",
      "modified_date" : "2024-02-27 04:01:17",
      "last_open_time" : "2024-02-27 04:01:17",
      "description" : "description",
      "name" : "eip_ipv4_n_w_allow",
      "rule_id" : "ffe9af47-d893-483b-86e3-ee5242e8cb15",
      "order_id" : 1000000,
      "service" : {
        "dest_port" : "0",
        "protocol" : -1,
        "source_port" : "0",
        "type" : 0
      },
      "source" : {
        "address_set_id" : "48bfb09b-6f3a-4371-8ddb-05d5d7148bcc",
        "address_set_name" : "ip_group",
        "address_type" : 0,
        "type" : 1
      },
      "status" : 1,
      "type" : "0"
    } ],
    "total" : 1,
    "up_rules_count" : 0
  }
}

状态码：400

Bad Request，错误的请求

{
  "error_code" : "CFW.0020016",
  "error_msg" : "实例状态错误"
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.cfw.v1.region.CfwRegion;
import com.huaweicloud.sdk.cfw.v1.*;
import com.huaweicloud.sdk.cfw.v1.model.*;


public class ListAclRulesSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        CfwClient client = CfwClient.newBuilder()
                .withCredential(auth)
                .withRegion(CfwRegion.valueOf("<YOUR REGION>"))
                .build();
        ListAclRulesRequest request = new ListAclRulesRequest();
        try {
            ListAclRulesResponse response = client.listAclRules(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcfw.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = CfwClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CfwRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListAclRulesRequest()
        response = client.list_acl_rules(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := cfw.NewCfwClient(
        cfw.CfwClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListAclRulesRequest{}
	response, err := client.ListAclRules(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

查询规则列表返回值

400

Bad Request，错误的请求

401

Unauthorized，错误的请求

403

Forbidden，禁止访问

404

Not Found，网页未找到

500

Internal Server Error

错误码

请参见错误码。

父主题： ACL规则管理

相关文档

    OSZAR »