DescribeVpcFirewallAclRuleList - 查询VPC边界防火墙访问控制策略列表--云防火墙-火山引擎

文档中心

立即注册

导航

DescribeVpcFirewallAclRuleList - 查询VPC边界防火墙访问控制策略列表

最近更新时间：2025.05.29 17:45:46首次发布时间：2024.03.28 17:09:34

查询VPC边界防火墙访问控制策略列表。

请求说明

请求方式：POST
请求地址：https://fw_center.volcengineapi.com/?Action=DescribeVpcFirewallAclRuleList&Version=2021-09-06

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeVpcFirewallAclRuleList`	接口名称。当前 API 的名称为 `DescribeVpcFirewallAclRuleList`。
Version	String	是	`2021-09-06`	接口版本。当前 API 的版本为 `2021-09-06`。

Body

参数	类型	是否必选	示例值	描述
Action	Array of String	否	`accept`	查询条件，精确查询。策略动作： accept - 放行 deny - 阻断 monitor - 观察
Description	String	否	`允许来自10.0.0.0/8的HTTP流量`	访问控制策略的描述信息，支持模糊查询。
Destination	String	否	`10.0.0.0/0`	目的地址，支持模糊查询。用于匹配访问控制策略中的目标网络地址或地址范围。
PageNumber	Integer	否	`1`	分页页码，默认值为`1`。
PageSize	Integer	否	`10`	分页大小，表示每页返回的记录数，默认值为 `10`。
Proto	Array of String	否	`ICMP`	查询条件，精确查询。协议类型： ICMP TCP UDP ANY(任何协议)
RepeatType	Array of String	否	`Once`	查询条件，精确查询。重复类型： Permanent - 始终生效 Once - 单次生效 Daily - 每日重复 Weekly - 每周重复 Monthly - 每月重复
RuleId	String	否	`f04ac7ce-**---**********`	访问控制策略唯一标识 ID，获取方式可参考DescribeVpcFirewallAclRuleList - 查询VPC边界流量控制网关规则列表。
Source	String	否	`10.0.0.0/8`	源地址，支持模糊查询。用于匹配访问控制策略中的来源网络地址或地址范围。
Status	Array of Boolean	否	`false`	访问控制策略的开关状态，用于精确查询策略是否启用。 `true`：开启； `false`：关闭。
VpcFirewallId	String	是	`vfw-********`	VPC边界防火墙实例ID，获取方式可参考DescribeVpcFirewallList - 查询 VPC 边界防火墙实例列表。

返回参数

参数	类型	示例值	描述
Count	Integer	`1`	返回数据的实际数量，当查询数据为空且使用 `Python SDK` 调用时此项为 `None`。
Data	Array of VpcFwRuleDetail	`--`	列表详情。
PageNumber	Integer	`1`	返回数据的分页页码，表示当前查询结果所在的页码。
PageSize	Integer	`10`	分页大小，表示每页返回的记录数，默认值为 `10`。
TotalCount	Integer	`100`	返回数据的总数量，当查询数据为空且使用 `Python SDK` 调用时此项为 `None`。

VpcFwRuleDetail

参数	类型	示例值	描述
Prio	Integer	`1`	访问控制策略的优先级，数值越小优先级越高。
Proto	String	`ICMP`	访问控制策略的协议类型，表示该策略适用的网络协议。
Action	String	`accept`	策略动作 accept：放行 deny：阻断 monitor：观察
HitCnt	Integer	`70`	访问控制策略的命中计数，表示该策略被匹配并执行的次数。数值越大表示该策略的使用频率越高。
RuleId	String	`f04ac7ce-******`	访问控制策略的唯一标识符，用于在系统中唯一标识一条策略规则。该 ID 通常由系统自动生成，格式为 UUID。
Source	String	`192.168.0.1/32`	访问控制策略的源地址，具体取值取决于 `SourceType` 字段的类型：当 `SourceType` 为 `net` 时，源地址为 `CIDR` 格式的 `IP` 地址段，例如 `192.0.XX.XX/24`；当 `SourceType` 为 `group` 时，源地址为源地址簿的 `UUID` 列表，例如 `f04ac7ce-**---**********`。
Status	Boolean	`false`	访问控制策略的开关状态，表示该策略是否处于启用状态。 `true`：策略启用； `false`：策略禁用。
EndTime	Integer	`1727247865`	访问控制策略的结束生效时间，采用 Unix 时间戳格式表示，单位为秒。该时间戳表示策略规则停止生效的具体时间点。
DestPort	String	`22/22`	访问控制策略的目的端口，具体取值取决于 `DestPortType` 字段的类型：当 `DestPortType` 为 `port` 时，取值为端口范围；当 `DestPortType` 为 `group` 时，取值为端口地址簿的 `UUID` 列表。
UseCount	Integer	`100`	访问控制策略的规则占用数，表示该策略被引用的次数。数值越大表示该策略被其他规则或配置引用的频率越高。
AccountId	String	`21000*****`	账号的唯一标识符，用于区分不同的用户账号。
StartTime	Integer	`1727247865`	访问控制策略的开始生效时间，采用 Unix 时间戳格式表示，单位为秒。该时间戳表示策略规则开始生效的具体时间点。
IsEffected	Boolean	`true`	表示访问控制策略是否生效的状态。 `true`：策略已生效； `false`：策略未生效。
RepeatDays	Array of Integer	`[1,3,5]`	访问控制策略的重复生效日期列表，表示策略规则在哪些日期重复生效。日期采用数字表示，例如 `1` 表示星期一，`7` 表示星期日。
RepeatType	String	`Permanent`	重复类型，用于指定策略生效的时间周期。 `Permanent`：始终生效； `Once`：单次生效； `Daily`：每日重复； `Weekly`：每周重复； `Monthly`：每月重复。
SourceType	String	`group`	源地址类型，用于指定访问控制策略中源地址的格式和来源。 `net`：源网段（CIDR 格式）； `group`：源地址簿（UUID 格式）； `location`：源区域（区域代码格式）。
UpdateTime	Integer	`1714298363`	访问控制策略的更新时间，表示该策略最后一次被修改的时间戳。
Description	String	`允许来自特定IP段的入站SSH访问`	访问控制策略的描述信息，用于记录该策略的用途、备注或其他相关信息。
Destination	String	`192.168.1.2/32`	访问控制策略的目的地址，具体取值取决于 `DestinationType` 字段的类型：当 `DestinationType` 为 `net` 时，目的地址为 `CIDR` 格式的 `IP` 地址段，例如 `192.168.1.2/32`；当 `DestinationType` 为 `group` 时，目的地址为目的地址簿的 `UUID` 列表，例如 `f04ac7ce-**---********`；当 `DestinationType` 为 `domain` 时，目的地址为目的域名，例如 `****.com`。
DestPortList	Array of String	`["22/22","80/80","443/443"]`	访问控制策略的目的端口列表，表示该策略适用的目标端口范围。当 `DestPortType` 为 `port` 时，列表中的每个元素表示一个端口或端口范围；当 `DestPortType` 为 `group` 时，列表中的每个元素表示一个端口地址簿的 `UUID`。
DestPortType	String	`port`	目的端口类型，用于指定访问控制策略中目的端口的格式和来源。 `port`：端口或端口范围； `group`：端口地址簿（UUID 格式）。
EffectStatus	Integer	`3`	访问控制策略的生效状态，取值如下所示。 `1`：未生效； `2`：下发中； `3`：已生效。
RepeatEndTime	String	`2024-09-10 12:00`	访问控制策略的重复生效结束时间，格式为 `YYYY-MM-DD HH:MM`。该时间表示策略规则重复生效的截止日期和时间点。
VpcFirewallId	String	`vfw-********`	VPC 边界防火墙实例 ID，获取方式可参考DescribeVpcFirewallList - 查询 VPC 边界防火墙实例列表。
SourceCidrList	Array of String	`["192.168.0.1/24","10.0.0.1/32"]`	访问控制策略的源地址列表，表示该策略适用的源 `IP` 地址或地址段。当 `SourceType` 为 `net` 时，列表中每个元素表示一个 `CIDR` 格式的 `IP` 地址段；当 `SourceType` 为 `group` 时，列表中每个元素表示一个源地址簿的 `UUID`。
DestinationType	String	`net`	目的地址类型，用于指定访问控制策略中目的地址的格式和来源。 `net`：目的网段（CIDR 格式）； `group`：目的地址簿（UUID 格式）； `domain`：目的域名。
RepeatStartTime	String	`2024-09-10 11:00`	访问控制策略的重复生效开始时间，格式为 `YYYY-MM-DD HH:MM`。该时间表示策略规则重复生效的起始日期和时间点。
SourceGroupType	String	`ip`	源地址簿的类型，用于指定访问控制策略中源地址簿的具体分类。
VpcFirewallName	String	`vfw-example-name`	VPC 边界防火墙实例的名称，用于标识和区分不同的防火墙实例。
DestPortGroupType	String	`port`	目的端口簿的类型，用于指定访问控制策略中目的端口簿的具体分类。
DestinationCidrList	Array of String	`192.168.0.1`	目的地址列表
DestinationGroupType	String	`ip`	目的地址簿的类型，用于指定访问控制策略中目的地址簿的具体分类。

请求示例

POST https://fw_center.volcengineapi.com/?Action=DescribeVpcFirewallAclRuleList&Version=2021-09-06
{
    "PageNumber": 1,
    "PageSize": 10,
    "VpcFirewallId": "vfw-ydj89tnitcvebxuh****"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "DescribeVpcFirewallAclRuleList",
        "Region": "cn-beijing",
        "Service": "fw_center",
        "Version": "2021-09-06",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "TotalCount": 1,
        "PageSize": 10,
        "PageNumber": 1,
        "Count": 1,
        "Data": [
            {
                "AccountId": "210005****",
                "Direction": "",
                "RuleId": "6e73c068-c36f-45ca-a2d4-00c016ac****",
                "Prio": 1,
                "Proto": "TCP",
                "Action": "deny",
                "Status": false,
                "HitCnt": 5,
                "LastHitTime": 1732265972,
                "Description": "",
                "Source": "0.0.0.0/0",
                "SourceType": "net",
                "SourceGroupType": "",
                "Destination": "192.168.**.**",
                "DestinationType": "net",
                "DestinationGroupType": "",
                "DestPort": "80",
                "DestPortType": "port",
                "DestPortGroupType": "",
                "SourceCidrList": [
                    "0.0.0.0/0"
                ],
                "SourceGroupList": null,
                "DestinationCidrList": [
                    "192.168.**.**"
                ],
                "DestinationGroupList": null,
                "DestPortList": [
                    "80"
                ],
                "DestPortGroupList": null,
                "UseCount": 1,
                "IsEffected": true,
                "EffectStatus": 3,
                "RepeatType": "Permanent",
                "StartTime": 0,
                "EndTime": 0,
                "RepeatStartTime": "",
                "RepeatEndTime": "",
                "RepeatDays": [],
                "UpdateTime": 1732371409
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。