All Products
Search
Document Center

ApsaraDB RDS:DescribeVSwitches

Last Updated:Jun 13, 2024

Queries the details of VSwitch 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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
rds:DescribeVSwitchesRead
  • All Resources
    *
    none
none

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 ID of the zone to which the VSwitch belongs. You can call the DescribeAvailableZones operation to query zone IDs. 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 are 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 vSwitch.

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 specified.
  • 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.
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.A package instance is not allowed to operate independently.
400Price.PricingPlanResultNotFoundPricing plan price result not found.Pricing plan price result not found.
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.Your account available limit is less than 0, please recharge before trying to purchase.
400CommodityServiceCalling.ExceptionFailed to call commodity service.Failed to call commodity service return.
400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.The module you purchased is not legal, please buy it again.
400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.
400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400Price.CommoditySysCommodity system call exception.Commodity system call exception.
400Pay.InsufficientBalanceInsufficient available balance.Insufficient available balance.
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.There is a problem with the period you selected, please choose again.
400pay.noCreditCardAccount not bound to credit card.-
400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.-
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.Your basic information is not complete, please complete your basic information before operation.
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.Your account is abnormal, please contact customer service for details.
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.-
400Api.NotSupportSpecified api is not supported.The current interface does not support.
400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.The DBInstanceId provided does not exist.
400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk typeThe current instance type does not support the specified storage type.
400InvalidParamSepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
400KmsApiErrorUser secret key invalid.The user key is invalid.
400System.SaleValidateFailedSales expression validation system error.A system error occurs when the sales expression is verified.
400Abs.InvalidAccount.NotFoundaccount is not found.The account does not exist.
400SqlExecuteFailedOrTimeoutsql command execution failed or timed out:%s.SQL command execution failed or timed out
403OrderStatus.UnPaidThe specified db instance has unpaid order.The instance has an unpaid order. Please pay first and try again.
403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.The scale-in target capacity cannot be less than the current storage space usage
403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.-
403InvalidUserOperatorPermissionThe user permission does not support this operation.The user is not authorized to perform this operation.
403InvalidVswitchIdSpecified conn vswitch id is not valid.-
404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.The instance does not have permissions to access Key Management Service (KMS).
500ExternalFailureThe request processing has failed due to external service failure.The request processing has failed due to external service failure.

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.