首页 云数据库 RDS API参考 API目录 网络与连接地址 DescribeVSwitches - 查询虚拟交换机列表

DescribeVSwitches - 查询虚拟交换机列表

该接口用于查询专有网络VPC下虚拟交换机的详细信息。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-hangzhou
VpcIdstring

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

说明本参数和DedicatedHostGroupId必传其一。
vpc-bp1opxu1zkhn**********
ZoneIdstring

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

cn-hangzhou-i
DedicatedHostGroupIdstring

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

说明本参数和VpcId必传其一。
dhg-7a9********
PageNumberinteger

列表的页码。默认值:1

1
PageSizeinteger

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

30
ResourceGroupIdstring

资源组ID。

rg-bp67acfmxazb4p****

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID。

8A68AEA1-AFBD-53F8-9BBB-06555EAE5C0E
TotalCountinteger

总记录数。

2
PageNumberinteger

当前页码。

1
PageSizeinteger

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

30
VSwitchsobject []

交换机详细信息。

CidrBlockstring

交换机网段。

172.16.0.0/24
Descriptionstring

交换机的描述信息。

VSwitchDescription
IsDefaultboolean

是否是默认交换机。

  • true:是
  • false:否
true
IzNostring

交换机所属可用区ID。

cn-hangzhou-h
Statusstring

交换机状态。取值:

  • Pending:配置中。
  • Available:可用。
Available
VSwitchIdstring

交换机ID。

vsw-bp1pnaz94xc**********
VSwitchNamestring

交换机名称。

test
AvailableIpAddressCountstring

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

1

示例

正常返回示例

JSON格式

{
  "RequestId": "8A68AEA1-AFBD-53F8-9BBB-06555EAE5C0E",
  "TotalCount": 2,
  "PageNumber": 1,
  "PageSize": 30,
  "VSwitchs": [
    {
      "CidrBlock": "172.16.0.0/24",
      "Description": "VSwitchDescription",
      "IsDefault": true,
      "IzNo": "cn-hangzhou-h",
      "Status": "Available",
      "VSwitchId": "vsw-bp1pnaz94xc**********",
      "VSwitchName": "test",
      "AvailableIpAddressCount": "1"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400InvalidVSwitchId.NotFoundSpecified virtual switch is not found in specified VPC.该VPC内无可用交换机。
400IncorrecttVpcIdThe specified parameter VPCId is not valid.VPCId无效。请您选择正确的VPC网络。
400InvalidIzNo.NotSupportedSpecified VPC zone is not supported.VPC的可用区不匹配。

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

变更历史

变更时间变更内容概要操作
2022-07-27OpenAPI 错误码发生变更,OpenAPI 入参发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:ResourceGroupId
2021-09-08OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
阿里云首页 关系型数据库 相关技术圈