AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 云防火墙 云防火墙CFW 开发参考 API参考 API目录 防护配置 访问控制 VPC边界 DescribeVpcFirewallControlPolicy - 查询指定的VPC边界防火墙的所有访问控制策略信息

DescribeVpcFirewallControlPolicy - 查询指定的VPC边界防火墙的所有访问控制策略信息

更新时间：
产品详情
我的收藏

查询指定的VPC边界防火墙的所有访问控制策略信息。

接口说明

本接口一般用于查询 VPC 边界防火墙的访问控制策略。VPC 边界防火墙防护通过云企业网连接的两个 VPC 之间的流量或防护通过高速通道连接的两个 VPC 之间的流量时，使用不同的访问控制策略。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-cloudfirewall:DescribeVpcFirewallControlPolicy

get

*VpcFirewallControlPolicy

acs:cloudfirewall::{#accountId}:vpcfirewallcontrolpolicy/{#AclUuid}

*VpcFirewall

acs:cloudfirewall::{#accountId}:vpcfirewall/{#VpcFirewallId}

 无 无

请求参数

名称

类型

必填

描述

示例值
Lang

string

否

请求和接收消息的语言类型。

取值：

  • zh（默认）：中文

  • en：英文

zh
VpcFirewallId

string

是

VPC 边界防火墙的实例 ID。取值：

  • 当 VPC 边界防火墙防护通过云企业网连接的两个 VPC 之间的流量时，该参数值使用云企业网实例 ID。

  • 当 VPC 边界防火墙防护通过高速通道连接的两个 VPC 之间的流量时，该参数值使用 VPC 边界防火墙实例 ID。

说明

您可以调用 DescribeVpcFirewallAclGroupList 接口获取该 ID。

vfw-a42bbb7b887148c9****
CurrentPage

string

否

分页查询时，设置当前页的页码。

1
PageSize

string

否

分页查询时，设置每页包含 VPC 边界防火墙的访问控制策略数量。

可设置值最大为 50。

10
Source

string

否

VPC 边界防火墙访问控制策略中的访问源地址。支持使用模糊查询。

说明

Source 可以是单个 CIDR 地址或地址簿名称。

192.0.XX.XX/24
Destination

string

否

VPC 边界防火墙访问控制策略中的目的地址。支持模糊查询。

说明

Destination 可以是单个 CIDR 地址或域名，也可以是地址薄名称。

192.0.XX.XX/24
Description

string

否

VPC 边界防火墙访问控制策略的描述信息。支持模糊查询。

test
Proto

string

否

VPC 边界防火墙访问控制策略中访问流量的协议类型。取值：

  • TCP

  • UDP

  • ICMP

  • ANY（查询所有协议类型）

说明

不设置该参数表示查询所有协议类型。

TCP
AclAction

string

否

VPC 边界防火墙访问控制策略中设置的访问流量通过云防火墙的方式（动作）。取值：

  • accept：放行

  • drop：拒绝

  • log：观察

说明

不设置该参数表示查询所有动作。

accept
MemberUid

string

否

当前阿里云账号的成员账号 UID。

258039427902****
AclUuid

string

否

VPC 边界防火墙访问控制策略的唯一标识 ID。

4037fbf7-3e39-4634-92a4-d0155247****
Release

string

否

访问控制策略的启用状态。取值：

  • true：启用访问控制策略

  • false：不启用访问控制策略

true
RepeatType

string

否

访问控制策略的策略有效期的重复类型。取值：

  • Permanent（默认）：总是

  • None：指定单次时间

  • Daily：每天

  • Weekly：每周

  • Monthly：每月

Permanent

返回参数

名称

类型

描述

示例值

object

TotalCount

string

VPC 边界防火墙访问控制策略的总数量。

20
RequestId

string

本次请求的 ID。

CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D
Policys

array<object>

VPC 边界防火墙访问控制策略的信息。

object

Destination

string

VPC 边界防火墙访问控制策略中的目的地址。取值：

  • 当 DestinationType 为net时，Destination 为目的 CIDR 地址。

  • 当 DestinationType 为domain时，Destination 为目的域名。

  • 当 DestinationType 为group时，Destination 为目的地址簿名称。

192.0.XX.XX/24
Order

integer

VPC 边界防火墙访问控制策略生效的优先级。

优先级数字从 1 开始顺序递增，优先级数字越小，表示优先级越高。

1
DestPortGroup

string

VPC 边界防火墙访问控制策略中访问流量的目的端口地址簿名称。

my_port_group
SourceType

string

VPC 边界防火墙访问控制策略中源地址类型。取值：

  • net：源 CIDR 地址

  • group：源地址簿

net
ApplicationName

string

VPC 边界防火墙访问控制策略支持的应用类型，推荐使用 ApplicationNameList。取值：

  • HTTP

  • HTTPS

  • MySQL

  • SMTP

  • SMTPS

  • RDP

  • VNC

  • SSH

  • Redis

  • MQTT

  • MongoDB

  • Memcache

  • SSL

  • ANY（表示查询访问控制策略所有的应用类型）

HTTP
AclUuid

string

VPC 边界防火墙访问控制策略的唯一标识 ID。

4037fbf7-3e39-4634-92a4-d0155247****
DestPortType

string

VPC 边界防火墙访问控制策略中访问流量的目的端口类型。取值：

  • port：单个端口

  • group：端口地址簿

port
Source

string

VPC 边界防火墙访问控制策略中的访问源地址。取值：

  • 当 SourceType 为net时，Source 为访问源 CIDR 地址。

  • 当 SourceType 为group时，Source 为地址簿名称。

192.0.XX.XX/24
DestinationType

string

VPC 边界防火墙访问控制策略中目的地址的类型。取值：

  • net：目的 CIDR 地址

  • group：目的地址簿

  • domain：目的域名

net
HitTimes

integer

VPC 边界防火墙访问控制策略的命中次数。

100
DestPort

string

VPC 边界防火墙访问控制策略中访问流量的目的端口。

80
Description

string

VPC 边界防火墙访问控制策略的描述信息。

test
AclAction

string

VPC 边界防火墙访问控制策略中设置的访问流量通过云防火墙的方式（动作）。取值：

  • accept：放行

  • drop：拒绝

  • log：观察

accept
ApplicationId

string

VPC 边界防火墙访问控制策略中设置访问流量的应用的 ID。

10**
Proto

string

VPC 边界防火墙访问控制策略中访问流量的协议类型。取值：

  • TCP

  • UDP

  • ICMP

  • ANY（表示查询所有协议类型）

TCP
DestinationGroupCidrs

array

VPC 边界防火墙访问控制策略中目的地址簿中的网段信息。

string

VPC 边界防火墙访问控制策略中目的地址簿中的网段列表。

["192.0.XX.XX/24", "192.0.XX.XX/32"]
DestPortGroupPorts

array

VPC 边界防火墙访问控制策略中目的端口地址簿的详细信息。

string

VPC 边界防火墙访问控制策略中目的端口地址簿中包含的端口列表。

[80,443]
SourceGroupCidrs

array

VPC 边界防火墙访问控制策略中源地址簿的详细信息。

string

VPC 边界防火墙访问控制策略中，源地址簿中的网段列表。

["192.0.XX.XX/24", "198.51.XX.XX/32"]
MemberUid

string

当前阿里云账号的成员账号 UID。

258039427902****
Release

string

访问控制策略的启用状态。策略创建后默认启用该策略。取值：

  • true：启用访问控制策略

  • false：不启用访问控制策略

true
SourceGroupType

string

访问控制策略中的源地址簿类型。唯一取值： ip。表示 IP 地址簿，包含一个或多个 IP 地址段。

ip
DestinationGroupType

string

访问控制策略中的目的地址簿类型。取值：

  • ip：IP 地址簿，包含一个或多个 IP 地址段。

  • domain：域名地址簿，包含一个或多个域名地址。

ip
HitLastTime

integer

最新命中时间戳。使用秒级时间戳格式表示。

1579261141
ModifyTime

integer

修改策略的时间。使用秒级时间戳格式表示。

1761062400
SpreadCnt

integer

占用访问控制策略的规格数，即每条策略占用规格数的累加值。 单条策略占用访问控制策略的规格数=访问源地址段个数 * 目的地址个数（IP 地址段个数或域名个数）* 应用数 * 端口段个数。

10,000
CreateTime

integer

创建策略的时间。使用秒级时间戳格式表示。

1761062400
ApplicationNameList

array

应用名称列表。

string

VPC 边界防火墙访问控制策略支持的应用类型列表。取值：

  • HTTP

  • HTTPS

  • MySQL

  • SMTP

  • SMTPS

  • RDP

  • VNC

  • SSH

  • Redis

  • MQTT

  • MongoDB

  • Memcache

  • SSL

  • ANY（表示查询访问控制策略所有的应用类型）

[ "HTTPS", "SMTPS", "SSL" ]
RepeatType

string

访问控制策略的策略有效期的重复类型。取值：

  • Permanent（默认）：总是

  • None：指定单次时间

  • Daily：每天

  • Weekly：每周

  • Monthly：每月

Permanent
RepeatDays

array

访问控制策略的策略有效期的重复日期集合。

  • 当 RepeatType 为Permanent、None、Daily时，RepeatDays 为空集合。 例如：[]

  • 当 RepeatType 为 Weekly 时，RepeatDays 不能为空。 例如：[0, 6]

说明

RepeatType 设置为 Weekly 时，RepeatDays 不允许重复。

  • 当 RepeatType 为Monthly时，RepeatDays 不能为空。 例如：[1, 31]

说明

RepeatType 设置为 Monthly 时，RepeatDays 不允许重复。

integer

访问控制策略的策略有效期的重复日期。

说明

RepeatType 设置为 Weekly 时，取值范围：0~6，每周开始于周日。 RepeatType 设置为 Monthly 时，取值范围：1~31。

1
RepeatStartTime

string

访问控制策略的策略有效期的重复开始时间。例如：08:00，必须为整点或半点时间，且小于重复结束时间至少半小时。

说明

当 RepeatType 为 Permanent、None 时，RepeatStartTime 为空。当 RepeatType 为 Daily、Weekly、Monthly 时，RepeatStartTime 必须有值，您需要设置重复开始时间。

08:00
RepeatEndTime

string

访问控制策略的策略有效期的重复结束时间。例如：23:30，必须为整点或半点时间，且大于重复开始时间至少半小时。

说明

当 RepeatType 为 Permanent、None 时，RepeatEndTime 为空。当 RepeatType 为 Daily、Weekly、Monthly 时，RepeatEndTime 必须有值，您需要设置重复结束时间。

23:30
StartTime

integer

访问控制策略的策略有效期的开始时间。使用秒级时间戳格式表示。必须为整点或半点时间，且小于结束时间至少半小时。

说明

当 RepeatType 为 Permanent 时，StartTime 为空。当 RepeatType 为 None、Daily、Weekly、Monthly 时，StartTime 必须有值，您需要设置开始时间。

1694761200
EndTime

integer

访问控制策略的策略有效期的结束时间。使用秒级时间戳格式表示。必须为整点或半点时间，且大于开始时间至少半小时。

说明

当 RepeatType 为 Permanent 时，EndTime 为空。当 RepeatType 为 None、Daily、Weekly、Monthly 时，EndTime 必须有值，您需要设置结束时间。

1694764800
DomainResolveType

string

访问控制策略的域名解析方式。取值：

  • FQDN：基于 FQDN

  • DNS：基于 DNS 动态解析

  • FQDN_AND_DNS：基于 FQDN 与 DNS 动态解析

FQDN

示例

正常返回示例

JSON格式

{
  "TotalCount": "20",
  "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D",
  "Policys": [
    {
      "Destination": "192.0.XX.XX/24",
      "Order": 1,
      "DestPortGroup": "my_port_group",
      "SourceType": "net",
      "ApplicationName": "HTTP",
      "AclUuid": "4037fbf7-3e39-4634-92a4-d0155247****",
      "DestPortType": "port",
      "Source": "192.0.XX.XX/24",
      "DestinationType": "net",
      "HitTimes": 100,
      "DestPort": "80",
      "Description": "test",
      "AclAction": "accept",
      "ApplicationId": "10**",
      "Proto": "TCP",
      "DestinationGroupCidrs": [
        "[\"192.0.XX.XX/24\", \"192.0.XX.XX/32\"]"
      ],
      "DestPortGroupPorts": [
        "[80,443]"
      ],
      "SourceGroupCidrs": [
        "[\"192.0.XX.XX/24\", \"198.51.XX.XX/32\"]"
      ],
      "MemberUid": "258039427902****",
      "Release": "true",
      "SourceGroupType": "ip",
      "DestinationGroupType": "ip",
      "HitLastTime": 1579261141,
      "ModifyTime": 1761062400,
      "SpreadCnt": 0,
      "CreateTime": 1761062400,
      "ApplicationNameList": [
        "[\n    \"HTTPS\", \n    \"SMTPS\", \n    \"SSL\"\n]"
      ],
      "RepeatType": "Permanent",
      "RepeatDays": [
        1
      ],
      "RepeatStartTime": "08:00",
      "RepeatEndTime": "23:30",
      "StartTime": 1694761200,
      "EndTime": 1694764800,
      "DomainResolveType": "FQDN"
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述
400 ErrorParametersUid The aliUid parameter is invalid. aliUid 不合法
400 ErrorParametersPageSizeOrNo Either pageSize or pageNo is invalid. 无效的pageSize或者pageNo
400 ErrorDBSelect An error occurred while querying database. 内部错误：数据库查询错误
400 ErrorUUIDNew The UUID is invalid. 内部错误：UUID错误
400 ErrorParametersAppId The appId is invalid. 无效的AppId
400 ErrorParameterIpVersion The IP version is invalid. IP版本参数错误
400 ErrorParametersDirection The direction is invalid. 无效的方向
400 ErrorParametersSource The source is invalid. 无效的来源
400 ErrorDomainResolve A domain resolution error occurred. 域名解析错误
400 ErrorParametersDestination The Destination parameter is invalid. Destination参数非法
400 ErrorParametersProto The protocol is invalid. 无效的协议
400 ErrorParametersDestPort The dst_port is invalid. 无效的目的端口
400 ErrorParametersAction The action is invalid. 无效的动作
400 ErrorParameters Parameters error. 参数错误。
400 ErrorMarshalJSON An error occurred while encoding JSON. 内部错误：JSON编码错误
400 ErrorParametersAclUuid Specified parameter AclUuid is not valid. 指定的ACL uuid不合法。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：DescribeVpcFirewallAclGroupList - 获取VPC防火墙所有访问控制策略组信息下一篇：DescribeVpcFirewallPolicyPriorUsed - 查询VPC防火墙策略组访问控制策略优先级生效范围