DescribeVpcFirewallDetail - Cloud Firewall - Alibaba Cloud Documentation Center

Queries the details of a VPC firewall that protects traffic between two VPCs connected by an Express Connect circuit.

Operation description

This operation queries the details of a VPC firewall. The VPC firewall protects traffic between two VPCs that are connected by an Express Connect circuit. Before you call this operation, you must create a VPC firewall by calling the CreateVpcFirewallConfigure operation.

QPS limit

This operation has a queries per second (QPS) limit of 10 calls per second for each user. If you exceed this limit, your API calls are throttled. This can affect your business. Plan your calls accordingly.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the request and response. Valid values: zh (default): Chinese. en: English.	zh
Lang	string	No	The language of the request and response. Valid values: zh (default): Chinese. en: English.	zh
VpcFirewallId	string	Yes	The instance ID of the VPC firewall. Note Call the DescribeVpcFirewallList operation to query the instance ID of the VPC firewall.	vfw-m5e7dbc4y****
LocalVpcId	string	No	The instance ID of the local VPC.	vpc-8vbwbo90rq0anm6t****
PeerVpcId	string	No	The instance ID of the peer VPC.	vpc-90rq0anm6t8vbwbo****

Response elements

Element	Type	Description	Example
	object
ConnectType	string	The connection type of the VPC firewall. The value is fixed as expressconnect, which indicates Express Connect.	expressconnect
VpcFirewallId	string	The instance ID of the VPC firewall.	vfw-m5e7dbc4y****
RequestId	string	The request ID.	850A84D6-0DE4-4797-A1E8-00090125g4d2
Bandwidth	integer	The bandwidth of the Express Connect circuit. Unit: Mbit/s.	2
VpcFirewallName	string	The instance name of the VPC firewall.	测试防火墙
FirewallSwitchStatus	string	The status of the VPC firewall. Valid values: opened: The firewall is enabled. closed: The firewall is disabled. notconfigured: The firewall is not configured. configured: The firewall is configured.	opened
LocalVpc	object	The details of the local VPC.
VpcId	string	The instance ID of the local VPC.	vpc-8vbwbo90rq0anm6t****
VpcName	string	The instance name of the local VPC.	测试用实例
RegionNo	string	The region ID of the local VPC.	cn-hangzhou
EniPrivateIpAddress	string	The private IP address of the elastic network interface (ENI) in the local VPC.	192.168.XX.XX
RouterInterfaceId	string	The ID of the router interface in the local VPC.	vrt-m5eb5me6c3l5sezae****
EniId	string	The instance ID of the ENI in the local VPC.	eni-8vbhfosfqv2rff42****
VpcCidrTableList	array<object>	A list of CIDR blocks for the local VPC.
	array<object>
RouteTableId	string	The ID of the route table for the local VPC.	vtb-1234
RouteEntryList	array<object>	A list of routes for the local VPC.
	object
NextHopInstanceId	string	The ID of the next hop instance in the local VPC.	vrt-m5eb5me6c3l5sezae****
DestinationCidr	string	The destination CIDR block of the local VPC.	192.168.XX.XX/24
PeerVpc	object	The details of the peer VPC.
VpcId	string	The instance ID of the peer VPC.	vpc-90rq0anm6t8vbwbo****
VpcName	string	The instance name of the peer VPC.	测试vpc2
RegionNo	string	The region ID of the peer VPC.	cn-hangzhou
EniPrivateIpAddress	string	The private IP address of the ENI in the peer VPC.	192.168.XX.XX
RouterInterfaceId	string	The ID of the router interface in the peer VPC.	vrt-m5eb5me6c3l5sezae****
EniId	string	The instance ID of the ENI in the peer VPC.	eni-8vbhfosfqv2rff42****
VpcCidrTableList	array<object>	A list of CIDR blocks for the peer VPC.
	array<object>
RouteTableId	string	The ID of the route table for the peer VPC.	vtb-1256
RouteEntryList	array<object>	A list of routes for the peer VPC.
	object
NextHopInstanceId	string	The ID of the next hop instance in the peer VPC.	vrt-m5eb5me6c3l5sezae****
DestinationCidr	string	The destination CIDR block of the peer VPC.	192.168.XX.XX/24
MemberUid	string	The UID of the Cloud Firewall member account.	258039427902****

Examples

Success response

JSON format

{
  "ConnectType": "expressconnect",
  "VpcFirewallId": "vfw-m5e7dbc4y****",
  "RequestId": "850A84D6-0DE4-4797-A1E8-00090125g4d2",
  "Bandwidth": 2,
  "VpcFirewallName": "测试防火墙",
  "FirewallSwitchStatus": "opened",
  "LocalVpc": {
    "VpcId": "vpc-8vbwbo90rq0anm6t****",
    "VpcName": "测试用实例",
    "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": "测试vpc2",
    "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"
          }
        ]
      }
    ]
  },
  "MemberUid": "258039427902****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorAliUid	The aliuid is invalid.	The aliuid is invalid.
400	ErrorFirewallNotFound	Firewall not found	The firewall does not exist.
400	ErrorDBSelectError	A database select error occurred.	The error message returned because an internal error has occurred in querying the database.
400	ErrorInvalidMemberUid	Member uid is invalid	The member is invalid.
400	ErrorFirewallStatus	firewall status error.	Firewall status error, please try again later.
400	ErrorVpcIdPara	vpc id and firewall id parameter not exist.	The firewall VPC parameter is incorrect. Select another one.
400	ErrorLocalVpcIdPeerVpcIdError	local vpc id and peer vpc id cannot be empty at the same time.	The firewall VPC parameter is incorrect. Select another one.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.