DescribeRdsVpcs - 查询VPC列表 - 云原生数据库 PolarDB

PolarDB-X 侧查询VPC列表的API。

接口说明

该接口用于获取用户账号下可用于实例专有网络（VPC）列表，以便在创建或管理数据库实例时选择合适的网络环境。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

polardbx:DescribeRdsVpcs

none

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	实例所在地域。>您可以调用 describeregions 接口查看 polardb-x 支持的地域详情，包括地域 id。	cn-zhangjiakou
ZoneId	string	否	可用区 id。	cn-beijing-h

返回参数

名称	类型	描述	示例值
	object
Vpcs	object	vpc 信息。
Vpc	array<object>	vpc 信息。
	array<object>	vpc 信息。
Status	string	vpc 状态	True
VpcName	string	vpc 的名称。	cloud_auto_test
VpcId	string	vpc 的 id。	vpc-2zekldxxy28nobay7o1f3
IsDefault	boolean	是否是默认 vpc。取值范围如下：true：是默认 vpcfalse：非默认 vpc	False
CidrBlock	string	vpc 的 ipv4 网段。	47.121.246.0/24
RegionNo	string	vpc 所在的地域。	cn-shanghai
GmtCreate	string	创建 vpc 的时间点。	Mon May 12 10:13:14 CST 2025
AliUid	string	阿里云账号 id。	314****36
VSwitchs	array<object>	vpc 的交换机信息。
	object	vpc 的交换机信息。
Status	string	交换机状态	Available
VSwitchId	string	交换机 id。	vsw-8vbkwmpn****4nrd639ih
IsDefault	boolean	是否是默认交换机。	false
CidrBlock	string	交换机网段。	10.0.0.0/24
GmtCreate	string	创建时间，精确到毫秒的 unix 时间戳。	1574156944000
GmtModified	string	最后修改时间（时间戳）	2025-09-03T19:19:13+08:00
IzNo	string	可用区 id。	cn-beijing-g
VSwitchName	string	交换机名称。	cloud_auto_g
GmtModified	string	最后修改 vpc 的时间。	2024-09-29 17:47:56
Bid	string	专有网络 id。	26842
RequestId	string	请求 id。	4C1A7CFB-9F73-5041-8C74-27626E58985A

示例

正常返回示例

JSON格式

{
  "Vpcs": {
    "Vpc": [
      {
        "Status": "True",
        "VpcName": "cloud_auto_test",
        "VpcId": "vpc-2zekldxxy28nobay7o1f3",
        "IsDefault": true,
        "CidrBlock": "47.121.246.0/24",
        "RegionNo": "cn-shanghai",
        "GmtCreate": "Mon May 12 10:13:14 CST 2025",
        "AliUid": "314****36",
        "VSwitchs": [
          {
            "Status": "Available",
            "VSwitchId": "vsw-8vbkwmpn****4nrd639ih",
            "IsDefault": false,
            "CidrBlock": "10.0.0.0/24",
            "GmtCreate": "1574156944000",
            "GmtModified": "2025-09-03T19:19:13+08:00",
            "IzNo": "cn-beijing-g",
            "VSwitchName": "cloud_auto_g"
          }
        ],
        "GmtModified": "2024-09-29 17:47:56",
        "Bid": "26842"
      }
    ]
  },
  "RequestId": "4C1A7CFB-9F73-5041-8C74-27626E58985A"
}

错误码

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

变更历史

更多信息，参考变更详情。