DescribeFirewallVswitchResources - Cloud Firewall - Alibaba Cloud Documentation Center

Queries the vSwitch resources for Cloud Firewall.

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 response message. Valid values: en : English zh : Chinese	zh
Lang	string	No	The language of the response message. Valid values: en : English zh : Chinese	zh
RegionNo	string	Yes	The region.	cn-hangzhou
VpcId	string	Yes	The ID of the VPC instance.	vpc-2ze36yb348axtnf****
FirewallType	string	Yes	The type of the Cloud Firewall.	internet

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries.	10
RequestId	string	The ID of the request.	A81E99DF-07CF-5EE4-966A-9FF9F2F****
VswitchList	array<object>	The list of vSwitches.
	array<object>	The list of vSwitches.
Status	string	The configuration status.	open
CidrBlock	string	The IPv4 CIDR block.	192.168.0.XX/16
VswitchId	string	The ID of the vSwitch.	vsw-bp10qla9mgi42eo****
AvailableIpCount	string	The number of available IP addresses in the zone.	10
VswitchName	string	The name of the vSwitch.	vsw-test
RouteTableType	string	The type of the route table. Valid values: Custom: a custom route table. System: a system route table.	Custom
ZoneId	string	The ID of the zone.	cn-shanghai-b
RouteTableId	string	The ID of the route table.	vtb-uf6ml7rgw5gzzdr****
Detail	string	The details of the event.	[]
FirewallList	array<object>	The list of firewalls.
	object	The list of firewalls.
FirewallId	string	The ID of the firewall instance.	vfw-tr-37145c8f5ede45e9****
FirewallName	string	The name of the Cloud Firewall.	test-Firewall
FirewallType	string	The type of the Cloud Firewall.	NatFirewall

Examples

Success response

JSON format

{
  "TotalCount": 10,
  "RequestId": "A81E99DF-07CF-5EE4-966A-9FF9F2F****",
  "VswitchList": [
    {
      "Status": "open",
      "CidrBlock": "192.168.0.XX/16",
      "VswitchId": "vsw-bp10qla9mgi42eo****",
      "AvailableIpCount": "10",
      "VswitchName": "vsw-test",
      "RouteTableType": "Custom",
      "ZoneId": "cn-shanghai-b",
      "RouteTableId": "vtb-uf6ml7rgw5gzzdr****",
      "Detail": "[]",
      "FirewallList": [
        {
          "FirewallId": "vfw-tr-37145c8f5ede45e9****",
          "FirewallName": "test-Firewall",
          "FirewallType": "NatFirewall"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorAliUid	Aliuid invalid.	The aliuid is invalid.
400	ErrorVpcIdError	vpc id invalid	The specified VPC is invalid. Specify another value.
400	ErrorDBSelectError	A database select error occurred.	The error message returned because an internal error has occurred in querying the database.
400	ErrorVswitchNotFound	vswitch not found	The vSwitch does not exist. Select another vSwitch.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.