DescribeVSwitches - Elastic Compute Service - Alibaba Cloud Documentation Center

DescribeVSwitches

Note

This API has been deprecated. We recommend migrating to Vpc(2016-04-28) - DescribeVSwitches for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

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

vpc:DescribeVSwitches

get

*All Resource

*

vpc:VPC

None

Request parameters

Parameter	Type	Required	Description	Example
VpcId	string	No	The ID of the VPC.
VSwitchId	string	No	The ID of the vSwitch.
ZoneId	string	No	The ID of the zone.
RegionId	string	No	The ID of the region where the vSwitches are located. To query the latest list of regions, call the DescribeRegions operation.
IsDefault	boolean	No	Specifies whether the vSwitch is the default vSwitch in the zone. Valid values: `true` `false`
PageNumber	integer	No	The page number to return. Default value: 1.
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 50. Default value: 10.

Response elements

Element	Type	Description	Example
	object	The response data.
PageSize	integer	The page size.
RequestId	string	The request ID.
PageNumber	integer	The page number.
TotalCount	integer	The total number of entries.
VSwitches	object	A collection of VSwitches.
VSwitch	array<object>	An array of VSwitch details.
	object	The details of a single VSwitch.
CreationTime	string	The time when the VSwitch was created, in the `YYYY-MM-DDThh:mm:ssZ` ISO 8601 format.
Status	string	The status of the VSwitch. Valid values: Pending Available
VpcId	string	The ID of the VPC to which the VSwitch belongs.
IsDefault	boolean	Indicates whether the VSwitch is the default VSwitch in the zone. Valid values: true false
VSwitchId	string	The ID of the VSwitch.
CidrBlock	string	The IPv4 CIDR block of the VSwitch.
Description	string	The description of the VSwitch.
AvailableIpAddressCount	integer	The number of available IP addresses in the VSwitch.
ResourceGroupId	string	The ID of the resource group to which the VSwitch belongs.
ZoneId	string	The ID of the zone to which the VSwitch belongs.
VSwitchName	string	The name of the VSwitch.

Examples

Success response

JSON format

{
  "PageSize": 0,
  "RequestId": "",
  "PageNumber": 0,
  "TotalCount": 0,
  "VSwitches": {
    "VSwitch": [
      {
        "CreationTime": "",
        "Status": "",
        "VpcId": "",
        "IsDefault": false,
        "VSwitchId": "",
        "CidrBlock": "",
        "Description": "",
        "AvailableIpAddressCount": 0,
        "ResourceGroupId": "",
        "ZoneId": "",
        "VSwitchName": ""
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Forbidden.VpcNotFound	Specified VPC can not found.
400	IellgalParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.
400	OperationFailed.Endpoint	The specified RegionId is unavailable for this endpoint.	The specified RegionId is not available in the destination endpoint.
400	Mismatch.InstanceIdAndRegionId	The instanceId and regionId are mismatched.	The specified instance ID does not match the region information. Check the parameters.
404	InvalidVSwitchId.NotFound	VSwitch not exist.
404	InvalidVpcIdNumber.NotSupported	The number of vpcIds exceeds the limit.
404	InvalidVSwitchIdNumber.NotSupported	The number of vSwitchIds exceeds the limit.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.