DescribeVpcFirewallList - Cloud Firewall - Alibaba Cloud Documentation Center

Queries information about a VPC firewall that protects traffic between two VPCs connected by an Express Connect circuit.

Operation description

This operation queries a paginated list of VPC firewalls. These firewalls protect traffic between two VPCs that are connected using Express Connect.

QPS limit

Each Alibaba Cloud account can send up to 10 queries per second (QPS). If this limit is exceeded, API calls are throttled. This may 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
RegionNo	string	No	The region ID of the VPC. Note For more information about the regions where Cloud Firewall is supported, see Supported regions.	cn-hangzhou
VpcId	string	No	The instance ID of the VPC.	vpc-8vbwbo90rq0anm6t****
FirewallSwitchStatus	string	No	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. 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.	测试环境防火墙
CurrentPage	string	No	The page number. Default value: 1.	1
PageSize	string	No	The number of entries per page. Default value: 10. Maximum value: 50.	10
MemberUid	string	No	The UID of the member account.	258039427902****
ConnectSubType	string	No	The subtype of the connection. Valid values: vpc2vpc: Express Connect. vpcpeer: peering connection.	vpcpeer
PeerUid	string	No	The UID of the Alibaba Cloud account to which the peer VPC belongs.	258039427902****

Response elements

Element	Type	Description	Example
	object	The list of VPC firewalls.
TotalCount	integer	The total number of VPC firewalls.	10
RequestId	string	The request ID.	850A84D6-0DE4-4797-A1E8-00090125k8g2
VpcFirewalls	array<object>	The details of the VPC firewalls.
	array<object>	The details of the VPC firewalls.
ConnectType	string	The type of connection for the VPC firewall. The value is fixed as expressconnect, which indicates an Express Connect circuit.	expressconnect
VpcFirewallId	string	The instance ID of the VPC firewall.	vfw-m5e7dbc4y****
RegionStatus	string	The status of the region. Valid values: enable: The region is available. You can create a VPC firewall in this region. disable: The region is unavailable. You cannot create a VPC firewall in this region.	enable
Bandwidth	integer	The bandwidth of the Express Connect circuit. Unit: Mbps.	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.	opened
LocalVpc	object	The details of the local VPC.
VpcName	string	The instance name of the local VPC.	测试用实例
VpcId	string	The instance ID of the local VPC.	vpc-8vbwbo90rq0anm6t****
AuthorizationStatus	string	The authorization status of the local VPC. The value is fixed as authorized.	authorized
OwnerId	integer	The UID of the Alibaba Cloud account to which the local VPC belongs.	158039427902****
RegionNo	string	The region ID of the local VPC.	cn-hangzhou
VpcCidrTableList	array<object>	The CIDR blocks of the local VPC.
	array<object>	The CIDR blocks of the local VPC.
RouteTableId	string	The ID of the route table for the local VPC.	vtb-1234
RouteEntryList	array<object>	The route entries of the local VPC.
	object	The route entries of the local VPC.
NextHopInstanceId	string	The ID of the next hop instance for 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.
VpcName	string	The instance name of the peer VPC.	测试vpc2
VpcId	string	The instance ID of the peer VPC.	vpc-8vbwbo90rq0anm6t****
AuthorizationStatus	string	The authorization status of the peer VPC. The value is fixed as authorized.	authorized
OwnerId	integer	The UID of the Alibaba Cloud account to which the peer VPC belongs.	158039427902****
RegionNo	string	The region ID of the peer VPC.	cn-hangzhou
VpcCidrTableList	array<object>	The CIDR blocks of the peer VPC.
	array<object>	The CIDR blocks of the peer VPC.
RouteTableId	string	The ID of the route table for the peer VPC.	vtb-1256
RouteEntryList	array<object>	The route entries of the peer VPC.
	object	The route entries of the peer VPC.
NextHopInstanceId	string	The ID of the next hop instance for the peer VPC.	vrt-m5eb5me6c3l5sezae****
DestinationCidr	string	The destination CIDR block of the peer VPC.	192.168.XX.XX/24
IpsConfig	object	The configuration of the intrusion prevention system (IPS).
BasicRules	integer	The status of the basic policies. Valid values: 1: enabled. 0: disabled.	1
EnableAllPatch	integer	The status of virtual patching. Valid values: 1: enabled. 0: disabled.	1
RunMode	integer	The IPS mode. Valid values: 1: Block Mode. 0: Monitor mode.	0
RuleClass	integer	The IPS rule group. Valid values: 1: Loose. 2: Medium. 3: Strict.	1
MemberUid	string	The UID of the member account.	258039427902****
ResultCode	string	The result code of the VPC firewall creation. Valid values: Unauthorized: An unauthorized VPC exists. You cannot create a VPC firewall. RegionDisable: The VPC is in a region where VPC firewalls are not supported. You cannot create a VPC firewall. An empty string: You can create a VPC firewall for the network instance.	Unauthorized
ConnectSubType	string	The subtype of the connection. Valid values: vpc2vpc: Express Connect. vpcpeer: peering connection.	vpcpeer
AclConfig	object	The mode of the access control list (ACL) engine.
StrictMode	integer	Indicates whether to enable strict mode. Valid values: 1: enabled 0: disabled	1

Examples

Success response

JSON format

{
  "TotalCount": 10,
  "RequestId": "850A84D6-0DE4-4797-A1E8-00090125k8g2",
  "VpcFirewalls": [
    {
      "ConnectType": "expressconnect",
      "VpcFirewallId": "vfw-m5e7dbc4y****",
      "RegionStatus": "enable",
      "Bandwidth": 2,
      "VpcFirewallName": "测试防火墙",
      "FirewallSwitchStatus": "opened",
      "LocalVpc": {
        "VpcName": "测试用实例",
        "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": "测试vpc2",
        "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",
      "AclConfig": {
        "StrictMode": 1
      }
    }
  ]
}

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.