Queries the details about a virtual private cloud (VPC) firewall. The VPC firewall controls traffic between two VPCs that are connected by using an Express Connect circuit.

Description

You can call the DescribeVpcFirewallDetail operation to query the details about a VPC firewall. The VPC firewall controls traffic between two VPCs that are connected by using an Express Connect circuit.

Before you call the operation, make sure that you created a VPC firewall by calling the CreateVpcFirewallConfigure operation.

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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeVpcFirewallDetail

The operation that you want to perform. Set the value to DescribeVpcFirewallDetail.

Lang String No zh

The natural language of the request and response. Valid values:

  • zh: Chinese (default)
  • en: English
VpcFirewallId String Yes vfw-m5e7dbc4y****

The instance ID of the VPC firewall.

Note You can call the DescribeVpcFirewallList operation to query the instance IDs of VPC firewalls.
LocalVpcId String No vpc-8vbwbo90rq0anm6t****

The ID of the local VPC.

PeerVpcId String No vpc-90rq0anm6t8vbwbo****

The ID of the peer VPC.

Response parameters

Parameter Type Example Description
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.

RequestId String 850A84D6-0DE4-4797-A1E8-00090125g4d2

The ID of the request.

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:

  • opened: The VPC firewall is enabled.
  • closed: The VPC firewall is disabled.
  • notconfigured: The VPC firewall is not configured.
  • configured: The VPC firewall is configured.
LocalVpc Object

The details about the local VPC.

VpcId String vpc-8vbwbo90rq0anm6t****

The ID of the local VPC.

VpcName String Test instance

The name of the local VPC.

RegionNo String cn-hangzhou

The region ID of the local VPC.

EniPrivateIpAddress String 192.168.XX.XX

The private IP address of the elastic network interface (ENI) for the local VPC.

RouterInterfaceId String vrt-m5eb5me6c3l5sezae****

The router interface ID of the local VPC.

EniId String eni-8vbhfosfqv2rff42****

The ID of the ENI for 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.

VpcId String vpc-90rq0anm6t8vbwbo****

The ID of the peer VPC.

VpcName String Test VPC 2

The name of the peer VPC.

RegionNo String cn-hangzhou

The region ID of the peer VPC.

EniPrivateIpAddress String 192.168.XX.XX

The private IP address of the ENI for the peer VPC.

RouterInterfaceId String vrt-m5eb5me6c3l5sezae****

The router interface ID of the peer VPC.

EniId String eni-8vbhfosfqv2rff42****

The ID of the ENI for 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.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeVpcFirewallDetail
&Lang=zh
&VpcFirewallId=vfw-m5e7dbc4y****
&LocalVpcId=vpc-8vbwbo90rq0anm6t****
&PeerVpcId=vpc-90rq0anm6t8vbwbo****
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeVpcFirewallDetailResponse>
    <ConnectType>expressconnect</ConnectType>
    <VpcFirewallId>vfw-m5e7dbc4y****</VpcFirewallId>
    <RequestId>850A84D6-0DE4-4797-A1E8-00090125g4d2</RequestId>
    <Bandwidth>2</Bandwidth>
    <VpcFirewallName>Test firewall</VpcFirewallName>
    <FirewallSwitchStatus>opened</FirewallSwitchStatus>
    <LocalVpc>
        <VpcId>vpc-8vbwbo90rq0anm6t****</VpcId>
        <VpcName>Test instance</VpcName>
        <RegionNo>cn-hangzhou</RegionNo>
        <EniPrivateIpAddress>192.168.XX.XX</EniPrivateIpAddress>
        <RouterInterfaceId>vrt-m5eb5me6c3l5sezae****</RouterInterfaceId>
        <EniId>eni-8vbhfosfqv2rff42****</EniId>
        <VpcCidrTableList>
            <RouteTableId>vtb-1234</RouteTableId>
            <RouteEntryList>
                <NextHopInstanceId>vrt-m5eb5me6c3l5sezae****</NextHopInstanceId>
                <DestinationCidr>192.168.XX.XX/24</DestinationCidr>
            </RouteEntryList>
        </VpcCidrTableList>
    </LocalVpc>
    <PeerVpc>
        <VpcId>vpc-90rq0anm6t8vbwbo****</VpcId>
        <VpcName>Test VPC 2</VpcName>
        <RegionNo>cn-hangzhou</RegionNo>
        <EniPrivateIpAddress>192.168.XX.XX</EniPrivateIpAddress>
        <RouterInterfaceId>vrt-m5eb5me6c3l5sezae****</RouterInterfaceId>
        <EniId>eni-8vbhfosfqv2rff42****</EniId>
        <VpcCidrTableList>
            <RouteTableId>vtb-1256</RouteTableId>
            <RouteEntryList>
                <NextHopInstanceId>vrt-m5eb5me6c3l5sezae****</NextHopInstanceId>
                <DestinationCidr>192.168.XX.XX/24</DestinationCidr>
            </RouteEntryList>
        </VpcCidrTableList>
    </PeerVpc>
</DescribeVpcFirewallDetailResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "ConnectType" : "expressconnect",
  "VpcFirewallId" : "vfw-m5e7dbc4y****",
  "RequestId" : "850A84D6-0DE4-4797-A1E8-00090125g4d2",
  "Bandwidth" : 2,
  "VpcFirewallName" : "Test firewall",
  "FirewallSwitchStatus" : "opened",
  "LocalVpc" : {
    "VpcId" : "vpc-8vbwbo90rq0anm6t****",
    "VpcName" : "Test instance",
    "RegionNo" : "cn-hangzhou",
    "EniPrivateIpAddress" : "192.168.XX.XX",
    "RouterInterfaceId" : "vrt-m5eb5me6c3l5sezae****",
    "EniId" : "eni-8vbhfosfqv2rff42****",
    "VpcCidrTableList" : [ {
      "RouteTableId" : "vtb-1234",
      "RouteEntryList" : [ {
        "NextHopInstanceId" : "vrt-m5eb5me6c3l5sezae****",
        "DestinationCidr" : "192.168.XX.XX/24"
      } ]
    } ]
  },
  "PeerVpc" : {
    "VpcId" : "vpc-90rq0anm6t8vbwbo****",
    "VpcName" : "Test VPC 2",
    "RegionNo" : "cn-hangzhou",
    "EniPrivateIpAddress" : "192.168.XX.XX",
    "RouterInterfaceId" : "vrt-m5eb5me6c3l5sezae****",
    "EniId" : "eni-8vbhfosfqv2rff42****",
    "VpcCidrTableList" : [ {
      "RouteTableId" : "vtb-1256",
      "RouteEntryList" : [ {
        "NextHopInstanceId" : "vrt-m5eb5me6c3l5sezae****",
        "DestinationCidr" : "192.168.XX.XX/24"
      } ]
    } ]
  }
}