调用DescribeVSwitches接口查询已创建的交换机。

调试

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

请求参数

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

系统规定参数。取值:DescribeVSwitches

VpcId String vpc-25cdvfeq58pl****

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

说明 RegionIdVpcId参数至少输入一个。
VSwitchId String vsw-23dscddcffvf3****

要查询的交换机的ID。

ZoneId String cn-hangzhou-d

交换机所属可用区的ID。您可以通过调用DescribeZones接口获取可用区ID。

RegionId String cn-hangzhou

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

说明 RegionIdVpcId参数至少输入一个。
VSwitchName String vSwitch

交换机的名称。

名称长度为1~128个字符,不能以http://https://开头。

DryRun Boolean true

是否只预检此次请求。取值:

  • true:发送检查请求,不会创建资源(接口功能)。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。
IsDefault Boolean true

是否查询指定地域下的默认交换机,取值:

  • true:查询指定地域下的默认交换机。
  • false:不查询指定地域下的默认交换机。

如果不传入该参数,系统默认查询指定地域下的所有交换机。

RouteTableId String vtb-bp145q7glnuzdvzu2****

路由表的ID。

ResourceGroupId String rg-bp67acfmxazb4ph****

交换机所属的资源组ID。

PageNumber Integer 1

列表的页码,默认值为1

PageSize Integer 10

分页查询时每页的行数,最大值为50。默认值为10

VSwitchOwnerId Long 2546073170691****

资源归属的阿里云账号ID。

返回数据

名称 类型 示例值 描述
PageSize Integer 10

每页包含的条目数。

RequestId String 9A572171-4E27-40D1-BD36-D26C9E71E29E

请求ID。

PageNumber Integer 1

当前页码。

TotalCount Integer 1

列表条目数。

VSwitches Array of VSwitch

交换机的详细信息。

VSwitch
VpcId String vpc-257gcdcdq64****

交换机所属VPC的ID。

Status String Available

交换机的状态,取值:

  • Pending:配置中。
  • Available:可用。
CreationTime String 2022-01-18T12:43:57Z

交换机的创建时间。

IsDefault Boolean true

是否是默认交换机。取值:

  • true:是默认交换机。
  • false:非默认交换机。
AvailableIpAddressCount Long 1

交换机中可用的IP地址数量。

NetworkAclId String nacl-a2do9e413e0spzasx****

网络ACL的ID。

OwnerId Long 253460731706911258

资源归属的阿里云账号ID。

VSwitchId String vsw-25bcdxs7pv1****

交换机的ID。

CidrBlock String 172.16.0.0/24

交换机的IPv4网段。

Description String VSwitchDescription

交换机的描述信息。

ResourceGroupId String rg-acfmxazb4ph6aiy****

交换机所属的资源组ID。

ZoneId String cn-hangzhou-d

交换机所属的可用区。

Ipv6CidrBlock String 2408:4002:10c4:4e03::/64

交换机的IPv6网段。

VSwitchName String vSwitch

交换机的名称。

Tags Array of Tag

交换机标签信息。

Tag
Key String department

交换机绑定的标签键。

Value String dev

交换机绑定的标签值。

RouteTable Object

路由表信息。

RouteTableId String vrt-bp145q7glnuzdv****

交换机关联的路由表ID。

RouteTableType String System

交换机关联的路由表的类型:

  • System:系统路由表。
  • Custom:自定义路由表。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeVSwitches
&VpcId=vpc-25cdvfeq58pl****
&VSwitchId=vsw-23dscddcffvf3****
&ZoneId=cn-hangzhou-d
&RegionId=cn-hangzhou
&VSwitchName=vSwitch
&DryRun=true
&IsDefault=true
&RouteTableId=vtb-bp145q7glnuzdvzu2****
&ResourceGroupId=rg-bp67acfmxazb4ph****
&PageNumber=1
&PageSize=10
&公共请求参数

正常返回示例

XML格式

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

<DescribeVSwitchesResponse>
    <PageSize>10</PageSize>
    <RequestId>9A572171-4E27-40D1-BD36-D26C9E71E29E</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <VSwitches>
        <VpcId>vpc-257gcdcdq64****</VpcId>
        <Status>Available</Status>
        <CreationTime>2022-01-18T12:43:57Z</CreationTime>
        <IsDefault>true</IsDefault>
        <AvailableIpAddressCount>1</AvailableIpAddressCount>
        <NetworkAclId>nacl-a2do9e413e0spzasx****</NetworkAclId>
        <OwnerId>253460731706911260</OwnerId>
        <VSwitchId>vsw-25bcdxs7pv1****</VSwitchId>
        <CidrBlock>172.16.0.0/24</CidrBlock>
        <Description>VSwitchDescription</Description>
        <ResourceGroupId>rg-acfmxazb4ph6aiy****</ResourceGroupId>
        <ZoneId>cn-hangzhou-d</ZoneId>
        <Ipv6CidrBlock>2408:4002:10c4:4e03::/64</Ipv6CidrBlock>
        <VSwitchName>vSwitch</VSwitchName>
        <Tags>
            <Key>department</Key>
            <Value>dev</Value>
        </Tags>
        <RouteTable>
            <RouteTableId>vrt-bp145q7glnuzdv****</RouteTableId>
            <RouteTableType>System</RouteTableType>
        </RouteTable>
    </VSwitches>
</DescribeVSwitchesResponse>

JSON格式

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

{
  "PageSize" : 10,
  "RequestId" : "9A572171-4E27-40D1-BD36-D26C9E71E29E",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "VSwitches" : [ {
    "VpcId" : "vpc-257gcdcdq64****",
    "Status" : "Available",
    "CreationTime" : "2022-01-18T12:43:57Z",
    "IsDefault" : true,
    "AvailableIpAddressCount" : 1,
    "NetworkAclId" : "nacl-a2do9e413e0spzasx****",
    "OwnerId" : 253460731706911260,
    "VSwitchId" : "vsw-25bcdxs7pv1****",
    "CidrBlock" : "172.16.0.0/24",
    "Description" : "VSwitchDescription",
    "ResourceGroupId" : "rg-acfmxazb4ph6aiy****",
    "ZoneId" : "cn-hangzhou-d",
    "Ipv6CidrBlock" : "2408:4002:10c4:4e03::/64",
    "VSwitchName" : "vSwitch",
    "Tags" : [ {
      "Key" : "department",
      "Value" : "dev"
    } ],
    "RouteTable" : {
      "RouteTableId" : "vrt-bp145q7glnuzdv****",
      "RouteTableType" : "System"
    }
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 Forbidden.VpcNotFound Specified VPC can not found. 指定的VPC不存在,请您检查VPC是否正确。
400 InvalidTagKey The tag keys are not valid. 无效的标签索引
400 InvalidTagValue The tag values are not valid. 无效的标签值
404 InvalidVSwitchId.NotFound VSwitch not exist. 该交换机不存在,请您检查输入的交换机是否正确。
404 InvalidVpcIdNumber.NotSupported The number of vpcIds exceeds the limit. vpcId数量超出限制

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