All Products
Search
Document Center

ApsaraDB for MongoDB:DescribeRdsVSwitchs

Last Updated:Mar 26, 2026

Retrieves a list of vSwitches.

Operation description

Queries the vSwitches that are available in a specified region and zone. Use this before creating an ApsaraDB for MongoDB instance to select a vSwitch.

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

VpcId

string

No

The ID of VPC.

vpc-bp*******************

ZoneId

string

No

The zone ID.

cn-hangzhou-j

ResourceGroupId

string

No

The resource group ID.

rg-acfm4ojaksxxxxx

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

60EEBD77-227C-5B39-86EA-D89163C5****

VSwitches

object

The list of vSwitches.

VSwitch

array<object>

The vSwitch information.

object

Status

string

The status of the vSwitch. A value of Available indicates that the vSwitch is active.

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-bp*******************

CidrBlock

string

The CIDR block of the vSwitch.

192.**.**.0/24

RegionNo

string

This parameter is deprecated. No value is returned.

null

GmtCreate

string

This parameter is deprecated. No value is returned.

null

AliUid

string

This parameter is deprecated. No value is returned.

null

GmtModified

string

This parameter is deprecated. No value is returned.

null

Bid

string

This parameter is deprecated. No value is returned.

null

IzNo

string

The zone ID.

cn-hangzhou-h

VSwitchName

string

The name of the vSwitch.

vsw-name

Examples

Success response

JSON format

{
  "RequestId": "60EEBD77-227C-5B39-86EA-D89163C5****",
  "VSwitches": {
    "VSwitch": [
      {
        "Status": "Available",
        "IsDefault": true,
        "VSwitchId": "vsw-bp*******************\n",
        "CidrBlock": "192.**.**.0/24\n",
        "RegionNo": "null",
        "GmtCreate": "null",
        "AliUid": "null",
        "GmtModified": "null",
        "Bid": "null",
        "IzNo": "cn-hangzhou-h\n",
        "VSwitchName": "vsw-name\n"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.