该接口用于查询专有网络VPC下虚拟交换机的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 | 交换机所属地域的ID。可调用DescribeRegions接口获取。 | cn-hangzhou |
VpcId | string | 否 | 要查询的交换机所属VPC的ID。 说明本参数和DedicatedHostGroupId必传其一。 | vpc-bp1opxu1zkhn********** |
ZoneId | string | 否 | 交换机所属可用区的ID。您可调用DescribeAvailableZones接口获取。用于过滤调用结果,仅返回目标可用区中的虚拟交换机详情。 | cn-hangzhou-i |
DedicatedHostGroupId | string | 否 | 专属集群ID。可调用DescribeDedicatedHostGroups获取。查询该专属集群所属专有网络VPC下所有虚拟交换机的详情。 说明本参数和VpcId必传其一。 | dhg-7a9******** |
PageNumber | integer | 否 | 列表的页码。默认值:1。 | 1 |
PageSize | integer | 否 | 分页查询时每页的行数。取值:1~50。默认值:30。 | 30 |
ResourceGroupId | string | 否 | 资源组ID。 | rg-bp67acfmxazb4p**** |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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 返回结构发生变更 | |||||||||
|