All Products
Search
Document Center

AnalyticDB:DescribeVSwitchs

Last Updated:Aug 28, 2026

Queries available vSwitches.

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

RegionId

string

No

The region ID.

Note

You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou

VpcId

string

No

The virtual private cloud (VPC) ID.

Note

You can call the DescribeDBClusters operation to query the VPC ID.

vpc-2ze1lz7nk4pn4zwy1j7pm

ZoneId

string

No

The zone ID.

Note

You can call the DescribeRegions operation to query the most recent zone list.

cn-hangzhou-h

Response elements

Element

Type

Description

Example

object

The response parameters.

RequestId

string

The request ID.

1B892DA2-9ABC-5CC0-AD73-405479C3FA53

VSwitches

object

The queried vSwitches.

vSwitch

array<object>

The queried vSwitch.

object

Details of the vSwitch.

Status

string

The state of the vSwitch. Valid values: Pending: the vSwitch is being configured. Available: the vSwitch is available.

Available

IsDefault

boolean

Indicates whether the vSwitch is the default vSwitch. Valid values: true: The vSwitch is the default vSwitch. false: The vSwitch is not the default vSwitch.

true

VSwitchId

string

The vSwitch ID.

vsw-25bcdxs7pv1****

CidrBlock

string

The IPv4 CIDR block of the vSwitch.

172.16.0.0/24

RegionNo

string

The region ID of the vSwitch.

cn-hangzhou

GmtCreate

string

The time when the vSwitch was created.

2022-01-18T12:43:57Z

AliUid

string

The ID of the Resource Access Management (RAM) user.

195813423043****

GmtModified

string

The time when the vSwitch was modified.

2022-01-22T12:43:57Z

Bid

string

The ID of the user channel.

26842

IzNo

string

The zone ID of the vSwitch.

cn-hangzhou-k

VSwitchName

string

The name of the vSwitch.

VSW-test-Hangzhou-I

Examples

Success response

JSON format

{
  "RequestId": "1B892DA2-9ABC-5CC0-AD73-405479C3FA53",
  "VSwitches": {
    "VSwitch": [
      {
        "Status": "Available",
        "IsDefault": true,
        "VSwitchId": "vsw-25bcdxs7pv1****",
        "CidrBlock": "172.16.0.0/24",
        "RegionNo": "cn-hangzhou",
        "GmtCreate": "2022-01-18T12:43:57Z",
        "AliUid": "195813423043****",
        "GmtModified": "2022-01-22T12:43:57Z",
        "Bid": "26842",
        "IzNo": "cn-hangzhou-k",
        "VSwitchName": "VSW-test-Hangzhou-I"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.