DescribeRdsVpcs - 获取VPC列表

获取VPC列表。

接口说明

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

调试

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

授权信息

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

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

请求参数

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

地域 ID。

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

可用区 ID。

cn-hangzhou-h
ResourceGroupIdstring

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

null

返回参数

名称类型描述示例值
object
Vpcsobject

VPC 列表

Vpcarray<object>

VPC 信息。

Vpcobject

VPC 信息。

Statusstring

VPC 状态。 Available 表示可用。

Available
VpcNamestring

VPC 的名称。

vpc-name
VpcIdstring

VPC ID。

vpc-bp*******************
IsDefaultboolean

是否是默认 VPC。取值说明:

  • true:是
  • false:否
true
CidrBlockstring

VPC 的网段。

10.**.**.0/8
RegionNostring

地域 ID。

cn-hangzhou
GmtCreatestring

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

null
AliUidstring

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

null
VSwitchsarray<object>

vSwitch 列表。

VSwitchobject

交换机信息。

Statusstring

vSwitch 状态。Available 表示可用。

Available
VSwitchIdstring

vSwitch ID。

vsw-bp*******************
IsDefaultboolean

是否是默认 vSwitch。取值说明:

  • true:是
  • false:否
true
CidrBlockstring

vSwitch 的网段。

10.**.**.0/24
GmtCreatestring

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

null
GmtModifiedstring

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

null
IzNostring

vSwitch 所属的可用区。

cn-hangzhou-i
VSwitchNamestring

vSwitch 的名称。

vsw-name
GmtModifiedstring

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

null
Bidstring

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

null
RequestIdstring

请求 ID。

53924AF0-1628-5AA2-9C95-D4**********

示例

正常返回示例

JSON格式

{
  "Vpcs": {
    "Vpc": [
      {
        "Status": "Available",
        "VpcName": "vpc-name",
        "VpcId": "vpc-bp*******************",
        "IsDefault": true,
        "CidrBlock": "10.**.**.0/8",
        "RegionNo": "cn-hangzhou",
        "GmtCreate": "null",
        "AliUid": "null",
        "VSwitchs": [
          {
            "Status": "Available",
            "VSwitchId": "vsw-bp*******************",
            "IsDefault": true,
            "CidrBlock": "10.**.**.0/24",
            "GmtCreate": "null",
            "GmtModified": "null",
            "IzNo": "cn-hangzhou-i",
            "VSwitchName": "vsw-name"
          }
        ],
        "GmtModified": "null",
        "Bid": "null"
      }
    ]
  },
  "RequestId": "53924AF0-1628-5AA2-9C95-D4**********"
}

错误码

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