调用DescribeVSwitches接口查询已创建的交换机。
API描述
该接口只会校验参数的合法性,不会校验参数之间的依赖关系,返回结果是所有条件的交集。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeVSwitches |
要执行的操作,取值:DescribeVSwitches。 |
VpcId | String | 否 | vpc-25cdvfeq58pl**** |
要查询的交换机所属VPC的ID。 |
VSwitchId | String | 否 | vsw-23dscddcffvf3**** |
要查询的交换机的ID。 |
ZoneId | String | 否 | cn-hangzhou-d |
交换机所属可用区的ID。您可以通过调用DescribeZones接口获取可用区ID。 |
RegionId | String | 是 | cn-hangzhou |
交换机所属地域的ID。您可以通过调用DescribeRegions接口获取地域ID。 |
VSwitchName | String | 否 | VSwitch-1 |
交换机的名称。 |
DryRun | Boolean | 否 | false |
是否只预检此次请求,取值:
|
IsDefault | Boolean | 否 | true |
是否查询指定地域下的默认交换机,取值:
如果不传入该参数,系统会查询指定地域下的所有交换机 |
RouteTableId | String | 否 | vtb-bp145q7glnuzdvzu2**** |
路由表的ID。 |
ResourceGroupId | String | 否 | rg-bp67acfmxazb4ph**** |
交换机所属的资源组ID。 |
PageNumber | Integer | 否 | 1 |
列表的页码,默认值为1。 |
PageSize | Integer | 否 | 10 |
分页查询时每页的行数,最大值为50,默认值为10。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 9A572171-4E27-40D1-BD36-D26C9E71E29E |
请求ID。 |
TotalCount | Integer | 1 |
列表条目数。 |
PageNumber | Integer | 1 |
当前页码。 |
PageSize | Integer | 10 |
每页包含的条目数。 |
VSwitches | Array |
交换机的详细信息。 |
|
VSwitchId | String | vsw-25bcdxs7pv1**** |
交换机的ID。 |
VpcId | String | vpc-257gcdcdq64**** |
交换机所属VPC的ID。 |
Status | String | Available |
交换机的状态,取值:
|
CidrBlock | String | 172.16.0.0/24 |
交换机的IPv4网段。 |
Ipv6CidrBlock | String | 2408:4004:0:2900::/64 |
交换机的IPv6网段。 |
ZoneId | String | cn-hangzhou-d |
交换机所属的可用区。 |
AvailableIpAddressCount | Long | 1 |
交换机中可用的IP地址数量。 |
Description | String | VSwitchDescription |
交换机的描述信息。 |
VSwitchName | String | VSwitch-1 |
交换机的名称。 |
CreationTime | String | 2018-01-18T12:43:57Z |
交换机的创建时间。 |
IsDefault | Boolean | true |
是否是默认交换机。
|
ResourceGroupId | String | rg-acfmxazb4ph6aiy**** |
交换机所属的资源组ID。 |
NetworkAclId | String | 111 | |
Tags | Array |
交换机标签信息。 |
|
Key | String | department |
交换机绑定的标签键。 |
Value | String | dev |
交换机绑定的标签值。 |
RouteTable | Struct |
路由表信息。 |
|
RouteTableId | String | vrt-bp145q7glnuzdv**** |
交换机关联的路由表ID。 |
RouteTableType | String | System |
交换机关联的路由表的类型:
|
示例
请求示例
http(s)://vpc.aliyuncs.com/?Action=DescribeVSwitches
&RegionId=cn-hangzhou
&<公共请求参数>
正常返回示例
XML
格式
<DescribeVSwitchesResponse>
<PageNumber>1</PageNumber>
<VSwitches>
<VSwitch>
<RouteTable>
<RouteTableId>vtb-hp3hk68xybfogay8g****</RouteTableId>
<RouteTableType>System</RouteTableType>
</RouteTable>
<Description></Description>
<IsDefault>false</IsDefault>
<AvailableIpAddressCount>252</AvailableIpAddressCount>
<ResourceGroupId>rg-acfmxazb4ph****</ResourceGroupId>
<ZoneId>cn-huhehaote-a</ZoneId>
<VSwitchId>vsw-hp3l11aj1tx5g8qwt****</VSwitchId>
<NetworkAclId></NetworkAclId>
<VpcId>vpc-hp37qeafxj2sfs69s****</VpcId>
<CreationTime>2019-11-11T03:39:17Z</CreationTime>
<Status>Available</Status>
<CidrBlock>192.168.0.0/24</CidrBlock>
<Ipv6CidrBlock>2408:4004:0:a600::/64</Ipv6CidrBlock>
<VSwitchName>CL-IPv6-VSW</VSwitchName>
</VSwitch>
</VSwitches>
<TotalCount>1</TotalCount>
<PageSize>10</PageSize>
<RequestId>95C297E1-E9F7-4EB8-BE42-82C8CEBF994D</RequestId>
</DescribeVSwitchesResponse>
JSON
格式
{
"PageNumber": 1,
"VSwitches": {
"VSwitch": [
{
"RouteTable": {
"RouteTableId": "vtb-hp3hk68xybfogay8g****",
"RouteTableType": "System"
},
"Description": "",
"IsDefault": false,
"AvailableIpAddressCount": 252,
"ResourceGroupId": "rg-acfmxazb4ph****",
"ZoneId": "cn-huhehaote-a",
"VSwitchId": "vsw-hp3l11aj1tx5g8qwt****",
"NetworkAclId": "",
"VpcId": "vpc-hp37qeafxj2sfs69s****",
"CreationTime": "2019-11-11T03:39:17Z",
"Status": "Available",
"CidrBlock": "192.168.0.0/24",
"Ipv6CidrBlock": "2408:4004:0:a600::/64",
"VSwitchName": "CL-IPv6-VSW"
}
]
},
"TotalCount": 1,
"PageSize": 10,
"RequestId": "95C297E1-E9F7-4EB8-BE42-82C8CEBF994D"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | InvalidVSwitchId.NotFound | VSwitch not exist. | 该交换机不存在,请您检查输入的交换机是否正确。 |
400 | Forbidden.VpcNotFound | Specified VPC can not found. | 指定的 VPC 不存在,请您检查 VPC 是否正确。 |
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交