DescribeVpcs - 查询VPC列表_云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

查询vpc列表

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeVpcs

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
ZoneId	string	否	可用区 ID。说明可通过 DescribeRegions 查看可用区。	cn-hangzhou-i
Product	string	否	云产品名称。	VPN
PageSize	integer	否	每页记录数，取值范围： 30 50 100 默认值为 30。	30
PageNumber	integer	否	页码，取值范围为大于 0 但不超过 Integer 最大值的整数，默认值为 1。	3
ResourceGroupId	string	否	VPC 所属的资源组 ID。	rg-acfmzh544n3j3bi
VpcId	string	否	VPC ID。说明可通过接口 DescribeVpcs 查看 VPC 信息详情。	vpc-*************

返回参数

名称	类型	描述	示例值
	object
PageNumber	integer	列表的页码，默认值为 1。	2
PageSize	integer	每页记录数，取值范围如下： 30 50 100 默认值为 30。	50
RequestId	string	请求 ID。	11FDB5A0-84F5-5361-B729-5770B0AEB9D5
TotalCount	integer	列表条目数。	50
Vpcs	array<object>	VPC 列表
	object	VPC 列表
AliUid	string	阿里云账号 ID。	1868512340232755
Bid	string	区分账户是金融云、政务云或公有云。	26842
CidrBlock	string	交换机的 IPv4 网段。	57.100.6.59/32
GmtCreate	string	创建时间	2021-04-18T15:02:37Z
GmtModified	string	VPC 的修改时间。	2021-04-18T15:02:37Z
IsDefault	boolean	是否是默认交换机，取值： true：是默认交换机。 false：非默认交换机。	true
RegionNo	string	交换机所属的地域 ID。	cn-chengdu-wt97-a01
Status	string	VPC 的状态，取值： `Pending`：配置中 `Available`：可用	Pending
VSwitchs	array<object>	交换机列表。
	object	交换机信息详情
CidrBlock	string	交换机的 IPv4 网段。	47.118.126.0/25
GmtCreate	string	VPC 创建时间。	2021-04-18T15:02:37Z
GmtModified	string	VPC 修改时间	2021-04-18T15:02:37Z
IsDefault	boolean	是否是默认交换机，取值： true：是默认交换机。 false：非默认交换机。	false
IzNo	string	vSwitch 所属的可用区。	cn-shenzhen-f
Status	string	交换机的状态，取值： Pending：配置中。 Available：可用。	Pending
VSwitchId	string	交换机的 ID。	vsw-uf6fus5py6hbvxqwzwnk8
VSwitchName	string	交换机的名称。	default-sw
VpcId	string	VPC ID。说明可通过接口 DescribeVpcs 查看 VPC 信息详情。	vpc-bp16efwqjzyumc23c647v
VpcName	string	VPC 的名称。	vpc-e2e-10341f3

示例

正常返回示例

JSON格式

{
  "PageNumber": 2,
  "PageSize": 50,
  "RequestId": "11FDB5A0-84F5-5361-B729-5770B0AEB9D5",
  "TotalCount": 50,
  "Vpcs": [
    {
      "AliUid": "1868512340232755",
      "Bid": "26842",
      "CidrBlock": "57.100.6.59/32",
      "GmtCreate": "2021-04-18T15:02:37Z\n",
      "GmtModified": "2021-04-18T15:02:37Z\n",
      "IsDefault": true,
      "RegionNo": "cn-chengdu-wt97-a01",
      "Status": "Pending",
      "VSwitchs": [
        {
          "CidrBlock": "47.118.126.0/25",
          "GmtCreate": "2021-04-18T15:02:37Z",
          "GmtModified": "2021-04-18T15:02:37Z",
          "IsDefault": false,
          "IzNo": "cn-shenzhen-f",
          "Status": "Pending",
          "VSwitchId": "vsw-uf6fus5py6hbvxqwzwnk8",
          "VSwitchName": "default-sw"
        }
      ],
      "VpcId": "vpc-bp16efwqjzyumc23c647v",
      "VpcName": "vpc-e2e-10341f3"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	PARAMETER_MUST_NOT_NULL	Miss mandatory parameter.

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

变更历史

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