DescribeVpcFirewallControlPolicy - Cloud Firewall

Queries the information about the access control policies for a specified virtual private cloud (VPC) firewall.

Operation description

You can call the DescribeVpcFirewallControlPolicy operation to query the information about all access control policies that are created for a specified VPC firewall. Different access control policies are used when a VPC firewall is used to protect traffic between two VPCs that are connected by using a Cloud Enterprise Network (CEN) instance or an Express Connect circuit.

Limits

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-cloudfirewall:DescribeVpcFirewallControlPolicy	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the content within the request and response. Valid values: zh: Chinese (default) en: English	zh
VpcFirewallId	string	Yes	The instance ID of the VPC firewall. Valid values: If the VPC firewall protects the traffic between two VPCs that are connected by using a CEN instance, the value of this parameter must be the ID of the CEN instance. If the VPC firewall protects the traffic between two VPCs that are connected by using an Express Connect circuit, the value of this parameter must be the instance ID of the VPC firewall. Note You can call the DescribeVpcFirewallAclGroupList operation to query the ID.	vfw-a42bbb7b887148c9****
CurrentPage	string	Yes	The number of the page to return.	1
PageSize	string	Yes	The number of entries to return on each page. Maximum value: 50.	10
Source	string	No	The source address in the access control policy. Fuzzy match is supported. Note The value of this parameter can be a CIDR block or an address book name.	192.0.XX.XX/24
Destination	string	No	The destination address in the access control policy. Fuzzy match is supported. Note The value of this parameter can be a CIDR block or an address book name.	192.0.XX.XX/24
Description	string	No	The description of the access control policy. Fuzzy match is supported.	test
Proto	string	No	The protocol type in the access control policy. Valid values: TCP UDP ICMP ANY: all protocol types Note If you do not specify this parameter, access control policies of all protocol types are queried.	TCP
AclAction	string	No	The action that Cloud Firewall performs on the traffic. Valid values: accept: allows the traffic. drop: blocks the traffic. log: monitors the traffic. Note If you do not specify this parameter, access control policies are queried based on all actions.	accept
MemberUid	string	No	The UID of the member that is managed by your Alibaba Cloud account.	258039427902****
AclUuid	string	No	The unique ID of the access control policy.	4037fbf7-3e39-4634-92a4-d0155247****
Release	string	No	The status of the access control policy. Valid values: true: enabled false: disabled	true
RepeatType	string	No	The recurrence type for the access control policy to take effect. Valid values: Permanent (default): The policy always takes effect. None: The policy takes effect for only once. Daily: The policy takes effect on a daily basis. Weekly: The policy takes effect on a weekly basis. Monthly: The policy takes effect on a monthly basis.	Permanent

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	string	The total number of access control policies returned.	20
RequestId	string	The ID of the request.	CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D
Policys	array<object>	The details of the access control policies.
	object
Destination	string	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. If DestinationType is set to `domain`, the value of this parameter is a domain name. If DestinationType is set to `group`, the value of this parameter is an address book name.	192.0.XX.XX/24
Order	integer	The priority of the access control policy. The priority value starts from 1. A smaller priority value indicates a higher priority.	1
DestPortGroup	string	The name of the destination port address book in the access control policy.	my_port_group
SourceType	string	The type of the source address in the access control policy. Valid values: net: CIDR block group: address book	net
ApplicationName	string	The application types supported by the access control policy. We recommend that you specify ApplicationNameList. Valid values: HTTP HTTPS MySQL SMTP SMTPS RDP VNC SSH Redis MQTT MongoDB Memcache SSL ANY: all application types	HTTP
AclUuid	string	The UUID of the access control policy.	4037fbf7-3e39-4634-92a4-d0155247****
DestPortType	string	The type of the destination port in the access control policy. Valid values: port: port group: port address book	port
Source	string	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. If SourceType is set to `group`, the value of this parameter is an address book name.	192.0.XX.XX/24
DestinationType	string	The type of the destination address in the access control policy. Valid values: net: CIDR block group: address book domain: domain name	net
HitTimes	integer	The number of hits for the access control policy.	100
DestPort	string	The destination port in the access control policy.	80
Description	string	The description of the access control policy.	test
AclAction	string	The action that Cloud Firewall performs on the traffic. Valid values: accept: allows the traffic. drop: denies the traffic. log: monitors the traffic.	accept
ApplicationId	string	The application ID in the access control policy.	10**
Proto	string	The protocol type in the access control policy. Valid values: TCP UDP ICMP ANY: all protocol types	TCP
DestinationGroupCidrs	array	The CIDR blocks in the destination address book of the access control policy.
	string	The CIDR block in the destination address book of the access control policy.	["192.0.XX.XX/24", "192.0.XX.XX/32"]
DestPortGroupPorts	array	The ports in the destination port address book of the access control policy.
	string	The port in the destination port address book of the access control policy.	[80,443]
SourceGroupCidrs	array	The CIDR blocks in the source address book of the access control policy.
	string	The CIDR block in the source address book of the access control policy.	["192.0.XX.XX/24", "198.51.XX.XX/32"]
