查询VPC列表

最近更新时间:2019-07-24 15:03:04

1. 接口描述

接口请求域名: bmvpc.tencentcloudapi.com 。

本接口(DescribeVpcs)用于查询私有网络列表。 本接口不传参数时,返回默认排序下的前20条VPC信息。

默认接口请求频率限制:20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeVpcs
Version String 公共参数,本接口取值:2018-06-25
Region String 公共参数,本接口不需要传递此参数。
VpcIds.N Array of String VPC实例ID。形如:vpc-f49l6u0z。每次请求的实例的上限为100。参数不支持同时指定VpcIds和Filters。
Filters.N Array of Filter 过滤条件,参数不支持同时指定VpcIds和Filters。
vpc-name - String - (过滤条件)VPC实例名称。
vpc-id - String - (过滤条件)VPC实例ID形如:vpc-f49l6u0z。
cidr-block - String - (过滤条件)vpc的cidr。
state - String - (过滤条件)VPC状态。(pending | available).
zone - String - (过滤条件)VPC的可用区。
Offset Integer 初始行的偏移量,默认为0。
Limit Integer 每页行数,默认为20。

3. 输出参数

参数名称 类型 描述
VpcSet Array of VpcInfo VPC列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询VPC列表

输入示例

https://bmvpc.tencentcloudapi.com/?Action=DescribeVpcs
&VpcIds.0=vpc-ox7p0l9u
&VpcIds.1=vpc-jvxdy07y
&<公共请求参数>

输出示例

{
  "Response": {
    "VpcSet": [
      {
        "VpcId": "vpc-ox7p0l9u",
        "VpcName": "autocreate_20180320",
        "CidrBlock": "10.104.0.0/16",
        "Zone": "1000100003",
        "State": "available",
        "CreateTime": "2018-03-20 11:40:49"
      },
      {
        "VpcId": "vpc-jvxdy07y",
        "VpcName": "test-vpc",
        "CidrBlock": "172.16.0.0/16",
        "Zone": "1000100003",
        "State": "available",
        "CreateTime": "2018-06-12 10:13:17"
      }
    ],
    "RequestId": "72899e7e-dbeb-4add-bf8f-8efe5a315f98"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误
InvalidParameter 参数错误