文档

DescribeVSwitches - 查询已创建的交换机

更新时间:

查询交换机。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
polardb:DescribeVSwitchesRead
  • 全部资源
    *

请求参数

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

交换机所属地域 ID。

cn-hangzhou
VpcIdstring

交换机所属专有网络 ID。

说明 VpcIdDedicatedHostGroupId 参数至少输入一个。
vpc-25cdvfeq58pl****
ZoneIdstring

交换机所属可用区 ID。

cn-hangzhou-d
DedicatedHostGroupIdstring

专属集群 ID。

说明 VpcIdDedicatedHostGroupId 参数至少输入一个。
dhg-4n****
PageNumberinteger

列表的页码,默认值为 1。

1
PageSizeinteger

分页查询时每页的行数,最大值为 50。默认值为 50。

50
ResourceGroupIdstring

交换机所属的资源组 ID。

rg-bp67acfmxazb4ph****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

9A572171-4E27-40D1-BD36-D26C9E71E29E
TotalCountinteger

列表条目数。

1
PageNumberinteger

当前页码。

1
PageSizeinteger

每页包含的条目数。

10
VSwitchsobject []

交换机列表。

CidrBlockstring

交换机的 IPv4 网段。

172.16.0.0/24
Descriptionstring

交换机的描述信息。

vSwitchDescription
IsDefaultboolean

是否是默认交换机,取值:

  • true:是默认交换机。
  • false:非默认交换机。
true
IzNostring

NAT 网关所属的可用区。

cn-hangzhou-b
Statusstring

交换机的状态,取值:

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

交换机的 ID。

vsw-25bcdxs7pv1****
VSwitchNamestring

交换机的名称。

vSwitch
AvailableIpAddressCountlong

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

1

示例

正常返回示例

JSON格式

{
  "RequestId": "9A572171-4E27-40D1-BD36-D26C9E71E29E",
  "TotalCount": 1,
  "PageNumber": 1,
  "PageSize": 10,
  "VSwitchs": [
    {
      "CidrBlock": "172.16.0.0/24",
      "Description": "vSwitchDescription\t\n",
      "IsDefault": true,
      "IzNo": "cn-hangzhou-b\t\n",
      "Status": "Available",
      "VSwitchId": "vsw-25bcdxs7pv1****\t\n",
      "VSwitchName": "vSwitch",
      "AvailableIpAddressCount": 1
    }
  ]
}

错误码

HTTP status code错误码错误信息
400InvalidVSwitchId.NotFoundSpecified virtual switch is not found in specified VPC.
400IncorrecttVpcIdThe specified parameter VPCId is not valid.
400InvalidIzNo.NotSupportedSpecified VPC zone is not supported.

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

  • 本页导读 (0)
文档反馈