Queries the details about virtual private cloud (VPC) firewalls. Each VPC firewall controls traffic between two VPCs that are connected by using an Express Connect circuit.
Description
You can call the DescribeVpcFirewallList operation to query the details about VPC firewalls by page. Each VPC firewall controls 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 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
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeVpcFirewallList |
The operation that you want to perform. Set the value to DescribeVpcFirewallList. |
Lang | String | No | zh |
The natural language of the request and response. Valid values:
|
RegionNo | String | No | cn-hangzhou |
The region ID of the VPC. Note For more information about regions in which Cloud Firewall is supported, see Supported regions.
|
VpcId | String | No | vpc-8vbwbo90rq0anm6t**** |
The ID of the VPC. |
FirewallSwitchStatus | String | No | opened |
The status of the VPC firewall. Valid values:
Note If you do not specify this parameter, VPC firewalls in all states are queried.
|
VpcFirewallId | String | No | vfw-m5e7dbc4y**** |
The instance ID of the VPC firewall. |
VpcFirewallName | String | No | Test firewall |
The instance name of the VPC firewall. |
CurrentPage | String | No | 1 |
The number of the page to return. Pages start from page 1. Default value: 1. |
PageSize | String | No | 10 |
The number of entries to return on each page. Default value: 10. Maximum value: 50. |
MemberUid | String | No | 258039427902**** |
The UID of the member that is managed by your Alibaba Cloud account. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
TotalCount | Integer | 10 |
The total number of VPC firewalls. |
RequestId | String | 850A84D6-0DE4-4797-A1E8-00090125k8g2 |
The ID of the request. |
VpcFirewalls | Array of Data |
The details about VPC firewalls. |
|
ConnectType | String | expressconnect |
The connection type of the VPC firewall. The value is fixed as expressconnect, which indicates Express Connect circuits. |
VpcFirewallId | String | vfw-m5e7dbc4y**** |
The instance ID of the VPC firewall. |
RegionStatus | String | enable |
The status of the region. Valid values:
|
Bandwidth | Integer | 2 |
The bandwidth of the Express Connect circuit. Unit: Mbit/s. |
VpcFirewallName | String | Test firewall |
The instance name of the VPC firewall. |
FirewallSwitchStatus | String | opened |
The status of the VPC firewall. Valid values:
|
LocalVpc | Object |
The details about the local VPC. |
|
VpcName | String | Test instance |
The name of the local VPC. |
VpcId | String | vpc-8vbwbo90rq0anm6t**** |
The ID of the local VPC. |
AuthorizationStatus | String | authorized |
Indicates whether Cloud Firewall is authorized to access the local VPC. The value is fixed as authorized, which indicates that Cloud Firewall is authorized to access the local VPC. |
OwnerId | Long | 158039427902**** |
The UID of the Alibaba Cloud account to which the local VPC belongs. |
RegionNo | String | cn-hangzhou |
The region ID of the local VPC. |
VpcCidrTableList | Array of cidrTable |
The CIDR blocks of the local VPC. |
|
RouteTableId | String | vtb-1234 |
The ID of the route table for the local VPC. |
RouteEntryList | Array of routeEntry |
The route entries of the local VPC. |
|
NextHopInstanceId | String | vrt-m5eb5me6c3l5sezae**** |
The instance ID of the next hop for the local VPC. |
DestinationCidr | String | 192.168.XX.XX/24 |
The destination CIDR block of the local VPC. |
PeerVpc | Object |
The details about the peer VPC. |
|
VpcName | String | Test VPC 2 |
The name of the peer VPC. |
VpcId | String | vpc-8vbwbo90rq0anm6t**** |
The ID of the peer VPC. |
AuthorizationStatus | String | authorized |
Indicates whether Cloud Firewall is authorized to access the peer VPC. The value is fixed as authorized, which indicates that Cloud Firewall is authorized to access the peer VPC. |
OwnerId | Long | 158039427902**** |
The UID of the Alibaba Cloud account to which the peer VPC belongs. |
RegionNo | String | cn-hangzhou |
The region ID of the peer VPC. |
VpcCidrTableList | Array of cidrTable |
The CIDR blocks of the peer VPC. |
|
RouteTableId | String | vtb-1256 |
The ID of the route table for the peer VPC. |
RouteEntryList | Array of routeEntry |
The route entries of the peer VPC. |
|
NextHopInstanceId | String | vrt-m5eb5me6c3l5sezae**** |
The instance ID of the next hop for the peer VPC. |
DestinationCidr | String | 192.168.XX.XX/24 |
The destination CIDR block of the peer VPC. |
IpsConfig | Object |
The configuration of the intrusion prevention system (IPS). |
|
BasicRules | Integer | 1 |
The status of basic policies. Valid values:
|
EnableAllPatch | Integer | 1 |
The status of virtual patches. Valid values:
|
RunMode | Integer | 0 |
The working mode of the IPS. Valid values:
|
MemberUid | String | 258039427902**** |
The UID of the member that is managed by your Alibaba Cloud account. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeVpcFirewallList
&Lang=zh
&RegionNo=cn-hangzhou
&VpcId=vpc-8vbwbo90rq0anm6t****
&FirewallSwitchStatus=opened
&VpcFirewallId=vfw-m5e7dbc4y****
&VpcFirewallName=Test firewall
&CurrentPage=1
&PageSize=10
&MemberUid=258039427902****
&Common request parameters
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeVpcFirewallListResponse>
<TotalCount>10</TotalCount>
<RequestId>850A84D6-0DE4-4797-A1E8-00090125k8g2</RequestId>
<VpcFirewalls>
<ConnectType>expressconnect</ConnectType>
<VpcFirewallId>vfw-m5e7dbc4y****</VpcFirewallId>
<RegionStatus>enable</RegionStatus>
<Bandwidth>2</Bandwidth>
<VpcFirewallName>Test firewall</VpcFirewallName>
<FirewallSwitchStatus>opened</FirewallSwitchStatus>
<LocalVpc>
<VpcName>Test instance</VpcName>
<VpcId>vpc-8vbwbo90rq0anm6t****</VpcId>
<AuthorizationStatus>authorized</AuthorizationStatus>
<RegionNo>cn-hangzhou</RegionNo>
<VpcCidrTableList>
<RouteTableId>vtb-1234</RouteTableId>
<RouteEntryList>
<NextHopInstanceId>vrt-m5eb5me6c3l5sezae****</NextHopInstanceId>
<DestinationCidr>192.168.XX.XX/24</DestinationCidr>
</RouteEntryList>
</VpcCidrTableList>
</LocalVpc>
<PeerVpc>
<VpcName>Test VPC 2</VpcName>
<VpcId>vpc-8vbwbo90rq0anm6t****</VpcId>
<AuthorizationStatus>authorized</AuthorizationStatus>
<RegionNo>cn-hangzhou</RegionNo>
<VpcCidrTableList>
<RouteTableId>vtb-1256</RouteTableId>
<RouteEntryList>
<NextHopInstanceId>vrt-m5eb5me6c3l5sezae****</NextHopInstanceId>
<DestinationCidr>192.168.XX.XX/24</DestinationCidr>
</RouteEntryList>
</VpcCidrTableList>
</PeerVpc>
<IpsConfig>
<BasicRules>1</BasicRules>
<EnableAllPatch>1</EnableAllPatch>
<RunMode>0</RunMode>
</IpsConfig>
<MemberUid>258039427902****</MemberUid>
</VpcFirewalls>
</DescribeVpcFirewallListResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"TotalCount" : 10,
"RequestId" : "850A84D6-0DE4-4797-A1E8-00090125k8g2",
"VpcFirewalls" : [ {
"ConnectType" : "expressconnect",
"VpcFirewallId" : "vfw-m5e7dbc4y****",
"RegionStatus" : "enable",
"Bandwidth" : 2,
"VpcFirewallName" : "Test firewall",
"FirewallSwitchStatus" : "opened",
"LocalVpc" : {
"VpcName" : "Test instance",
"VpcId" : "vpc-8vbwbo90rq0anm6t****",
"AuthorizationStatus" : "authorized",
"RegionNo" : "cn-hangzhou",
"VpcCidrTableList" : [ {
"RouteTableId" : "vtb-1234",
"RouteEntryList" : [ {
"NextHopInstanceId" : "vrt-m5eb5me6c3l5sezae****",
"DestinationCidr" : "192.168.XX.XX/24"
} ]
} ]
},
"PeerVpc" : {
"VpcName" : "Test VPC 2",
"VpcId" : "vpc-8vbwbo90rq0anm6t****",
"AuthorizationStatus" : "authorized",
"RegionNo" : "cn-hangzhou",
"VpcCidrTableList" : [ {
"RouteTableId" : "vtb-1256",
"RouteEntryList" : [ {
"NextHopInstanceId" : "vrt-m5eb5me6c3l5sezae****",
"DestinationCidr" : "192.168.XX.XX/24"
} ]
} ]
},
"IpsConfig" : {
"BasicRules" : 1,
"EnableAllPatch" : 1,
"RunMode" : 0
},
"MemberUid" : "258039427902****"
} ]
}