Queries the details of vSwitches that are available in a virtual private cloud (VPC).
Operation description
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | No | The region ID of the vSwitch. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
VpcId | string | No | The ID of the VPC to which the vSwitch belongs. Note
You must configure this parameter or DedicatedHostGroupId.
| vpc-bp1opxu1zkhn********** |
ZoneId | string | No | 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 |
DedicatedHostGroupId | string | No | 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******** |
PageNumber | integer | No | The number of the page to return. Default value: 1. | 1 |
PageSize | integer | No | The number of entries to return on each page. Valid values: 1 to 50. Default value: 30. | 30 |
ResourceGroupId | string | No | The ID of the resource group. | rg-bp67acfmxazb4p**** |
Response parameters
Examples
Sample success responses
JSON
format
{
"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 code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidVSwitchId.NotFound | Specified virtual switch is not found in specified VPC. | No vSwitch is available in the VPC. |
400 | IncorrecttVpcId | The specified parameter VPCId is not valid. | The value of the VPCId parameter is invalid. Specify a valid value. |
400 | InvalidIzNo.NotSupported | Specified 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 time | Summary of changes | Operation | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2022-07-27 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||
| ||||||||||
2021-09-08 | The Error code has changed. The response structure of the API has changed | see changesets | ||||||||
|