DescribeVpcFirewallCenDetail API reference - Cloud Firewall - Alibaba Cloud - Cloud Firewall

Queries the details of a virtual private cloud (VPC) firewall that protects traffic between network instances in a Cloud Enterprise Network (CEN) instance and a specified VPC.

Operation description

This operation is used to query the details of a virtual private cloud (VPC) firewall. The VPC firewall protects traffic between network instances (including VPCs, virtual border routers (VBRs), and Cloud Connect Networks (CCNs)) in a CEN instance and a specified VPC.

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If the number of calls exceeds the limit, throttling is triggered, which may affect your business. Invoke this operation as appropriate.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-cloudfirewall:DescribeVpcFirewallCenDetail

get

*VpcFirewallCen

acs:cloudfirewall::{#accountId}:vpcfirewallcen/{#VpcFirewallId}

None

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
VpcFirewallId	string	Yes	The instance ID of the virtual private cloud (VPC) firewall. Note You can invoke the DescribeVpcFirewallCenList operation to query the instance ID of the VPC firewall.	vfw-m5e7dbc4y****
NetworkInstanceId	string	No	The VPC instance ID used to create a VPC firewall.	vpc-2zefk9fbn8j7v585g****

Response elements

Element	Type	Description	Example
	object
ConnectType	string	The connectivity type of the virtual private cloud (VPC) firewall. Valid values: cen, which indicates Cloud Enterprise Network.	cen
VpcFirewallName	string	The instance name of the virtual private cloud (VPC) firewall.	vpc-firewall-test
VpcFirewallId	string	The instance ID of the virtual private cloud (VPC) firewall.	vfw-m5e7dbc4y****
FirewallSwitchStatus	string	The switch status of the virtual private cloud (VPC) firewall. Valid values: opened: Enabled. closed: Shutdown. notconfigured: Not configured.	opened
RequestId	string	The request ID.	850A84D6-0DE4-4797-A1E8-00090125g4d2
LocalVpc	object	The VPC details.
VpcId	string	The instance ID of the VPC.	vpc-8vbwbo90rq0anm6t****
TransitRouterType	string	The version of the CEN transit router (CEN-TR). Valid values: Basic: Basic Edition. Enterprise: Enterprise Edition.	Basic
RouteMode	string	The routing mode. Valid values: auto: automatic mode. manual: manual mode.	auto
NetworkInstanceId	string	The VPC instance ID used to create a VPC firewall.	vpc-2zefk9fbn8j7v585g****
RegionNo	string	The region ID of the VPC.	cn-hangzhou
ManualVSwitchId	string	The ID of the vSwitch specified when the routing mode is manual.	vsw-zeq4o875u****
OwnerId	string	The UID of the Alibaba Cloud account to which the VPC belongs.	158039427902****
NetworkInstanceType	string	The type of the network instance. Valid values: VPC.	VPC
VpcName	string	The instance name of the VPC.	vpc-firewall-test
SupportManualMode	string	Indicates whether the routing mode supports manual mode. Valid values: 1: Supported. 0: Not supported.	0
TransitRouterId	string	The instance ID of the CEN-TR.	tr-2zetwxskej633l3u1****
AttachmentId	string	The connection ID of the network instance.	tr-attach-sxig7bye51fid5****
NetworkInstanceName	string	The name of the network instance.	test-vpc
AttachmentName	string	The connection name of the network instance.	local-test
VpcCidrTableList	array<object>	The CIDR block list of the VPC.
	array<object>
RouteTableId	string	The route table ID of the VPC.	vtb-1234
RouteEntryList	array<object>	The route entry list of the VPC.
	object
NextHopInstanceId	string	The next hop instance ID in the VPC.	vrt-m5eb5me6c3l5sezae****
DestinationCidr	string	The destination CIDR block of the VPC.	192.168.XX.XX/24
EniList	array<object>	The network interface controller (NIC) list.
	object
EniId	string	The instance ID of the network interface controller (NIC) in the VPC.	eni-8vbhfosfqv2rff42****
EniPrivateIpAddress	string	The private IP of the network interface controller (NIC) in the VPC.	192.168.XX.XX
EniVSwitchId	string	The vSwitch ID of the network interface controller (NIC) in the VPC.	vsw-wz9viido7j436b0n1****
EniZoneId	string		cn-hangzhou-i
DefendCidrList	array	The CIDR blocks protected by the virtual private cloud (VPC) firewall.
	string	The CIDR block protected by the virtual private cloud (VPC) firewall.	10.0.XX.XX/24
FirewallVpc	object	The VPC used by the firewall.
VpcId	string	The VPC instance ID.	vpc-bp1245k5oagy2bp74****
VpcCidr	string	The CIDR block of the VPC.	10.0.0.0/8
VswitchId	string	The vSwitch ID.	vsw-bp1sqg9wms9wxcs1****
VswitchCidr	string	The CIDR block of the vSwitch.	10.0.0.1/24
ZoneId `deprecated`	string	The primary zone ID of the firewall.	cn-hangzhou-i
AllowConfiguration	integer	Indicates whether the firewall VPC CIDR block is allowed to be configured when you create a VPC firewall for CEN Basic Edition. Valid values: 1: Allowed. 0: Not allowed.	0
VswitchZoneId	string	The zone ID of the vSwitch.	cn-hangzhou-i
StandbyZoneId `deprecated`	string	The secondary zone ID of the firewall.	cn-hangzhou-k
FirewallServiceMode	string	The deployment mode of the VPC firewall service. Valid values: PrimaryStandby (active/standby mode) and MultiPrimary (active-active mode).	PrimaryStandby
FirewallServiceZones	array	The zone IDs used by the VPC firewall service.
	string	The zone ID used by the VPC firewall service.	cn-hangzhou-i

Examples

Success response

JSON format

{
  "ConnectType": "cen",
  "VpcFirewallName": "vpc-firewall-test",
  "VpcFirewallId": "vfw-m5e7dbc4y****",
  "FirewallSwitchStatus": "opened",
  "RequestId": "850A84D6-0DE4-4797-A1E8-00090125g4d2",
  "LocalVpc": {
    "VpcId": "vpc-8vbwbo90rq0anm6t****",
    "TransitRouterType": "Basic",
    "RouteMode": "auto",
    "NetworkInstanceId": "vpc-2zefk9fbn8j7v585g****",
    "RegionNo": "cn-hangzhou",
    "ManualVSwitchId": "vsw-zeq4o875u****",
    "OwnerId": "158039427902****",
    "NetworkInstanceType": "VPC",
    "VpcName": "vpc-firewall-test",
    "SupportManualMode": "0",
    "TransitRouterId": "tr-2zetwxskej633l3u1****",
    "AttachmentId": "tr-attach-sxig7bye51fid5****",
    "NetworkInstanceName": "test-vpc",
    "AttachmentName": "local-test",
    "VpcCidrTableList": [
      {
        "RouteTableId": "vtb-1234",
        "RouteEntryList": [
          {
            "NextHopInstanceId": "vrt-m5eb5me6c3l5sezae****",
            "DestinationCidr": "192.168.XX.XX/24"
          }
        ]
      }
    ],
    "EniList": [
      {
        "EniId": "eni-8vbhfosfqv2rff42****",
        "EniPrivateIpAddress": "192.168.XX.XX",
        "EniVSwitchId": "vsw-wz9viido7j436b0n1****",
        "EniZoneId": "cn-hangzhou-i"
      }
    ],
    "DefendCidrList": [
      "10.0.XX.XX/24"
    ]
  },
  "FirewallVpc": {
    "VpcId": "vpc-bp1245k5oagy2bp74****",
    "VpcCidr": "10.0.0.0/8",
    "VswitchId": "vsw-bp1sqg9wms9wxcs1****",
    "VswitchCidr": "10.0.0.1/24",
    "ZoneId": "cn-hangzhou-i",
    "AllowConfiguration": 0,
    "VswitchZoneId": "cn-hangzhou-i",
    "StandbyZoneId": "cn-hangzhou-k",
    "FirewallServiceMode": "PrimaryStandby",
    "FirewallServiceZones": [
      "cn-hangzhou-i"
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorAliUid	The aliuid is invalid.	The aliuid is invalid.
400	ErrorDBSelectError	A database select error occurred.	The error message returned because an internal error has occurred in querying the database.
400	ErrorVpcFirewallId	The VPC firewall ID is invalid.	The VPC firewall ID is invalid.
400	ErrorVpcFirewallExist	The firewall has been configured and cannot be created repeatedly.	The firewall is configured and cannot be repeatedly created.
400	ErrorUnmarshalJSON	An error occurred while parsing JSON.	An error occurred while decoding JSON.
400	ErrorDBTxError	A database transaction error occurred.	The error message returned because an internal error has occurred in the database transaction.
400	ErrorVpcOpenApi	vpc open api failed	Failed to call the VPC API.
400	ErrorInvalidMemberUid	Member uid is invalid	The member is invalid.
400	ErrorVpcIdPara	vpc id and firewall id parameter not exist.	The firewall VPC parameter is incorrect. Select another one.
400	ErrorFirewallNotFound	Firewall not found	The firewall does not exist.
400	ErrorDBNoRow	No rows in database.	No data found.
400	ErrorUserNotFound	User not found	The user does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.