Queries the details about virtual private cloud (VPC) firewalls by page. Each VPC firewall protects traffic between two VPCs that are connected by using an Express Connect circuit.
Operation description
You can call the DescribeVpcFirewallList operation to query the details about VPC firewalls by page. Each VPC firewall protects traffic between two VPCs that are connected by using an Express Connect circuit.
Limits
You can call this operation up to 10 times per second per account. If the number of 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
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 Resourcesis 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:DescribeVpcFirewallList | get |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Lang | string | No | The language of the content within the request and response. Valid values:
| zh |
| RegionNo | string | No | The region ID of the VPC. Note
For more information about the regions, see Supported regions.
| cn-hangzhou |
| VpcId | string | No | The ID of the VPC. | vpc-8vbwbo90rq0anm6t**** |
| FirewallSwitchStatus | string | No | The status of the VPC firewall. Valid values:
Note
If you do not specify this parameter, VPC firewalls in all states are queried.
| opened |
| VpcFirewallId | string | No | The instance ID of the VPC firewall. | vfw-m5e7dbc4y**** |
| VpcFirewallName | string | No | The instance name of the VPC firewall. | Test firewall |
| CurrentPage | string | No | The number of the page to return. Pages start from page 1. Default value: 1. | 1 |
| PageSize | string | No | The number of entries to return on each page. Default value: 10. Maximum value: 50. | 10 |
| MemberUid | string | No | The UID of the member that is managed by your Alibaba Cloud account. | 258039427902**** |
| ConnectSubType | string | No | The sub-type of the connection. Valid values:
| vpcpeer |
| PeerUid | string | No | The UID of the Alibaba Cloud account to which the peer VPC belongs. | 258039427902**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"TotalCount": 10,
"RequestId": "850A84D6-0DE4-4797-A1E8-00090125k8g2",
"VpcFirewalls": [
{
"ConnectType": "expressconnect",
"VpcFirewallId": "vfw-m5e7dbc4y****",
"RegionStatus": "enable",
"Bandwidth": 2,
"VpcFirewallName": "Test firewall\n",
"FirewallSwitchStatus": "opened",
"LocalVpc": {
"VpcName": "Test instance\n",
"VpcId": "vpc-8vbwbo90rq0anm6t****",
"AuthorizationStatus": "authorized",
"OwnerId": 0,
"RegionNo": "cn-hangzhou",
"VpcCidrTableList": [
{
"RouteTableId": "vtb-1234",
"RouteEntryList": [
{
"NextHopInstanceId": "vrt-m5eb5me6c3l5sezae****",
"DestinationCidr": "192.168.XX.XX/24"
}
]
}
]
},
"PeerVpc": {
"VpcName": "Test VPC 2\n",
"VpcId": "vpc-8vbwbo90rq0anm6t****",
"AuthorizationStatus": "authorized",
"OwnerId": 0,
"RegionNo": "cn-hangzhou",
"VpcCidrTableList": [
{
"RouteTableId": "vtb-1256",
"RouteEntryList": [
{
"NextHopInstanceId": "vrt-m5eb5me6c3l5sezae****",
"DestinationCidr": "192.168.XX.XX/24"
}
]
}
]
},
"IpsConfig": {
"BasicRules": 1,
"EnableAllPatch": 1,
"RunMode": 0,
"RuleClass": 1
},
"MemberUid": "258039427902****",
"ResultCode": "Unauthorized",
"ConnectSubType": "vpcpeer"
}
]
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | ErrorDBSelectError | A database select error occurred. | The error message returned because an internal error has occurred in querying the database. |
| 400 | ErrorPageNo | Either page number or page size is invalid. | Either page number or page size is invalid. |
| 400 | ErrorUnmarshalJSON | An error occurred while parsing JSON. | An error occurred while decoding JSON. |
| 400 | ErrorAliUid | Aliuid invalid. | The aliuid is invalid. |
| 400 | ErrorFirewallStatus | Firewall status error, please try again later. | The status of the firewall is invalid. Try again later. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-08-15 | The Error code has changed. The response structure of the API has changed | View Change Details |