获取虚拟交换机(vSwitch)列表。
接口说明
您在新建云数据库 MongoDB 版实例时,可以通过该接口查询目标地域及可用区下可用的 vSwitch 信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| VpcId |
string |
否 |
专有网络(VPC)ID。 |
vpc-bp******************* |
| ZoneId |
string |
否 |
可用区 ID。 |
cn-hangzhou-j |
| ResourceGroupId |
string |
否 |
资源组 ID。 |
rg-acfm4ojaksxxxxx |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
60EEBD77-227C-5B39-86EA-D89163C5**** |
| VSwitches |
object |
VSwitch 列表。 |
|
| VSwitch |
array<object> |
VSwith 信息。 |
|
|
object |
|||
| Status |
string |
VSwitch 状态。Available 表示可用。 |
Available |
| IsDefault |
boolean |
是否是默认交换机,取值:
|
true |
| VSwitchId |
string |
VSwitch ID。 |
vsw-bp******************* |
| CidrBlock |
string |
VSwitch 的网段。 |
192.**.**.0/24 |
| RegionNo |
string |
该参数已废弃,故不会返回参数值。 |
null |
| GmtCreate |
string |
该参数已废弃,故不会返回参数值。 |
null |
| AliUid |
string |
该参数已废弃,故不会返回参数值。 |
null |
| GmtModified |
string |
该参数已废弃,故不会返回参数值。 |
null |
| Bid |
string |
该参数已废弃,故不会返回参数值。 |
null |
| IzNo |
string |
可用区 ID。 |
cn-hangzhou-h |
| VSwitchName |
string |
VSwitch 名称。 |
vsw-name |
示例
正常返回示例
JSON格式
{
"RequestId": "60EEBD77-227C-5B39-86EA-D89163C5****",
"VSwitches": {
"VSwitch": [
{
"Status": "Available",
"IsDefault": true,
"VSwitchId": "vsw-bp*******************\n",
"CidrBlock": "192.**.**.0/24\n",
"RegionNo": "null",
"GmtCreate": "null",
"AliUid": "null",
"GmtModified": "null",
"Bid": "null",
"IzNo": "cn-hangzhou-h\n",
"VSwitchName": "vsw-name\n"
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。