调用DescribeVSwitches查询可组网的信息,内网按vswitch进行组网
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 位置 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
Action | Query | String | 是 | DescribeVSwitches |
系统参数,取值:DescribeVSwitches。 |
Version | Query | String | 是 | 2017-11-10 |
API版本号。 |
EnsRegionId | Query | String | 否 | cn-xian-unicom |
ENS节点ID。 |
VSwitchId | Query | String | 否 | vsw-5m9xhlq8oh*** |
交换机ID。 |
VSwitchName | Query | String | 否 | testVSwitchName |
交换机名称。 |
PageNumber | Query | Integer | 否 | 1 |
列表的页码,默认值为1。 |
PageSize | Query | Integer | 否 | 10 |
分页查询时每页的行数,最大值为50,默认值为10。 |
OrderByParams | Query | String | 否 | {"EnsRegionId":"desc"} |
排序使用:格式例子{"EnsRegionId":"desc"}。 默认按节点ID降序排列。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageNumber | Integer | 1 |
当前查询页码。 |
PageSize | Integer | 10 |
列表数据总数。 |
TotalCount | Integer | 2 |
列表数据总数。 |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
请求ID。 |
VSwitches | Array of VSwitch |
返回数据列表,详见返回示例(JSON格式)VSwitch对象数组。 |
|
VSwitch | |||
CidrBlock | String | 10.21.224.0/22 |
交换机的IPv4网段。 |
CreatedTime | String | 2020-06-16T06:33:15Z |
创建时间,UTC时间格式。 |
EnsRegionId | String | cn-xian-unicom |
ENS节点ID。 |
FreeIpCount | Long | 1024 |
可用IP数量。 |
Status | String | Pending |
交换机的状态,如下所示:
|
VSwitchId | String | vsw-5m9xhlq8oh56oq*** |
交换机ID。 |
VSwitchName | String | testVSwitchName |
交换机名称。 |
示例
请求示例
https://ens.aliyuncs.com/?Action=DescribeVSwitchesInfo
&<公共请求参数>
正常返回示例
XML
格式
<DescribeVSwitchesResponse>
<TotalCount>3</TotalCount>
<RequestId>B129BD18-B2B0-401B-802A-766E5E873A96</RequestId>
<PageSize>2</PageSize>
<PageNumber>1</PageNumber>
<VSwitches>
<VSwitch>
<Status>Available</Status>
<FreeIpCount>1024</FreeIpCount>
<CreatedTime>2020-06-16T06:33:15Z</CreatedTime>
<VSwitchId>vsw-5m9xhlq8oh56oq***</VSwitchId>
<CidrBlock>10.21.224.0/22</CidrBlock>
<VSwitchName>Test交换机1</VSwitchName>
<EnsRegionId>cn-xian-unicom</EnsRegionId>
</VSwitch>
<VSwitch>
<Status>Available</Status>
<FreeIpCount>1024</FreeIpCount>
<CreatedTime>2020-06-16T06:35:03Z</CreatedTime>
<VSwitchId>vsw-5m9xi8zi38vgmg***</VSwitchId>
<CidrBlock>10.21.224.0/22</CidrBlock>
<VSwitchName>Test交换机1</VSwitchName>
<EnsRegionId>cn-wuhan-cmcc</EnsRegionId>
</VSwitch>
</VSwitches>
</DescribeVSwitchesResponse>
JSON
格式
{
"TotalCount": 3,
"RequestId": "B129BD18-B2B0-401B-802A-766E5E873A96",
"PageSize": 2,
"PageNumber": 1,
"VSwitches": {
"VSwitch": [{
"Status": "Available",
"FreeIpCount": 1024,
"CreatedTime": "2020-06-16T06:33:15Z",
"VSwitchId": "vsw-5m9xhlq8oh56oq***",
"CidrBlock": "10.21.224.0/22",
"VSwitchName": "Test交换机1",
"EnsRegionId": "cn-xian-unicom"
}, {
"Status": "Available",
"FreeIpCount": 1024,
"CreatedTime": "2020-06-16T06:35:03Z",
"VSwitchId": "vsw-5m9xi8zi38vgmg***",
"CidrBlock": "10.21.224.0/22",
"VSwitchName": "Test交换机1",
"EnsRegionId": "cn-wuhan-cmcc"
}]
}
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | NoPermission | Permission denied. | 没有足够的权限,请联系云账号管理员授予您相应权限。 |
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交