接口说明
适用引擎
- RDS MySQL
- RDS PostgreSQL
- RDS SQL Server
- RDS MariaDB
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI
Explorer可以自动生成SDK代码示例。
调试
调试
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 否 | 交换机所属地域的ID。可调用DescribeRegions接口获取。 |
cn-hangzhou |
| VpcId | string | 否 |
要查询的交换机所属VPC的ID。 说明 | vpc-bp1opxu1zkhn**** |
| ZoneId | string | 否 | 交换机所属可用区的ID。您可调用DescribeAvailableZones接口获取。用于过滤调用结果，仅返回目标可用区中的虚拟交换机详情。 |
cn-hangzhou-i |
| DedicatedHostGroupId | string | 否 |
专属集群ID。可调用DescribeDedicatedHostGroups获取。查询该专属集群所属专有网络VPC下所有虚拟交换机的详情。 说明 | dhg-7a9**** |
| PageNumber | integer | 否 | 列表的页码。默认值：1。 |
1 |
| PageSize | integer | 否 |
分页查询时每页的行数。取值：1~50。默认值：30。 |
30 |
| ResourceGroupId | string | 否 |
资源组ID。 |
rg-bp67acfmxazb4p**** |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| object |
返回参数详情。 |
||
| RequestId | string |
请求ID。 |
8A68AEA1-AFBD-53F8-9BBB-06555EAE5C0E |
| TotalCount | integer |
总记录数。 |
2 |
| PageNumber | integer |
当前页码。 |
1 |
| PageSize | integer |
每页记录数。与请求参数PageSize中传入的值对应。 |
30 |
| VSwitchs | object [] |
交换机信息列表。 |
|
| CidrBlock | string |
交换机网段。 |
172.16.XX.XX/24 |
| Description | string |
交换机的描述信息。 |
vSwitchDescription |
| IsDefault | boolean |
是否是默认交换机。
|
true |
| IzNo | string |
交换机所属可用区ID。 |
cn-hangzhou-h |
| Status | string |
交换机状态。取值：
|
Available |
| VSwitchId | string |
交换机ID。 |
vsw-bp1pnaz94xc**** |
| VSwitchName | string |
交换机名称。 |
test |
| AvailableIpAddressCount | string |
交换机中可用的IP地址数量。 |
1 |
示例
正常返回示例
JSON格式
{
"RequestId": "8A68AEA1-AFBD-53F8-9BBB-06555EAE5C0E",
"TotalCount": 2,
"PageNumber": 1,
"PageSize": 30,
"VSwitchs": [
{
"CidrBlock": "172.16.XX.XX/24",
"Description": "vSwitchDescription",
"IsDefault": true,
"IzNo": "cn-hangzhou-h",
"Status": "Available",
"VSwitchId": "vsw-bp1pnaz94xc****",
"VSwitchName": "test",
"AvailableIpAddressCount": "1"
}
]
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidVSwitchId.NotFound | Specified virtual switch is not found in specified VPC. | 该VPC内无可用交换机。 |
| 400 | IncorrecttVpcId | The specified parameter VPCId is not valid. | VPCId无效。请您选择正确的VPC网络。 |
| 400 | InvalidIzNo.NotSupported | Specified VPC zone is not supported. | VPC的可用区不匹配。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2022-07-27 | OpenAPI 错误码发生变更，OpenAPI 入参发生变更 | 看变更集 | ||||||||
|
||||||||||
| 2021-09-08 | OpenAPI 错误码发生变更，OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
|
内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家
阿里云企业补贴进行中： 马上申请
腾讯云限时活动1折起，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠
转转请注明出处：https://www.yunxiaoer.com/156463.html