All Products
Search
Document Center

Cloud Firewall:DescribeVpcFirewallControlPolicy

更新時間:Sep 02, 2024

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-cloudfirewall:DescribeVpcFirewallControlPolicyget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language of the content within the request and response.

Valid values:

  • zh: Chinese (default)
  • en: English
zh
VpcFirewallIdstringYes

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****
CurrentPagestringYes

The number of the page to return.

1
PageSizestringYes

The number of entries to return on each page.

Maximum value: 50.

10
SourcestringNo

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
DestinationstringNo

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
DescriptionstringNo

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

test
ProtostringNo

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
AclActionstringNo

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
MemberUidstringNo

The UID of the member that is managed by your Alibaba Cloud account.

258039427902****
AclUuidstringNo

The unique ID of the access control policy.

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

The status of the access control policy. Valid values:

  • true: enabled
  • false: disabled
true
RepeatTypestringNo

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

ParameterTypeDescriptionExample
object
TotalCountstring

The total number of access control policies returned.

20
RequestIdstring

The ID of the request.

CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D
Policysarray<object>

The details of the access control policies.

object
Destinationstring

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
Orderinteger

The priority of the access control policy.

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

1
DestPortGroupstring

The name of the destination port address book in the access control policy.

my_port_group
SourceTypestring

The type of the source address in the access control policy. Valid values:

  • net: CIDR block
  • group: address book
net
ApplicationNamestring

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
AclUuidstring

The UUID of the access control policy.

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

The type of the destination port in the access control policy. Valid values:

  • port: port
  • group: port address book
port
Sourcestring

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
DestinationTypestring

The type of the destination address in the access control policy. Valid values:

  • net: CIDR block
  • group: address book
  • domain: domain name
net
HitTimesinteger

The number of hits for the access control policy.

100
DestPortstring

The destination port in the access control policy.

80
Descriptionstring

The description of the access control policy.

test
AclActionstring

The action that Cloud Firewall performs on the traffic. Valid values:

  • accept: allows the traffic.
  • drop: denies the traffic.
  • log: monitors the traffic.
accept
ApplicationIdstring

The application ID in the access control policy.

10**
Protostring

The protocol type in the access control policy. Valid values:

  • TCP
  • UDP
  • ICMP
  • ANY: all protocol types
TCP
DestinationGroupCidrsarray

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

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]
SourceGroupCidrsarray

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

The UID of the member that is managed by your Alibaba Cloud account.

258039427902****
Releasestring

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
SourceGroupTypestring

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
DestinationGroupTypestring

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
HitLastTimelong

The time when the access control policy was last hit. The value is a UNIX timestamp. Unit: seconds.

1579261141
ModifyTimelong

The time when the access control policy was modified. The value is a UNIX timestamp. Unit: seconds.

1761062400
SpreadCntlong

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
CreateTimelong

The time when the access control policy was created. The value is a UNIX timestamp. Unit: seconds.

1761062400
ApplicationNameListarray

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

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
RepeatTypestring

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
RepeatDaysarray

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
RepeatStartTimestring

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
RepeatEndTimestring

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
StartTimelong

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
EndTimelong

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 codeError codeError messageDescription
400ErrorParametersUidThe aliUid parameter is invalid.The aliUid parameter is invalid.
400ErrorParametersPageSizeOrNoEither pageSize or pageNo is invalid.Either pageSize or pageNo is invalid.
400ErrorDBSelectAn 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 timeSummary of changesOperation
2024-08-08The Error code has changed. The response structure of the API has changedView Change Details
2023-10-12The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details
2023-09-14The Error code has changed. The response structure of the API has changedView Change Details
2023-09-11The Error code has changed. The response structure of the API has changedView Change Details