All Products
Search
Document Center

AnalyticDB for MySQL:DescribeVSwitches

Last Updated:Apr 23, 2024

Queries the vSwitches.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID.

Note You can call the DescribeRegions operation to query the most recent region list.
cn-hangzhou
VpcIdstringNo

The virtual private cloud (VPC) ID.

Note You can call the DescribeDBClusters operation to query the VPC ID.
vpc-bp13h7uzhulpuxvnp****
ZoneIdstringNo

The zone ID.

Note You can call the DescribeRegions operation to query the most recent zone list.
cn-hangzhou-h
VswIdstringNo

The vSwitch ID.

vsw-8vbpu1teend1qcosfojlz

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

D65A809F-34CE-4550-9BC1-0ED21ETG380
VSwitchesobject

The queried vSwitches.

VSwitchobject []

The queried vSwitch.

Statusstring

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

Available
IsDefaultboolean

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.

false
VSwitchIdstring

The vSwitch ID.

vsw-25bcdxs7pv1****
CidrBlockstring

The IPv4 CIDR block of the vSwitch.

172.16.0.0/24
RegionNostring

The region ID of the vSwitch.

cn-hangzhou
GmtCreatestring

The time when the vSwitch was created.

2022-01-18T12:43:57Z
AliUidstring

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

195813423043****
GmtModifiedstring

The time when the vSwitch was modified.

2022-01-22T12:43:57Z
Bidstring

The ID of the user channel.

2****
IzNostring

The zone ID of the vSwitch.

cn-hangzhou-k
VSwitchNamestring

The name of the vSwitch.

vswitch

Examples

Sample success responses

JSONformat

{
  "RequestId": "D65A809F-34CE-4550-9BC1-0ED21ETG380",
  "VSwitches": {
    "VSwitch": [
      {
        "Status": "Available",
        "IsDefault": false,
        "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": "2****",
        "IzNo": "cn-hangzhou-k",
        "VSwitchName": "vswitch"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
500InternalErrorAn error occurred while processing your request.An internal error occurred. Please try again later.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history