All Products
Search
Document Center

ENS:DescribeVSwitches

Last Updated:Mar 12, 2024

Queries information about available vSwitches.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
EnsRegionIdstringNo

The ID of the edge 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 vSwitches belong.

vpc-25cdvfeq58pl****
PageNumberintegerNo

The page number of the returned page. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Valid values: 1 to 50. Default value: 10.

10
OrderByParamsstringNo

The order in which you want to sort the returned data. Example: {"EnsRegionId":"desc"}.

By default, the nodes are sorted by IDs in descending order.

{"EnsRegionId":"desc"}

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries returned on each page.

2
RequestIdstring

The request ID.

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

The page number of the returned page.

1
TotalCountinteger

The total number of entries in the list.

3
VSwitchesobject []

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

EnsRegionIdstring

The ID of the edge 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 network.

vpc-25cdvfeq58pl****
CreatedTimestring

The time when the vSwitch 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

{
  "PageSize": 2,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "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
400MissingParameterThe input parameter that is mandatory for processing this request is not supplied.-
400NoPermissionPermission denied.-
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-
400InvalidParameterThe errorMessage is %s. Please check it again.-
400InvalidSecurityGroupId.NotFoundThe specified SecurityGroupId does not exist.-
400SecurityGroupRuleConflict.DuplicatedThe SecurityGroup rule already exists.-
400AuthorizationLimitExceedThe limit of authorization records in the security group reaches.-
400ens.interface.errorAn error occurred while calling the API.-
400CallInterfaceCall Interface Happen Error.An error occurred when you call the operation.

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

Change history

Change timeSummary of changesOperation
2023-12-21API Description Update. The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    Error Codes 400 change
Input ParametersThe request parameters of the API has changed.
    delete Input Parameters: Version