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

文档中心

立即注册

导航

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

最近更新时间：2024.11.25 17:03:53首次发布时间：2024.03.28 17:09:34

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

请求说明

请求方式：POST
请求地址：?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	否	`Description`	查询条件，模糊查询。描述信息
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
Source	String	否	`10.0.0.0/0`	查询条件，模糊查询。源地址
Status	Array of Boolean	否	`false`	查询条件，精确查询。开关状态： true - 开启 false - 关闭
VpcFirewallId	String	是	`vfw-********`	VPC边界防火墙实例ID，获取方式可参考DescribeVpcFirewallList - 查询 VPC 边界防火墙实例列表。

返回参数

参数	类型	示例值	描述
Count	Integer	`1`	返回数据的实际数量当查询数据为空时，且使用python SDK调用时此项为None
Data	Array of VpcFwRuleStructure	`--`	列表详情。
PageNumber	Integer	`1`	返回数据的分页页码
PageSize	Integer	`1`	返回数据的分页大小
TotalCount	Integer	`1`	返回数据总数量当查询数据为空时，且使用python SDK调用时此项为None

VpcFwRuleStructure

参数	类型	示例值	描述
Prio	Integer	`1`	策略优先级。
Proto	String	`ICMP`	协议类型。
Action	String	`accept`	策略动作： accept：放行 deny：阻断 monitor：观察
HitCnt	Integer	`70`	规则命中次数。
RuleId	String	`f04ac7ce-**---**********`	访问控制策略唯一标识 ID。
Source	String	`192.168.0.1/32`	源地址。当SourceType为net时，Source为源CIDR地址。例如：180.. .1/32 当SourceType为group时，Source为源地址簿的uuid。例如：f04ac7ce----******** 当SourceType为区域时，Source为区域代码。例如：BJ11
Status	Boolean	`false`	策略启用状态。 true：开启 false：关闭
EndTime	Integer	`1727247865`	策略生效截止日期，精确到设定日期的 23:59:00。
DestPort	String	`22/22`	目的端口。当协议类型为ICMP/ALL时，取值为空当DestPortType为group时，取值为端口地址簿的uuid列表，多个地址簿通过英文逗号分隔当DestPortType为port时，取值为端口范围。
UseCount	Integer	`100`	占用策略数。
AccountId	String	`21000*****`	账号 ID。
StartTime	Integer	`1727247865`	策略生效开始日期，精确到设定日期的 00:00:00。
IsEffected	Boolean	`true`	是否生效。 true：生效 false：不生效
RepeatDays	Array of Integer	`1`	重复生效周期。
RepeatType	String	`Once`	重复类型。 Permanent：始终生效 Once：单次生效 Daily：每日重复 Weekly：每周重复 Monthly：每月重复
SourceType	String	`net`	源地址类型。 net：网段(CIDR) group：地址簿
UpdateTime	Integer	`1714298363`	更新时间。
Description	String	`description`	描述信息。
Destination	String	`192.168.1.2/32`	目的地址: 当DestinationType为net时，Destination为目的CIDR地址。例如：192.168.0.2/32 当DestinationType为group时，Destination为目的址簿的uuid。例如：f04ac7ce----****** 当DestinationType为Domain时，Destination为目的域名。例如：******.com 当DestinationType为区域时，Destination为区域代码。例如：BJ11
DestPortList	Array of String	`22/22`	目的端口组列表。
DestPortType	String	`port`	目的端口类型。 port：端口 group：端口地址簿
EffectStatus	Integer	`1`	生效状态。 1：未生效 2：下发中 3：已生效
RepeatEndTime	String	`2024-09-10 12:00`	重复生效截止时间。
VpcFirewallId	String	`vfw-********`	VPC 防火墙实例 ID。
SourceCidrList	Array of String	`192.168..`	源地址组列表。
DestinationType	String	`net`	目的地址类型。 net：目的网段(CIDR) group：目的地址簿 domain：目的域名
RepeatStartTime	String	`2024-09-10 11:00`	重复生效起始时间。
SourceGroupType	String	`ip`	源地址组类型。 ip：引用地址簿为空：未引用地址簿
VpcFirewallName	String	`VpcFirewallName`	VPC 边界防火墙实例名称。
DestPortGroupType	String	`port`	目的端口组类型。 port：引用端口地址簿为空：未引用端口地址簿
DestinationCidrList	Array of String	`192.168..`	目的地址组列表。
DestinationGroupType	String	`ip`	目的地址组类型。 ip：引用地址簿为空：未引用地址簿

请求示例

POST ?Action=DescribeVpcFirewallAclRuleList&Version=2021-09-06
Host: https://open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240711T081413Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240711/cn-beijing/fw_center/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
    "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
            }
        ]
    }
}