Queries the information about the access control policies that meet specific query conditions for a specific VPC firewall.

Note The VPC firewall instance used to protect each Cloud Enterprise Network (CEN) and the VPC firewall instance used to protect each Express Connect use different access control policies.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeVpcFirewallControlPolicy

The operation that you want to perform.

Set the value to DescribeVpcFirewallControlPolicy.

CurrentPage String Yes 1

The number of the page to return.

Default value: 1.

PageSize String Yes 10

The number of entries to return on each page.

Maximum value: 50.

VpcFirewallId String Yes vfw-a42bbb7b887148c9****

The ID of the access control policy group that you want to query. You can call the DescribeVpcFirewallAclGroupList operation to obtain the ID.

Valid values:

  • If the VPC firewall is used to protect a CEN, the ID of the CEN instance is used.

    Example: cen-ervw0g12b5jbw****

  • If the VPC firewall is used to protect an Express Connect, the ID of the VPC firewall instance is used.

    Example: vfw-a42bbb7b887148c9****

Lang String No zh

The natural language of the request and response.

Valid values:

  • zh: Chinese
  • en: English
Source String No 10.0.1.0/24

The source address in the access control policy. Fuzzy match is supported.

Valid values:

  • If SourceType is set to net, the value of this parameter is a CIDR block.

    Example: 10.0.1.0/24

  • If SourceType is set to group, the value of this parameter is an address book.

    Example: db_group

  • If SourceType is not specified, all the sources are queried.
Note The valid values of this parameter depend on the value of the SourceType parameter.
Destination String No 10.0.3.0

The destination address in the access control policy. Fuzzy match is supported.

Valid values:

  • If DestinationType is set to net, the value of this parameter is a CIDR block.

    Example: 10.0.3.0/24

  • If DestinationType is set to domain, the value of this parameter is a domain name.

    Example: aliyun.com

  • If DestinationType is set to group, the value of this parameter is an address book.

    Example: db_group

  • If DestinationType is not specified, all destination addresses are queried.
Note The valid values of this parameter depend on the value of the DestinationType parameter.
Description String No test

The description of the access control policy. Fuzzy match is supported.

Note If this parameter is not specified, the descriptions of all access control policies are queried.
Proto String No TCP

The protocol type in the access control policy.

Valid values:

  • TCP
  • UDP
  • ICMP
  • If this parameter is not specified, all protocol types are queried.
  • If this parameter is set to ANY, all protocol types are queried.
AclAction String No accept

The action that Cloud Firewall performs on the traffic.

Valid values:

  • accept: allows the traffic.
  • drop: denies the traffic.
  • log: monitors the traffic.
  • If this parameter is not specified, all access control policies are queried.

Response parameters

Parameter Type Example Description
Policys Array

The information about the access control policies.

AclAction String accept

The action that Cloud Firewall performs on the traffic.

Valid values:

  • accept: allows the traffic.
  • drop: denies the traffic.
  • log: monitors the traffic.
AclUuid String 00281255-d220-4db1-8f4f-c4df221a****

The unique ID of the access control policy.

ApplicationId String 10**

The application ID in the access control policy.

ApplicationName String HTTP

The application type that the access control policy supports.

Valid values:

  • HTTP
  • HTTPS
  • MySQL
  • SMTP
  • SMTPS
  • RDP
  • VNC
  • SSH
  • Redis
  • MQTT
  • MongoDB
  • Memcache
  • SSL
  • ANY (indicates that all application types are supported)
Description String test

The description of the access control policy.

DestPort String 80

The destination port in the access control policy.

DestPortGroup String my_port_group

The destination port address book in the access control policy.

DestPortGroupPorts List [80,443]

The ports in the destination port address book.

DestPortType String port

The destination port type in the access control policy.

Valid values:

  • port: port
  • group: port address book
Destination String 10.0.3.0/24

The destination address in the access control policy.

