DescribeVSwitches - ENS - Alibaba Cloud Documentation Center

Queries information about available vSwitches.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ens:DescribeVSwitches	list	All Resources ``	none	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 parameters

Parameter	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	array<object>	The information about the vSwitches. For more information, see the array of vSwitches in the response examples in the JSON format.
VSwitch	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	long	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

Examples

Sample success responses

JSONformat

{
  "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.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-12-26	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-12-21	API Description Update. The Error code has changed. The request parameters of the API has changed	View Change Details