DescribeVSwitches - ApsaraDB for SelectDB - Alibaba Cloud Documentation Center

Queries the vSwitches in a specified zone.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

selectdb:DescribeVSwitches

list

*All Resource

*

None

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 page number.	10
PageNumber	integer	No	The page number.	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	Schema of Response
RequestId	string	The ID of the request.	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 name of the vSwitch.	subnet
NextToken	string	The token that is used to start the next query. If this parameter is empty, no more results exist.	459a0909c0315bfbe0b5e8707e68181f
MaxResults	integer	The number of entries returned on each 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.