MemberUid	string	The UID of the member that is managed by your Alibaba Cloud account.	258039427902****
Release	string	Indicates whether the access control policy is enabled. By default, an access control policy is enabled after it is created. Valid values: true false	true
SourceGroupType	string	The type of the source address book in the access control policy. The value is fixed as ip. The value indicates an address book that includes one or more CIDR blocks.	ip
DestinationGroupType	string	The type of the destination address book in the access control policy. Valid values: ip: an address book that includes one or more CIDR blocks domain: an address book that includes one or more domain names	ip
HitLastTime	long	The time when the access control policy was last hit. The value is a UNIX timestamp. Unit: seconds.	1579261141
ModifyTime	long	The time when the access control policy was modified. The value is a UNIX timestamp. Unit: seconds.	1761062400
SpreadCnt	long	The total quota consumed by the returned access control policies, which is the sum of the quota consumed by each policy. The quota that is consumed by an access control policy is calculated by using the following formula: Quota that is consumed by an access control policy = Number of source addresses × Number of destination addresses (number of CIDR blocks or domain names) × Number of applications × Number of port ranges.	10,000
CreateTime	long	The time when the access control policy was created. The value is a UNIX timestamp. Unit: seconds.	1761062400
ApplicationNameList	array	The application types supported by the access control policy.
	string	The application type supported by the access control policy. Valid values: HTTP HTTPS MySQL SMTP SMTPS RDP VNC SSH Redis MQTT MongoDB Memcache SSL ANY: all application types	[ "HTTPS", "SMTPS", "SSL" ]
DomainResolveType	string	The domain name resolution method of the access control policy. By default, an access control policy is enabled after the policy is created. Valid values: FQDN: fully qualified domain name (FQDN)-based resolution DNS: DNS-based dynamic resolution FQDN_AND_DNS: FQDN and DNS-based dynamic resolution	FQDN
RepeatType	string	The recurrence type for the access control policy to take effect. Valid values: Permanent (default): The policy always takes effect. None: The policy takes effect for only once. Daily: The policy takes effect on a daily basis. Weekly: The policy takes effect on a weekly basis. Monthly: The policy takes effect on a monthly basis.	Permanent
RepeatDays	array	The days of a week or of a month on which the access control policy takes effect. If RepeatType is set to `Permanent`, `None`, or `Daily`, RepeatDays is left empty. Example: []. If RepeatType is set to Weekly, RepeatDays must be specified. Example: [0, 6]. Note If RepeatType is set to Weekly, the fields in the value of RepeatDays cannot be repeated. If RepeatType is set to `Monthly`, RepeatDays must be specified. Example: [1, 31]. Note If RepeatType is set to Monthly, the fields in the value of RepeatDays cannot be repeated.
	long	The day of a week or of a month on which the access control policy takes effect. Note If RepeatType is set to Weekly, valid values of this parameter are 0 to 6. Each week starts from Sunday. If RepeatType is set to Monthly, valid values of this parameter are 1 to 31.	1
RepeatStartTime	string	The point in time when the recurrence starts. Example: 08:00. The value must be on the hour or on the half hour, and at least 30 minutes earlier than the value of RepeatEndTime. Note If RepeatType is set to Permanent or None, RepeatStartTime is left empty. If RepeatType is set to Daily, Weekly, or Monthly, this parameter must be specified.	08:00
RepeatEndTime	string	The point in time when the recurrence ends. Example: 23:30. The value must be on the hour or on the half hour, and at least 30 minutes later than the value of RepeatStartTime. Note If RepeatType is set to Permanent or None, RepeatEndTime is left empty. If RepeatType is set to Daily, Weekly, or Monthly, RepeatEndTime must be specified.	23:30
StartTime	long	The time when the access control policy starts to take effect. The value is a UNIX timestamp. Unit: seconds. The value must be on the hour or on the half hour, and at least 30 minutes earlier than the value of EndTime. Note If RepeatType is set to Permanent, StartTime is left empty. If RepeatType is set to None, Daily, Weekly, or Monthly, StartTime must be specified.	1694761200
EndTime	long	The time when the access control policy stops taking effect. The value is a UNIX timestamp. Unit: seconds. The value must be on the hour or on the half hour, and at least 30 minutes later than the value of StartTime. Note If RepeatType is set to Permanent, EndTime is left empty. If RepeatType is set to None, Daily, Weekly, or Monthly, EndTime must be specified.	1694764800

Examples

Sample success responses

JSONformat

{
  "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]"
      ],
      "DomainResolveType": "FQDN",
      "RepeatType": "Permanent",
      "RepeatDays": [
        1
      ],
      "RepeatStartTime": "08:00",
      "RepeatEndTime": "23:30",
      "StartTime": 1694761200,
      "EndTime": 1694764800
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorParametersUid	The aliUid parameter is invalid.	The aliUid parameter is invalid.
400	ErrorParametersPageSizeOrNo	Either pageSize or pageNo is invalid.	Either pageSize or pageNo is invalid.
400	ErrorDBSelect	An error occurred while querying database.	An error occurred while querying database.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-08-08	The Error code has changed. The response structure of the API has changed	View Change Details
2023-10-12	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2023-09-14	The Error code has changed. The response structure of the API has changed	View Change Details
2023-09-11	The Error code has changed. The response structure of the API has changed	View Change Details