Valid values:

  • If DestinationType is set to net, the value of this parameter is a CIDR block.

    Example: 10.0.3.0/24

  • If DestinationType is set to domain, the value of this parameter is a domain name.

    Example: aliyuncs.com

  • If DestinationType is set to group, the value of this parameter is an address book.

    Example: db_group

Note The valid values of this parameter depend on the value of the DestinationType parameter.
DestinationGroupCidrs List ["10.0.4.0/24", "10.0.0.1/32"]

The CIDR blocks in the destination address book of the access control policy.

DestinationType String net

The destination address type in the access control policy.

Valid values:

  • net: CIDR block
  • group: address book
  • domain: domain name
Direction String in

The direction of traffic to which the access control policy applies.

Valid values:

  • in: inbound traffic
  • out: outbound traffic
HitTimes Integer 100

The number of hits for the access control policy.

Order Integer 1

The priority of the access control policy.

The priority value starts from 1. A smaller priority value indicates a higher priority. The value -1 indicates the lowest priority.

Proto String TCP

The protocol type in the access control policy.

Valid values:

  • TCP
  • UDP
  • ICMP
  • ANY (All protocol types are queried.)
Source String 10.0.6.0/24

The source address in the access control policy.

Valid values:

  • If SourceType is set to net, the value of this parameter is a CIDR block.

    Example: 10.0.6.0/24

  • If SourceType is set to group, the value of this parameter is an address book.

    Example: db_group

Note The valid values of this parameter depend on the value of the SourceType parameter.
SourceGroupCidrs List ["10.0.6.0/24", "10.0.0.2/32"]

The CIDR blocks in the source address book of the access control policy.

SourceType String net

The source address type in the access control policy.

Valid values:

  • net: CIDR block
  • group: address book
RequestId String CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D

The ID of the request.

TotalCount String 20

The total number of access control policies that meet the query conditions.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeVpcFirewallControlPolicy
&VpcFirewallId=vfw-a42bbb7b887148c9****
&CurrentPage=1
&PageSize=10
&<Common request parameters>

Sample success responses

XML format

<DescribeVpcFirewallControlPolicyResponse>
  <TotalCount>1</TotalCount>
  <PageNo>1</PageNo>
  <PageSize>10</PageSize>
  <RequestId>A08BC58F-A83D-43EB-BC31-2F0D723929CC</RequestId>
  <Policys>
        <ApplicationName>HTTP</ApplicationName>
        <Description>11</Description>
        <HitTimes>0</HitTimes>
        <DestinationType>net</DestinationType>
        <SourceType>net</SourceType>
        <Proto>TCP</Proto>
        <Order>5</Order>
        <ApplicationId>27</ApplicationId>
        <DestPortType>port</DestPortType>
        <Source>10.1.1.1/32</Source>
        <DestPort>80/80</DestPort>
        <AclAction>accept</AclAction>
        <AclUuid>53d82f0e-9bf1-4761-ab3b-a070b4811234</AclUuid>
        <Destination>10.2.1.1/32</Destination>
  </Policys>
</DescribeVpcFirewallControlPolicyResponse>

JSON format

{
    "TotalCount":1,
    "PageNo":1,
    "PageSize":10,
    "RequestId":"A08BC58F-A83D-43EB-BC31-2F0D723929CC",
    "Policys":[
        {
            "DestinationGroupCidrs":[

            ],
            "SourceGroupCidrs":[

            ],
            "ApplicationName":"HTTP",
            "Description":"11",
            "HitTimes":0,
            "DestinationType":"net",
            "SourceType":"net",
            "Proto":"TCP",
            "Order":5,
            "ApplicationId":"27",
            "DestPortType":"port",
            "Source":"10.1.1.1/32",
            "DestPort":"80/80",
            "AclAction":"accept",
            "DestPortGroupPorts":[

            ],
            "AclUuid":"53d82f0e-9bf1-4761-ab3b-a070b4811234",
            "Destination":"10.2.1.1/32"
        }
    ]
}

Error codes

For a list of error codes, visit the API Error Center.