All Products
Search
Document Center

Cloud Firewall:DescribeTrFirewallsV2Detail

Last Updated:Mar 01, 2024

Queries the details of 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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language of the content within the response. Valid values:

  • zh: Chinese (default)
  • en: English
zh
FirewallIdstringNo

The instance ID of the VPC firewall.

vfw-tr-a5a6b89f46764928****

Response parameters

ParameterTypeDescriptionExample
object
FirewallNamestring

The name of the VPC firewall.

cloudfirewall-manual
RequestIdstring

The request ID.

7E53A7FB-3EB9-5E33-8E50-B8F417D1E02B
FirewallIdstring

The instance ID of the VPC firewall.

vfw-tr-9c7c711abdfa4d80****
FirewallStatusstring

The status of the VPC firewall. Valid values:

  • Creating
  • Deleting
  • Ready
Ready
CenIdstring

The ID of the Cloud Enterprise Network (CEN) instance.

cen-37nddhri7jf0d2****
TransitRouterIdstring

The ID of the transit router.

tr-wz9y8sgug8b1xb416****
RegionNostring

The region ID of the transit router.

cn-shanghai
FirewallEniIdstring

The ID of the Elastic Network Interface (ENI) with which the VPC firewall is associated.

eni-uf621u00nafypeex****
FirewallEniVpcIdstring

The ID of the VPC to which the ENI is attached.

vpc-2zeppcci782zeh2bk****
FirewallEniVswitchIdstring

The ID of the vSwitch with which the ENI is associated.

vsw-uf6ptq1kl1c1d9pw9****
FirewallDescriptionstring

The description of the VPC firewall.

VPC Firewall
RouteModestring

The routing mode of the VPC firewall. Valid values:

  • managed: automatic mode
  • manual: manual mode
managed
FirewallSwitchStatusstring

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
FirewallVpcCidrstring

The CIDR block that is allocated to the VPC created for the VPC firewall in automatic mode.

10.0.0.0/16
FirewallSubnetCidrstring

The subnet CIDR block of the VPC in which the ENI of the firewall is stored in automatic mode.

10.0.1.0/24
TrAttachmentMasterCidrstring

The primary subnet CIDR block that the VPC uses to connect to the transit router in automatic mode.

10.0.2.0/24
TrAttachmentSlaveCidrstring

The secondary subnet CIDR block that the VPC uses to connect to the transit router in automatic mode.

10.0.3.0/24

Examples

Sample success responses

JSONformat

{
  "FirewallName": "cloudfirewall-manual",
  "RequestId": "7E53A7FB-3EB9-5E33-8E50-B8F417D1E02B",
  "FirewallId": "vfw-tr-9c7c711abdfa4d80****",
  "FirewallStatus": "Ready",
  "CenId": "cen-37nddhri7jf0d2****",
  "TransitRouterId": "tr-wz9y8sgug8b1xb416****",
  "RegionNo": "cn-shanghai",
  "FirewallEniId": "eni-uf621u00nafypeex****",
  "FirewallEniVpcId": "vpc-2zeppcci782zeh2bk****",
  "FirewallEniVswitchId": "vsw-uf6ptq1kl1c1d9pw9****",
  "FirewallDescription": "VPC Firewall",
  "RouteMode": "managed",
  "FirewallSwitchStatus": "opened",
  "FirewallVpcCidr": "10.0.0.0/16",
  "FirewallSubnetCidr": "10.0.1.0/24",
  "TrAttachmentMasterCidr": "10.0.2.0/24",
  "TrAttachmentSlaveCidr": "10.0.3.0/24"
}

Error codes

HTTP status codeError codeError message
400ErrorTrFirewallNotExistCen TR firewall not exist

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

Change history

Change timeSummary of changesOperation
2023-07-20The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Added Error Codes: 400
2023-07-19The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.