Use DescribeVSwitches to query vSwitches - ENS

You can invoke DescribeVSwitches to query information about vSwitches for network configuration. Internal networks are organized by vSwitch.

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

ens:DescribeVSwitches

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
EnsRegionId	string	No	The ID of the ENS node.	cn-xian-unicom
VSwitchId	string	No	The ID of the vSwitch.	vsw-5m9xhlq8oh***
VSwitchName	string	No	The name of the vSwitch.	testVSwitchName
NetworkId	string	No	The ID of the VPC to which the vSwitch belongs.	vpc-25cdvfeq58pl****
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Maximum value: 50. Default value: 10.	10
EnsRegionIds	array	No	The IDs of edge nodes. You can specify 1 to 100 IDs.
	string	No	The IDs of edge nodes.	cn-chengdu-telecom-4
VSwitchIds	array	No	The IDs of vSwitches. You can specify 1 to 100 IDs.
	string	No	The IDs of vSwitches.	vsw-5****tzrpf

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageSize	integer	The number of entries returned on each page.	2
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of entries returned.	3
VSwitches	object
VSwitch	array<object>	The information about the vSwitches. For more information, see the array of vSwitches in the response examples in the JSON format.
	array<object>
EnsRegionId	string	The ID of the ENS node.	cn-xian-unicom
Status	string	The status of the vSwitch. Valid values: Pending Available	Pending
FreeIpCount	integer	The number of available IP addresses.	1024
VSwitchId	string	The ID of the vSwitch.	vsw-5m9xhlq8oh***
CidrBlock	string	The IPv4 CIDR block of the vSwitch.	10.21.224.0/22
Description	string	The description of the vSwitch.	VSwitchDescription
NetworkId	string	The ID of the virtual private cloud (VPC).	vpc-25cdvfeq58pl****
CreatedTime	string	The time when the VPC was created. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2020-06-16T06:33:15Z
VSwitchName	string	The name of the vSwitch.	testVSwitchName
Tags	object
Tag	array<object>	The collection of tags.
	object	The collection of tags.
Value	string	The request error rate.	TestValue
Key	string	The tag key.	TestKey
TagValue `deprecated`	string	Tag value.	TestValue
TagKey `deprecated`	string	The tag key.	TestKey

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageSize": 2,
  "PageNumber": 1,
  "TotalCount": 3,
  "VSwitches": {
    "VSwitch": [
      {
        "EnsRegionId": "cn-xian-unicom",
        "Status": "Pending",
        "FreeIpCount": 1024,
        "VSwitchId": "vsw-5m9xhlq8oh***",
        "CidrBlock": "10.21.224.0/22",
        "Description": "VSwitchDescription",
        "NetworkId": "vpc-25cdvfeq58pl****",
        "CreatedTime": "2020-06-16T06:33:15Z",
        "VSwitchName": "testVSwitchName",
        "Tags": {
          "Tag": [
            {
              "Value": "TestValue",
              "Key": "TestKey",
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	Permission denied.
400	CallInterface	Call Interface Happen Error.	An error occurred when you call the operation.
400	ens.interface.error	Failed to call API.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.