DescribeRdsVSwitchs

Updated at:

Queries a list of vSwitches.

Operation description

Call this operation to query the vSwitches that are available in the destination region and zone when you create an ApsaraDB for MongoDB instance.

Try it now

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

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 for a complete list.

Release notes

See 变更详情 for a complete list.