Queries vSwitches in a specified zone.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
The region ID. |
cn-hangzhou |
| VpcId |
string |
Yes |
The VPC ID of the instance. |
vpc-bp175iuvg8nxqraf2**** |
| ZoneId |
string |
Yes |
The zone ID. |
cn-hangzhou-i |
| PageSize |
integer |
No |
The number of entries to return on each page. |
10 |
| PageNumber |
integer |
No |
The page number to return. |
1 |
| MaxResults |
integer |
No |
The number of entries to return on each page. Warning This is a reserved parameter and is not supported. |
20 |
| NextToken |
string |
No |
The token that is used to start the next query. Warning This is a reserved parameter and is not supported. |
4ea98363565e4951e0b5e8707e68181f |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response schema. |
||
| RequestId |
string |
The request ID. |
4773E4EC-025D-509F-AEA9-D53123FDFB0F |
| TotalRecordCount |
string |
The total number of records. |
15 |
| PageNumber |
string |
The current page number. |
1 |
| PageSize |
string |
The number of entries on the current page. |
10 |
| Items |
array<object> |
The list of results. |
|
|
object |
The list of results. |
||
| ZoneId |
string |
The zone ID. |
cn-hangzhou-i |
| VSwitchId |
string |
The vSwitch ID. |
vsw-bp1usf8eabhvibkkfde96 |
| VSwitchName |
string |
The vSwitch name. |
subnet |
| NextToken |
string |
The token that is used to start the next query. If this parameter is empty, all results have been returned. |
459a0909c0315bfbe0b5e8707e68181f |
| MaxResults |
integer |
The number of entries returned per page. |
10 |
Examples
Success response
JSON format
{
"RequestId": "4773E4EC-025D-509F-AEA9-D53123FDFB0F",
"TotalRecordCount": "15",
"PageNumber": "1",
"PageSize": "10",
"Items": [
{
"ZoneId": "cn-hangzhou-i",
"VSwitchId": "vsw-bp1usf8eabhvibkkfde96",
"VSwitchName": "subnet"
}
],
"NextToken": "459a0909c0315bfbe0b5e8707e68181f",
"MaxResults": 10
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | SystemError | A system error occurred while processing your request. | The system is abnormal. |
| 400 | ClusterNotSupport | Current instance cluster does not support this operation. | The operation is not supported in the current cluster state. |
| 400 | Forbidden | User not authorized to operate on the specified resource, or this API does not support RAM. | english description1 |
| 400 | InvalidChargeType.NotSupport | The specified parameter "ChargeType" does not meet the requirements. | |
| 400 | InvalidDBName.Duplicate | Specified DB name already exists in the This instance. | New Cluster Name |
| 400 | InvalidClusterName.Format | Specified ClusterName is not valid. It can not be empty string. | The entered cluster name parameter is invalid. |
| 400 | MinorVersionNotSupport | The instance version does not support the current operation. | The instance version does not support the current operation. |
| 403 | DBClusterNotSupported | The requested operation can not be performed while the cluster is not sale. | The requested operation cannot be performed while the cluster is not running. |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | english description1 |
| 403 | OperationDenied.VirtualClusterBound | The operation is not permitted due to it has been bound to a virtual cluster. | Operation is not allowed because it is bound to a virtual cluster. |
| 404 | DBInstanceLocked | The current instance lock mode does not support this operation. | english description1 |
| 404 | InvalidApi.NotFound | Specified api is not found, please check your url and method. | |
| 404 | InvalidDBInstanceId.NotFound | The DBInstanceId provided does not exist in our records. | Instance does not exist. |
| 404 | InvalidParam | Invalid parameter, please check. | |
| 404 | InvalidClusterName.NotFound | The specified cluster name is not available. | The specified cluster name is not available |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.