调用DescribeVSwitches查询已创建的交换机_云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

查询交换机。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
polardb:DescribeVSwitches	Read	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	交换机所属地域 ID。	cn-hangzhou
VpcId	string	否	交换机所属专有网络 ID。说明 VpcId 和 DedicatedHostGroupId 参数至少输入一个。	vpc-25cdvfeq58pl****
ZoneId	string	否	交换机所属可用区 ID。	cn-hangzhou-d
DedicatedHostGroupId	string	否	专属集群 ID。说明 VpcId 和 DedicatedHostGroupId 参数至少输入一个。	dhg-4n****
PageNumber	integer	否	列表的页码，默认值为 1。	1
PageSize	integer	否	分页查询时每页的行数，最大值为 50。默认值为 50。	50
ResourceGroupId	string	否	交换机所属的资源组 ID。	rg-bp67acfmxazb4ph****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	9A572171-4E27-40D1-BD36-D26C9E71E29E
TotalCount	integer	列表条目数。	1
PageNumber	integer	当前页码。	1
PageSize	integer	每页包含的条目数。	10
VSwitchs	object []	交换机列表。
CidrBlock	string	交换机的 IPv4 网段。	172.16.0.0/24
Description	string	交换机的描述信息。	vSwitchDescription
IsDefault	boolean	是否是默认交换机，取值： true：是默认交换机。 false：非默认交换机。	true
IzNo	string	NAT 网关所属的可用区。	cn-hangzhou-b
Status	string	交换机的状态，取值： Pending：配置中。 Available：可用。	Available
VSwitchId	string	交换机的 ID。	vsw-25bcdxs7pv1****
VSwitchName	string	交换机的名称。	vSwitch
AvailableIpAddressCount	long	交换机中可用的 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	错误码	错误信息
400	InvalidVSwitchId.NotFound	Specified virtual switch is not found in specified VPC.
400	IncorrecttVpcId	The specified parameter VPCId is not valid.
400	InvalidIzNo.NotSupported	Specified VPC zone is not supported.

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