DescribeVpcs

DescribeVpcs

1. 接口描述

本接口用于查询一台或多台指定VPC的信息。用户可以根据 VPC ID、VPC 名称等信息来搜索VPC信息

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称	必选	类型	描述
vpcIds	否	Array of String	一个或多个待操作的VPC ID
name	否	String	VPC的名称 支持模糊查询
cidrBlock	否	String	VPC的CIDR 支持模糊查询
pageSize	否	Integer	返回的分页大小。 默认为20，最大为1000。
pageNum	否	Integer	返回的分页数。 默认为1。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID。 每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
dataSet	Array of VpcInfo	VpcInfo结果集
totalCount	Integer	符合条件的数据总数

4. 代码示例

示例

1. 分页查询CidrBlock为“10.0.0.0/24”的VPC列表

POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeVpcs
<Common Request Params>

Request:
{
  "cidrBlock": "10.0.0.0/24",
  "pageSize": 10,
  "pageNum": 1
}

Response:
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F"
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP状态码	错误码	说明
500	CREATE_SUBNET_FAILED	创建失败。
400	UNSUPPORTED_OPERATION_SUBNET_BIND_NETWORK_COUNT_LIMIT	达到子网的数量限制。
400	UNSUPPORTED_OPERATION_CIDR_BLOCK_IS_EXIST	CIDR 地址冲突。请检查子网下是否存在相同的CIDR地址段。
400	INVALID_CIDR_BLOCK_FORMAT	CIDR 格式错误。请注意是否为IP/掩码格式。
400	INVALID_CIDR_BLOCK_NETMASK	CIDR 掩码范围不支持。
400	INVALID_CIDR_BLOCK_NOT_LAN_IP	CIDR 不是私有网络段。
400	INVALID_CIDR_BLOCK_INVALID_INTERNAL_IP	CIDR 非法的内网地址段。
400	INVALID_REGION_NOT_ON_SALE	指定的区域未开售。