DescribeVSwitches - PolarDB - Alibaba Cloud Documentation Center

Queries the details of one or more vSwitches.

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

polardb:DescribeVSwitches

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the vSwitch.	cn-hangzhou
VpcId	string	No	The ID of the virtual private cloud (VPC) to which the vSwitch belongs. Note Specify at least one of the VpcId and DedicatedHostGroupId parameters.	vpc-25cdvfeq58pl****
ZoneId	string	No	The zone ID of the vSwitch.	cn-hangzhou-d
DedicatedHostGroupId	string	No	The ID of the dedicated cluster. Note Specify at least one of the VpcId and DedicatedHostGroupId parameters.	dhg-4n****
PageNumber	integer	No	The page number of the list. The default value is 1.	1
PageSize	integer	No	The number of entries to return on each page for a paged query. The maximum value is 50. The default value is 50.	50
ResourceGroupId	string	No	The ID of the resource group to which the vSwitch belongs.	rg-bp67acfmxazb4ph****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	9A572171-4E27-40D1-BD36-D26C9E71E29E
TotalCount	integer	The number of entries in the list.	1
PageNumber	integer	The current page number.	1
PageSize	integer	The number of entries on the current page.	10
VSwitchs	array<object>	The list of vSwitches.
	object
CidrBlock	string	The IPv4 CIDR block of the vSwitch.	172.16.0.0/24
Description	string	The description of the vSwitch.	vSwitchDescription
IsDefault	boolean	Indicates whether the vSwitch is the default vSwitch. Valid values: true: The vSwitch is the default vSwitch. false: The vSwitch is not the default vSwitch.	true
IzNo	string	The zone where the NAT Gateway is located.	cn-hangzhou-b
Status	string	The status of the vSwitch. Valid values: Pending: The vSwitch is being configured. Available: The vSwitch is active.	Available
VSwitchId	string	The ID of the vSwitch.	vsw-25bcdxs7pv1****
VSwitchName	string	The name of the vSwitch.	vSwitch
AvailableIpAddressCount	integer	The number of available IP addresses in the vSwitch.	1

Examples

Success response

JSON format

{
  "RequestId": "9A572171-4E27-40D1-BD36-D26C9E71E29E",
  "TotalCount": 1,
  "PageNumber": 1,
  "PageSize": 10,
  "VSwitchs": [
    {
      "CidrBlock": "172.16.0.0/24",
      "Description": "vSwitchDescription\t\n",
      "IsDefault": true,
      "IzNo": "cn-hangzhou-b\t\n",
      "Status": "Available",
      "VSwitchId": "vsw-25bcdxs7pv1****\t\n",
      "VSwitchName": "vSwitch",
      "AvailableIpAddressCount": 1
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	InvalidVSwitchId.NotFound	Specified virtual switch is not found in specified VPC.
400	IncorrecttVpcId	The specified parameter VPCId is not valid.
400	InvalidIzNo.NotSupported	Specified VPC zone is not supported.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.