DescribeVSwitches

Updated at: 2025-04-01 06:45

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
OperationAccess levelResource typeCondition keyAssociated operation
ens:DescribeVSwitcheslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterTypeRequiredDescriptionExample
EnsRegionIdstringNo

The ID of the ENS node.

cn-xian-unicom
VSwitchIdstringNo

The ID of the vSwitch.

vsw-5m9xhlq8oh***
VSwitchNamestringNo

The name of the vSwitch.

testVSwitchName
NetworkIdstringNo

The ID of the VPC to which the vSwitch belongs.

vpc-25cdvfeq58pl****
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Maximum value: 50. Default value: 10.

10
EnsRegionIdsarrayNo

The node information.

stringNo

The IDs of the regions. The value is a JSON array that consists of up to 100 IDs. Separate multiple IDs with commas (,).

cn-chengdu-telecom-4
VSwitchIdsarrayNo

The list of vSwitches in the network.

stringNo

The vSwitch IDs.

Note
If you do not specify the scaling group ID, you must specify this parameter.
vsw-5****tzrpf

Response parameters

ParameterTypeDescriptionExample
ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageSizeinteger

The number of entries returned on each page.

2
PageNumberinteger

The page number.

1
TotalCountinteger

The total number of entries returned.

3
VSwitchesarray<object>

The information about the vSwitches. For more information, see the array of vSwitches in the response examples in the JSON format.

VSwitchobject
EnsRegionIdstring

The ID of the ENS node.

cn-xian-unicom
Statusstring

The status of the vSwitch. Valid values:

  • Pending
  • Available
Pending
FreeIpCountlong

The number of available IP addresses.

1024
VSwitchIdstring

The ID of the vSwitch.

vsw-5m9xhlq8oh***
CidrBlockstring

The IPv4 CIDR block of the vSwitch.

10.21.224.0/22
Descriptionstring

The description of the vSwitch.

VSwitchDescription
NetworkIdstring

The ID of the virtual private cloud (VPC).

vpc-25cdvfeq58pl****
CreatedTimestring

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
VSwitchNamestring

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"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
HTTP status codeError codeError messageDescription
400NoPermissionPermission denied.-
400CallInterfaceCall Interface Happen Error.An error occurred when you call the operation.
400ens.interface.errorFailed to call API.-
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

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

Change history

Change timeSummary of changesOperation
Change timeSummary of changesOperation
2024-12-26The Error code has changed. The request parameters of the API has changedView Change Details
2023-12-21API Description Update. The Error code has changed. The request parameters of the API has changedView Change Details
  • On this page (1)
  • Debugging
  • Authorization information
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
  • Change history
Feedback
phone Contact Us

Chat now with Alibaba Cloud Customer Service to assist you in finding the right products and services to meet your needs.

alicare alicarealicarealicare