文档

DescribeRdsVSwitchs - 获取虚拟交换机列表

更新时间:

获取虚拟交换机(vSwitch)列表。

接口说明

您在新建 AnalyticDB PostgreSQL 版实例时,可以通过该接口查询目标地域及可用区下可用的 vSwitch 信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

地域 ID。

说明 您可以调用 DescribeRegions 接口查看可用的地域 ID 和可用区 ID。
cn-hangzhou
VpcIdstring

VPC ID。

说明
  • 您可以调用 DescribeRdsVpcs 接口查看可用的 VPC ID。
  • 该参数必须传入。
  • vpc-bp*******************
    ZoneIdstring

    可用区 ID。

    说明 您可以调用 DescribeRegions 接口查看可用的地域 ID 和可用区 ID。
    cn-hangzhou-h
    ResourceGroupIdstring

    该参数已废弃,无需传入该参数。

    null

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    B0BA251D-6854-5A99-A964-3C**********
    VSwitchesobject

    vSwitch 列表。

    VSwitchobject []

    vSwith 信息。

    Statusstring

    vSwitch 状态。Available 表示可用。

    Available
    IsDefaultboolean

    是否是默认交换机。取值说明:

    • true:是
    • false:否
    false
    VSwitchIdstring

    vSwitch ID。

    vsw-bp*******************
    CidrBlockstring

    vSwitch 的网段。

    192.**.**.0/24
    RegionNostring

    该参数已废弃,故不会返回参数值。

    null
    GmtCreatestring

    该参数已废弃,故不会返回参数值。

    null
    AliUidstring

    该参数已废弃,故不会返回参数值。

    null
    GmtModifiedstring

    该参数已废弃,故不会返回参数值。

    null
    Bidstring

    该参数已废弃,故不会返回参数值。

    null
    IzNostring

    可用区 ID。

    cn-hangzhou-h
    VSwitchNamestring

    vSwitch 名称。

    vsw-name

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "B0BA251D-6854-5A99-A964-3C**********",
      "VSwitches": {
        "VSwitch": [
          {
            "Status": "Available",
            "IsDefault": false,
            "VSwitchId": "vsw-bp*******************",
            "CidrBlock": "192.**.**.0/24",
            "RegionNo": "null",
            "GmtCreate": "null",
            "AliUid": "null",
            "GmtModified": "null",
            "Bid": "null",
            "IzNo": "cn-hangzhou-h",
            "VSwitchName": "vsw-name"
          }
        ]
      }
    }

    错误码

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

    • 本页导读 (1)