DescribeVpcFirewallControlPolicy - 云防火墙

使用说明

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

QPS限制

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

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeVpcFirewallControlPolicy	系统规定参数。取值：DescribeVpcFirewallControlPolicy。
Lang	String	否	zh	请求和接收消息的语言类型。取值： zh（默认）：中文。 en：英文。
VpcFirewallId	String	是	vfw-a42bbb7b887148c9****	VPC边界防火墙的实例ID。取值：当VPC边界防火墙防护通过云企业网连接的两个VPC之间的流量时，策略组ID使用云企业网实例ID。当VPC边界防火墙防护通过高速通道连接的两个VPC之间的流量时，策略组ID使用VPC边界防火墙实例ID。说明您可以调用DescribeVpcFirewallAclGroupList接口获取该ID。
CurrentPage	String	是	1	分页查询时，设置当前页的页码。
PageSize	String	是	10	分页查询时，设置每页包含VPC边界防火墙的访问控制策略数量。可设置值最大为50。
Source	String	否	192.0.XX.XX/24	VPC边界防火墙访问控制策略中的访问源地址。支持使用模糊查询。说明 Source可以是单个CIDR地址或地址簿名称。
Destination	String	否	192.0.XX.XX/24	VPC边界防火墙访问控制策略中的目的地址。支持模糊查询。说明 Destination可以是单个CIDR地址或域名，也可以是地址薄名称。
Description	String	否	test	VPC边界防火墙访问控制策略的描述信息。支持模糊查询。
Proto	String	否	TCP	VPC边界防火墙访问控制策略中访问流量的协议类型。取值： TCP UDP ICMP ANY（查询所有协议类型）说明不设置该参数表示查询所有协议类型。
AclAction	String	否	accept	VPC边界防火墙访问控制策略中设置的访问流量通过云防火墙的方式（动作）。取值： accept：放行。 drop：拒绝。 log：观察。说明不设置该参数表示查询所有动作。
MemberUid	String	否	258039427902****	当前阿里云账号的成员账号UID。
AclUuid	String	否	4037fbf7-3e39-4634-92a4-d0155247****	VPC边界防火墙访问控制策略的唯一标识ID。

返回数据


名称	类型	示例值	描述
TotalCount	String	20	VPC边界防火墙访问控制策略的总数量。
RequestId	String	CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D	本次请求的ID。
Policys	Array of DataItem		VPC边界防火墙访问控制策略的信息。
Destination	String	192.0.XX.XX/24	VPC边界防火墙访问控制策略中的目的地址。取值：当DestinationType为`net`时，Destination为目的CIDR地址。当DestinationType为`domain`时，Destination为目的域名。当DestinationType为`group`时，Destination为目的地址簿名称。
Order	Integer	1	VPC边界防火墙访问控制策略生效的优先级。优先级数字从1开始顺序递增，优先级数字越小，表示优先级越高。
DestPortGroup	String	my_port_group	VPC边界防火墙访问控制策略中访问流量的目的端口地址簿名称。
SourceType	String	net	VPC边界防火墙访问控制策略中源地址类型。取值： net：源CIDR地址。 group：源地址簿。
ApplicationName	String	HTTP	VPC边界防火墙访问控制策略支持的应用类型。取值： HTTP HTTPS MySQL SMTP SMTPS RDP VNC SSH Redis MQTT MongoDB Memcache SSL ANY（表示查询访问控制策略所有的应用类型）
AclUuid	String	4037fbf7-3e39-4634-92a4-d0155247****	VPC边界防火墙访问控制策略的唯一标识ID。
DestPortType	String	port	VPC边界防火墙访问控制策略中访问流量的目的端口类型。取值： port：单个端口。 group：端口地址簿。
Source	String	192.0.XX.XX/24	VPC边界防火墙访问控制策略中的访问源地址。取值：当SourceType为`net`时，Source为访问源CIDR地址。当SourceType为`group`时，Source为地址簿名称。
DestinationType	String	net	VPC边界防火墙访问控制策略中目的地址的类型。取值： net：目的CIDR地址。 group：目的地址簿。 domain：目的域名。
HitTimes	Integer	100	VPC边界防火墙访问控制策略的命中次数。
DestPort	String	80	VPC边界防火墙访问控制策略中访问流量的目的端口。
Description	String	test	VPC边界防火墙访问控制策略的描述信息。
AclAction	String	accept	VPC边界防火墙访问控制策略中设置的访问流量通过云防火墙的方式（动作）。取值： accept：放行。 drop：拒绝。 log：观察。
ApplicationId	String	10**	VPC边界防火墙访问控制策略中设置访问流量的应用的ID。
Proto	String	TCP	VPC边界防火墙访问控制策略中访问流量的协议类型。取值： TCP UDP ICMP ANY（表示查询所有协议类型）
DestinationGroupCidrs	Array of String	["192.0.XX.XX/24", "192.0.XX.XX/32"]	VPC边界防火墙访问控制策略中目的地址簿中的网段列表。
DestPortGroupPorts	Array of String	[80,443]	VPC边界防火墙访问控制策略中目的端口地址簿中包含的端口列表。
SourceGroupCidrs	Array of String	["192.0.XX.XX/24", "198.51.XX.XX/32"]	VPC边界防火墙访问控制策略中，源地址簿中的网段列表。
MemberUid	String	258039427902****	当前阿里云账号的成员账号UID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeVpcFirewallControlPolicy
&Lang=zh
&VpcFirewallId=vfw-a42bbb7b887148c9****
&CurrentPage=1
&PageSize=10
&Source=192.0.XX.XX/24
&Destination=192.0.XX.XX/24
&Description=test
&Proto=TCP
&AclAction=accept
&MemberUid=258039427902****
&AclUuid=4037fbf7-3e39-4634-92a4-d0155247****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeVpcFirewallControlPolicyResponse>
    <TotalCount>20</TotalCount>
    <RequestId>CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D</RequestId>
    <Policys>
        <Destination>192.0.XX.XX/24</Destination>
        <Order>1</Order>
        <DestPortGroup>my_port_group</DestPortGroup>
        <SourceType>net</SourceType>
        <ApplicationName>HTTP</ApplicationName>
        <AclUuid>4037fbf7-3e39-4634-92a4-d0155247****</AclUuid>
        <DestPortType>port</DestPortType>
        <Source>192.0.XX.XX/24</Source>
        <DestinationType>net</DestinationType>
        <HitTimes>100</HitTimes>
        <DestPort>80</DestPort>
        <Description>test</Description>
        <AclAction>accept</AclAction>
        <ApplicationId>10**</ApplicationId>
        <Proto>TCP</Proto>
        <DestinationGroupCidrs>["192.0.XX.XX/24", "192.0.XX.XX/32"]</DestinationGroupCidrs>
        <DestPortGroupPorts>[80,443]</DestPortGroupPorts>
        <SourceGroupCidrs>["192.0.XX.XX/24", "198.51.XX.XX/32"]</SourceGroupCidrs>
        <MemberUid>258039427902****</MemberUid>
    </Policys>
</DescribeVpcFirewallControlPolicyResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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****"
  } ]
}

错误码

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