全部产品
Search
文档中心

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

更新时间:May 10, 2023

查询指定的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:DescribeVpcFirewallControlPolicyRead
  • CloudFirewall
    acs:yundun-cloudfirewall:*:{#accountId}:vpcfirewallcontrolpolicy/{#AclUuid}

请求参数

名称类型必填描述示例值
Langstring

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

取值:

  • zh(默认):中文

  • en:英文

zh
VpcFirewallIdstring

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

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

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

说明您可以调用DescribeVpcFirewallAclGroupList接口获取该ID。
vfw-a42bbb7b887148c9****
CurrentPagestring

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

1
PageSizestring

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

可设置值最大为50。

10
Sourcestring

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

说明Source可以是单个CIDR地址或地址簿名称。
192.0.XX.XX/24
Destinationstring

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

说明Destination可以是单个CIDR地址或域名,也可以是地址薄名称。
192.0.XX.XX/24
Descriptionstring

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

test
Protostring

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

  • TCP
  • UDP
  • ICMP
  • ANY(查询所有协议类型)
说明不设置该参数表示查询所有协议类型。
TCP
AclActionstring

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

  • accept:放行
  • drop:拒绝
  • log:观察
说明不设置该参数表示查询所有动作。
accept
MemberUidstring

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

258039427902****
AclUuidstring

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

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

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

  • true:启用访问控制策略
  • false:不启用访问控制策略
true

返回参数

名称类型描述示例值
object
TotalCountstring

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

20
RequestIdstring

本次请求的ID。

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

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

object
Destinationstring

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

  • DestinationTypenet时,Destination为目的CIDR地址。

  • DestinationTypedomain时,Destination为目的域名。

  • DestinationTypegroup时,Destination为目的地址簿名称。

192.0.XX.XX/24
Orderinteger

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

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

1
DestPortGroupstring

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

my_port_group
SourceTypestring

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

  • net:源CIDR地址
  • group:源地址簿
net
ApplicationNamestring

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

  • HTTP
  • HTTPS
  • MySQL
  • SMTP
  • SMTPS
  • RDP
  • VNC
  • SSH
  • Redis
  • MQTT
  • MongoDB
  • Memcache
  • SSL
  • ANY(表示查询访问控制策略所有的应用类型)
HTTP
AclUuidstring

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

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

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

  • port:单个端口
  • group:端口地址簿
port
Sourcestring

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

  • SourceTypenet时,Source为访问源CIDR地址。

  • SourceTypegroup时,Source为地址簿名称。

192.0.XX.XX/24
DestinationTypestring

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

  • net:目的CIDR地址
  • group:目的地址簿
  • domain:目的域名
net
HitTimesinteger

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

100
DestPortstring

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

80
Descriptionstring

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

test
AclActionstring

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

  • accept:放行
  • drop:拒绝
  • log:观察
accept
ApplicationIdstring

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

10**
Protostring

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

  • TCP
  • UDP
  • ICMP
  • ANY(表示查询所有协议类型)
TCP
DestinationGroupCidrsarray

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

string

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

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

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

string

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

[80,443]
SourceGroupCidrsarray

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

string

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

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

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

258039427902****
Releasestring

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

  • true:启用访问控制策略
  • false:不启用访问控制策略
true
SourceGroupTypestring

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

ip
DestinationGroupTypestring

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

  • ip:IP地址簿,包含一个或多个IP地址段。
  • domain:域名地址簿,包含一个或多个域名地址。
ip

示例

正常返回示例

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"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400ErrorParametersUidThe aliUid parameter is invalid.aliUid 不合法
400ErrorParametersPageSizeOrNoEither pageSize or pageNo is invalid.无效的pageSize或者pageNo
400ErrorDBSelectAn error occurred while querying database.内部错误:数据库查询错误

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