调用DescribeVSwitches查询专有网络VPC下虚拟交换机的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeVSwitches

系统规定参数。取值：DescribeVSwitches。

RegionId String 否 cn-hangzhou

交换机所属地域的ID。可调用DescribeRegions接口获取。

VpcId String 否 vpc-bp1opxu1zkhn**********

要查询的交换机所属VPC的ID。

说明 本参数和DedicatedHostGroupId必传其一。
ZoneId String 否 cn-hangzhou-i

交换机所属可用区的ID。您可调用DescribeAvailableZones接口获取。用于过滤调用结果，仅返回目标可用区中的虚拟交换机详情。

DedicatedHostGroupId String 否 dhg-7a9********

专属集群ID。可调用DescribeDedicatedHostGroups获取。查询该专属集群所属专有网络VPC下所有虚拟交换机的详情。

说明 本参数和VpcId必传其一。
PageNumber Integer 否 1

列表的页码。默认值：1。

PageSize Integer 否 30

分页查询时每页的行数。取值：1~50。默认值：30。

ResourceGroupId String 否 rg-bp67acfmxazb4p****

资源组ID。

返回数据

名称 类型 示例值 描述
RequestId String 8A68AEA1-AFBD-53F8-9BBB-06555EAE5C0E

请求ID。
TotalCount Integer 2

总记录数。
PageNumber Integer 1

当前页码。
PageSize Integer 30

每页记录数。与请求参数PageSize中传入的值对应。

VSwitchs Array of VSwitch

交换机详细信息。
CidrBlock String 172.16.0.0/24

交换机网段。
Description String VSwitchDescription

交换机的描述信息。
IsDefault Boolean true

是否是默认交换机。

  • true：是
  • false：否
IzNo String cn-hangzhou-h

交换机所属可用区ID。
Status String Available

交换机状态。取值：

  • Pending：配置中。
  • Available：可用。
VSwitchId String vsw-bp1pnaz94xc**********

交换机ID。
VSwitchName String test

交换机名称。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=DescribeVSwitches
&ResourceOwnerId=0
&RegionId=cn-hangzhou
&VpcId=vpc-bp1opxu1zkhn**********
&ZoneId=cn-hangzhou-h
&PageNumber=1
&PageSize=30
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeVSwitchesResponse>
    <VSwitchs>
        <IsDefault>false</IsDefault>
        <Status>Available</Status>
        <IzNo>cn-hangzhou-h</IzNo>
        <Description/>
        <VSwitchId>vsw-bp1pnaz94xc**********</VSwitchId>
        <CidrBlock>192.168.0.1/24</CidrBlock>
        <VSwitchName>test</VSwitchName>
    </VSwitchs>
    <VSwitchs>
        <IsDefault>true</IsDefault>
        <Status>Available</Status>
        <IzNo>cn-hangzhou-h</IzNo>
        <Description>System created default virtual switch.</Description>
        <VSwitchId>vsw-bp10aqj6o4l**********</VSwitchId>
        <CidrBlock>172.16.0.1/20</CidrBlock>
        <VSwitchName/>
    </VSwitchs>
    <TotalCount>2</TotalCount>
    <RequestId>A5362A78-1B78-53D7-AFBA-E375D9C26F2F</RequestId>
    <PageSize>30</PageSize>
    <PageNumber>1</PageNumber>
</DescribeVSwitchesResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "VSwitchs" : [ {
    "IsDefault" : false,
    "Status" : "Available",
    "IzNo" : "cn-hangzhou-h",
    "Description" : "",
    "VSwitchId" : "vsw-bp1pnaz94xc**********",
    "CidrBlock" : "192.168.0.1/24",
    "VSwitchName" : "test"
  }, {
    "IsDefault" : true,
    "Status" : "Available",
    "IzNo" : "cn-hangzhou-h",
    "Description" : "System created default virtual switch.",
    "VSwitchId" : "vsw-bp10aqj6o4l**********",
    "CidrBlock" : "172.16.0.1/20",
    "VSwitchName" : ""
  } ],
  "TotalCount" : 2,
  "RequestId" : "A5362A78-1B78-53D7-AFBA-E375D9C26F2F",
  "PageSize" : 30,
  "PageNumber" : 1
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidVSwitchId.NotFound Specified virtual switch is not found in specified VPC. 该VPC内无可用交换机。
400 IncorrecttVpcId The specified parameter VPCId is not valid. VPCId无效。请您选择正确的VPC网络。
400 InvalidIzNo.NotSupported Specified VPC zone is not supported. VPC的可用区不匹配，请修改后重试。

访问错误中心查看更多错误码。