DescribeVSwitches - API reference| Alibaba Cloud Documentation Center

Description

Query the created VSwitches.

Request parameters

Name	Type	Required	Description
Action	String	Yes	The action to perform. Valid value: `DescribeVSwitches`
RegionId	String	Yes	The ID of the region where the VSwitch is located. You can obtain the region ID by calling the DescribeRegions API.
VpcId	String	No	The ID of the VPC.
VSwitchId	String	No	The ID of the VSwitch. Up to 20 VSwitch IDs can be specified. Separate multiple VSwitch IDs by commas.
ZoneId	String	No	The ID of the zone.
IsDefault	Boolean	No	Whether to query the default VSwitch in the specified region. Valid value: `true` (default value): Query all VSwitches in the specified region. `false`: Do not query the default VSwitch.
PageNumber	Integer	No	The number of pages to return. The default value is 1.
PageSize	Integer	No	The number of rows per page. The maximum value is 50 and default value is 10.

Response parameters

Name	Type	Description
RequestId	String	The ID of the request.
VSwitches	JSON String	The detailed information of the VSwitches. For more information, see VSwitchSetType.
TotalCount	Integer	The number of queried entries.
PageNumber	Integer	The current page number.
PageSize	Integer	The number of entries on the current page.

Error codes

See VPC API Error Center.

Examples

Request example

https://vpc.aliyuncs.com/?Action=DescribeVSwitches
&VpcId=vpc-25eq58pl3
&<CommonParameters>

Response example

XML format

<DescribeVSwitchesResponse>
    <RequestId>9A572171-4E27-40D1-BD36-D26C9E71E29E</RequestId>
    <VSwitches>
        <VSwitch>
            <VSwitchId> vsw-25b7pv15t </VSwitchId>
            <Status>Available</Status>
            <CidrBlock>172.16.1.0/24</CidrBlock>
            <ZoneId>cn-beijing-a</ZoneId>
            <AvailableIpAddressCount>246</AvailableIpAddressCount>
            <VpcId>vpc-257gq642n</VpcId>
            <Description></Description>
            <VSwitchName></VSwitchName>
            <CreationTime> 2014-10-29T15:21:02Z </CreationTime>
        </VSwitch>
    </VSwitches>
</DescribeVSwitchesResponse>

JSON format

{
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "9A572171-4E27-40D1-BD36-D26C9E71E29E",
  "TotalCount": 1,
  "VSwitches": {
    "VSwitch": [
      {
        "AvailableIpAddressCount": 246,
        "CidrBlock": "172.16.1.0/24",
        "CreationTime": "2014-10-29T15:21:02Z",
        "Description": "",
        "Status": "Available",
        "VSwitchId": "vsw-25b7pv15t",
        "VSwitchName": "",
        "VpcId": "vpc-257gq642n",
        "ZoneId": "cn-beijing-a"
      }
    ]
  }
}