DescribeTrFirewallsV2List - Cloud Firewall - Alibaba Cloud Documentation Center

Queries the virtual private cloud (VPC) firewalls that are created for transit routers.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the content within the response. Valid values: zh: Chinese (default) en: English	zh
RegionNo	string	No	The region ID of the transit router.	cn-hangzhou
FirewallSwitchStatus	string	No	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 created. configured: The VPC firewall is created but is not enabled. creating: The VPC firewall is being created. opening: The VPC firewall is being enabled. deleting: The VPC firewall is being deleted. Note If you do not specify this parameter, VPC firewalls in all states are queried.	opened
CurrentPage	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10.	10
FirewallId	string	No	The instance ID of the VPC firewall.	vfw-tr-f1799baa9e254651****
FirewallName	string	No	The name of the VPC firewall.	test
RouteMode	string	No	The routing mode of the VPC firewall. Valid values: managed: automatic mode manual: manual mode Note If you do not specify this parameter, VPC firewalls in all routing modes are queried.	managed
CenId	string	No	The ID of the Cloud Enterprise Network (CEN) instance.	cen-rig0t5zi96crkl****
TransitRouterId	string	No	The ID of the transit router.	tr-uf6egtvyaedvt20xl****

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	string	The total number of entries returned.	6
RequestId	string	The request ID.	1471E2EC-F706-5F11-A79B-BD583ACB8297
VpcTrFirewalls	array<object>	The VPC firewalls.
	object
VpcFirewallName	string	The instance name of the VPC firewall.	test
FirewallSwitchStatus	string	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 created. configured: The VPC firewall is created but is not enabled. creating: The VPC firewall is being created. opening: The VPC firewall is being enabled. deleting: The VPC firewall is being deleted. Note If you do not specify this parameter, VPC firewalls in all states are queried.	opened
CenId	string	The ID of the CEN instance.	cen-03f8s0z052ka3v****
CenName	string	The name of the CEN instance.	cen_swas
RouteMode	string	The routing mode of the VPC firewall. Valid values: managed: automatic mode manual: manual mode	managed
RegionStatus	string	Indicates whether you can create a VPC firewall in a specified region. Valid values: enable: yes disable: no	enable
ResultCode	string	The result code of the operation that creates the VPC firewall. Valid values: RegionDisable: VPC Firewall is not supported in the region of the network instance. You cannot create a VPC firewall for the network instance. Empty string: You can create a VPC firewall for the network instance.	RegionDisable
RegionNo	string	The region ID of the transit router.	cn-hangzhou
TransitRouterId	string	The ID of the transit router.	tr-2vcmhjs88nil55fvu****
FirewallId	string	The instance ID of the VPC firewall.	vfw-tr-99bc4f0fc88b4d00****
IpsConfig	object	The information about the intrusion prevention system (IPS) configuration.
BasicRules	integer	Indicates whether basic protection is enabled. Valid values: 1: yes 0: no	1
EnableAllPatch	integer	Indicates whether virtual patching is enabled. Valid values: 1: yes 0: no	1
RunMode	integer	The mode of the IPS. Valid values: 1: block mode 0: monitor mode	1
OwnerId	long	The ID of the Alibaba Cloud account to which the VPC belongs.	171761785151****
PrecheckStatus	string	Indicates whether the VPC firewall can be automatically enabled. Valid values: passed: yes failed: no unknown	passed
ProtectedResource	object	The protected resources.
Count	integer	The number of protected resources.	1
VpcList	array	The protected VPCs.
	string	The protected VPC.	["vpc-2zegxdvs5f2je81ph****"]
VbrList	array	The protected virtual border routers (VBRs).
	string	The protected VBR.	[ "vbr-2zegxdvs5f2je81ph****" ]
VpnList	array	The protected VPN gateways.
	string	The protected VPN gateway.	[ "vpn-2zegxdvs5f2je81ph****" ]
PeerTrList	array	The protected peer transit routers.
	string	The protected peer transit router.	[ "tr-2zegxdvs5f2je81ph****" ]
UnprotectedResource	object	The unprotected resources.
Count	integer	The number of unprotected resources.	1
VpcList	array	The unprotected VPCs.
	string	The unprotected VPC.	[ "vpc-2zegxdvs5f2je81ph****" ]
VbrList	array	The unprotected VBRs.
	string	The unprotected VBR.	[ "vbr-2zegxdvs5f2je81ph****" ]
VpnList	array	The unprotected VPN gateways.
	string	The unprotected VPN gateway.	[ "vpn-2zegxdvs5f2je81ph****" ]
PeerTrList	array	The unprotected peer transit routers.
	string	The unprotected peer transit router.	[ "tr-2zegxdvs5f2je81ph****" ]

Examples

Sample success responses

JSONformat

{
  "TotalCount": "6",
  "RequestId": "1471E2EC-F706-5F11-A79B-BD583ACB8297",
  "VpcTrFirewalls": [
    {
      "VpcFirewallName": "test",
      "FirewallSwitchStatus": "opened",
      "CenId": "cen-03f8s0z052ka3v****",
      "CenName": "cen_swas",
      "RouteMode": "managed",
      "RegionStatus": "enable",
      "ResultCode": " RegionDisable",
      "RegionNo": "cn-hangzhou",
      "TransitRouterId": "tr-2vcmhjs88nil55fvu****",
      "FirewallId": "vfw-tr-99bc4f0fc88b4d00****",
      "IpsConfig": {
        "BasicRules": 1,
        "EnableAllPatch": 1,
        "RunMode": 1
      },
      "OwnerId": 0,
      "PrecheckStatus": "passed",
      "ProtectedResource": {
        "Count": 1,
        "VpcList": [
          "[\"vpc-2zegxdvs5f2je81ph****\"]"
        ],
        "VbrList": [
          "[\n      \"vbr-2zegxdvs5f2je81ph****\"\n]"
        ],
        "VpnList": [
          "[\n      \"vpn-2zegxdvs5f2je81ph****\"\n]"
        ],
        "PeerTrList": [
          "[\n      \"tr-2zegxdvs5f2je81ph****\"\n]"
        ]
      },
      "UnprotectedResource": {
        "Count": 1,
        "VpcList": [
          "[\n      \"vpc-2zegxdvs5f2je81ph****\"\n]"
        ],
        "VbrList": [
          "[\n      \"vbr-2zegxdvs5f2je81ph****\"\n]"
        ],
        "VpnList": [
          "[\n      \"vpn-2zegxdvs5f2je81ph****\"\n]"
        ],
        "PeerTrList": [
          "[\n      \"tr-2zegxdvs5f2je81ph****\"\n]"
        ]
      }
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-08-15	The response structure of the API has changed	View Change Details
2023-06-13	The response structure of the API has changed	View Change Details