All Products
Search
Document Center

Cloud Firewall:DescribeFirewallVSwitch

Last Updated:Oct 16, 2025

Queries the vSwitches that are created by Cloud Firewall.

Operation description

QPS limit

The queries per second (QPS) limit for this operation is 10 per user. If you exceed the limit, API calls are throttled, which may affect your business. Therefore, call this operation at a reasonable rate.

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. Valid values:

zh

Lang

string

No

The language type.

zh

RegionNo

string

No

The region ID.

cn-beijing

VpcId

string

No

The ID of the VPC instance.

vpc-uf6b5lyul0x******

VswitchId

string

No

The ID of the vSwitch.

vsw-bp1sqg9w******

FirewallId

string

No

The instance ID of the VPC border firewall.

vfw-tr-5b202e7f0be64611****

MemberUid

string

No

The UID of the member account.

102910763545****

PageNo

string

No

The page number.

1

PageSize

string

No

The number of the page to return.

10

Response elements

Element

Type

Description

Example

object

TotalCount

integer

The total number of entries.

20

RequestId

string

The ID of the request.

A1562A68-99FA-5D6B-BD5B-2F959F25****

VswitchList

array<object>

The list of vSwitches.

array<object>

The list of vSwitches.

VpcId

string

The ID of the VPC instance.

vpc-2zeez7gymz5r4pi****am

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.

10

VswitchName

string

The name of the vSwitch.

vsw-test

RegionNo

string

The region ID.

cn-shanghai

MemberUid

string

The UID of the member account.

184480249330****

ZoneId

string

The zone ID.

cn-shanghai-b

FirewallCount

string

The number of intrusion prevention events.

10

FirewallList

array<object>

The list of firewalls.

object

The list of firewalls.

FirewallName

string

The name of the Cloud Firewall.

test-Firewall

FirewallId

string

The instance ID of the firewall.

vfw-tr-37145c8f5ede45e9****

Examples

Success response

JSON format

{
  "TotalCount": 20,
  "RequestId": "A1562A68-99FA-5D6B-BD5B-2F959F25****",
  "VswitchList": [
    {
      "VpcId": "vpc-2zeez7gymz5r4pi****am",
      "CidrBlock": "192.168.0.XX/16",
      "VswitchId": "vsw-bp10qla9mgi42eo****",
      "AvailableIpCount": "10",
      "VswitchName": "vsw-test",
      "RegionNo": "cn-shanghai",
      "MemberUid": "184480249330****",
      "ZoneId": "cn-shanghai-b",
      "FirewallCount": "10",
      "FirewallList": [
        {
          "FirewallName": "test-Firewall",
          "FirewallId": "vfw-tr-37145c8f5ede45e9****"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.