调用DescribeVSwitches查询可组网的信息,内网按vswitch进行组网

调试

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

请求参数

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

系统规定参数。取值:DescribeVSwitches

Version String 2017-11-10

API版本号。

EnsRegionId String cn-xian-unicom

ENS节点ID。

VSwitchId String vsw-5m9xhlq8oh***

交换机ID。

VSwitchName String testVSwitchName

交换机名称。

NetworkId String vpc-25cdvfeq58pl****

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

PageNumber Integer 1

列表的页码,默认值为1

PageSize Integer 10

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

OrderByParams String {"EnsRegionId":"desc"}

排序使用:格式例子{"EnsRegionId":"desc"}。

默认按节点ID降序排列。

返回数据

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

当前查询每页的行数。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

PageNumber Integer 1

当前查询页码。

TotalCount Integer 3

列表数据总数。

VSwitches Array of VSwitch

返回数据列表,详见返回示例(JSON格式)VSwitch对象数组。

VSwitch
EnsRegionId String cn-xian-unicom

ENS节点ID。

Status String Pending

交换机的状态,如下所示:

  • Pending:配置中。
  • Available:可用。
FreeIpCount Long 1024

可用IP数量。

VSwitchId String vsw-5m9xhlq8oh***

交换机ID。

CidrBlock String 10.21.224.0/22

交换机的IPv4网段。

Description String VSwitchDescription

交换机的描述信息。

NetworkId String vpc-25cdvfeq58pl****

网络ID。

CreatedTime String 2020-06-16T06:33:15Z

创建时间,使用UTC时间格式,格式为yyyy-MM-ddTHH:mm:ssZ。

VSwitchName String testVSwitchName

交换机名称。

示例

请求示例

https://ens.aliyuncs.com/?Action=DescribeVSwitches&<公共请求参数>

正常返回示例

XML格式

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

<DescribeVSwitchesResponse>
    <PageSize>2</PageSize>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>3</TotalCount>
    <VSwitches>
        <EnsRegionId>cn-xian-unicom</EnsRegionId>
        <Status>Pending</Status>
        <FreeIpCount>1024</FreeIpCount>
        <VSwitchId>vsw-5m9xhlq8oh***</VSwitchId>
        <CidrBlock>10.21.224.0/22</CidrBlock>
        <Description>VSwitchDescription</Description>
        <NetworkId>vpc-25cdvfeq58pl****</NetworkId>
        <CreatedTime>2020-06-16T06:33:15Z</CreatedTime>
        <VSwitchName>testVSwitchName</VSwitchName>
    </VSwitches>
</DescribeVSwitchesResponse>

JSON格式

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

{
  "PageSize" : 2,
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber" : 1,
  "TotalCount" : 3,
  "VSwitches" : [ {
    "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"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 NoPermission Permission denied. 没有足够的权限,请联系云账号管理员授予您相应权限。

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