All Products
Search
Document Center

ApsaraDB RDS:DescribeVSwitches

Last Updated:Jan 16, 2024

Queries the details of vSwitches that are available in a virtual private cloud (VPC).

Operation description

Supported database engines

  • MySQL
  • PostgreSQL
  • SQL Server
  • MariaDB

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID of the vSwitch. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
VpcIdstringNo

The ID of the VPC to which the vSwitch belongs.

Note You must configure this parameter or DedicatedHostGroupId.
vpc-bp1opxu1zkhn**********
ZoneIdstringNo

The zone ID of the vSwitch. You can call the DescribeAvailableZones operation to query the zone ID. If you specify this parameter, the query results are filtered based on the value of this parameter and only the details of the vSwitch that is deployed in the specified zone is returned.

cn-hangzhou-i
DedicatedHostGroupIdstringNo

The dedicated cluster ID. You can call the DescribeDedicatedHostGroups operation to query the dedicated cluster ID. If you specify this parameter, the details of all vSwitches in the VPC to which the dedicated cluster belongs are returned.

Note You must specify this parameter or the VpcId parameter.
dhg-7a9********
PageNumberintegerNo

The number of the page to return. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Valid values: 1 to 50. Default value: 30.

30
ResourceGroupIdstringNo

The ID of the resource group.

rg-bp67acfmxazb4p****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

8A68AEA1-AFBD-53F8-9BBB-06555EAE5C0E
TotalCountinteger

The total number of returned entries.

2
PageNumberinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned on each page. The value of this parameter is the same as the value of the PageSize parameter in the request parameters.

30
VSwitchsobject []

The information about the vSwitches.

CidrBlockstring

The CIDR block of the vSwitch.

172.16.0.0/24
Descriptionstring

The description of the vSwitch.

VSwitchDescription
IsDefaultboolean

Indicates whether the vSwitch is the default vSwitch. Valid values:

  • true
  • false
true
IzNostring

The ID of the zone to which the vSwitch belongs.

cn-hangzhou-h
Statusstring

The status of the vSwitch. Valid values:

  • Pending: The vSwitch is being configured.
  • Available: The vSwitch is available.
Available
VSwitchIdstring

The vSwitch ID.

vsw-bp1pnaz94xc**********
VSwitchNamestring

The vSwitch name.

test
AvailableIpAddressCountstring

The number of available IP addresses in the vSwitch.

1

Examples

Sample success responses

JSONformat

{
  "RequestId": "8A68AEA1-AFBD-53F8-9BBB-06555EAE5C0E",
  "TotalCount": 2,
  "PageNumber": 1,
  "PageSize": 30,
  "VSwitchs": [
    {
      "CidrBlock": "172.16.0.0/24",
      "Description": "VSwitchDescription",
      "IsDefault": true,
      "IzNo": "cn-hangzhou-h",
      "Status": "Available",
      "VSwitchId": "vsw-bp1pnaz94xc**********",
      "VSwitchName": "test",
      "AvailableIpAddressCount": "1"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidVSwitchId.NotFoundSpecified virtual switch is not found in specified VPC.No vSwitch is available in the VPC.
400IncorrecttVpcIdThe specified parameter VPCId is not valid.The value of the VPCId parameter is invalid. Specify a valid value.
400InvalidIzNo.NotSupportedSpecified VPC zone is not supported.The VPC cannot be found in the zone. Specify a different VPC and try again.

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

Change history

Change timeSummary of changesOperation
2022-07-27The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ResourceGroupId
2021-09-08The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.