1. 接口描述
本接口（DescribeVpcEx）用于查询私有网络列表。
接口请求域名：vpc.api.qcloud.com
本接口不传参数时，返回默认排序下的前20条 VPC 信息。
2. 输入参数
以下请求参数列表仅列出了接口请求参数，正式调用时需要加上公共请求参数，详情请参见 公共请求参数 页面。其中，此接口的 Action 字段为 DescribeVpcEx。
| 参数名称 | 是否必选 | 类型 | 描述 |
|---|---|---|---|
| vpcId | 否 | String | 系统分配的私有网络 ID，支持升级前的 vpcId，也支持升级后的 unVpcId。 |
| vpcName | 否 | String | 私有网络名称，支持模糊搜索。 |
| offset | 否 | Int | 初始行的偏移量，默认为0。 |
| limit | 否 | Int | 每页行数，默认为20。 |
| orderField | 否 | String | 按某个字段排序，目前仅支持 createTime，vpcName 排序，默认按 createTime 排序。 |
| orderDirection | 否 | String | 升序（asc）还是降序（desc），默认：desc。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | Int | 公共错误码，0表示成功，其他值表示失败。详见错误码页面的 公共错误码 。 |
| message | String | 模块错误信息描述，与接口相关。 |
| totalCount | Int | 开发商 VPC 总数。 |
| data.n | Array | VPC 信息组。 |
| data.n.vpcId | String | 系统分配的 vpcId，例如：gz_vpc_266。 |
| data.n.unVpcId | String | 系统分配的新 vpcID，由子网 ID 升级而来，推荐使用新 vpcId，示例:vpc-5gu2jxf4。 |
| data.n.vpcName | String | 私有网络名称。 |
| data.n.cidrBlock | String | 私有网络网段，例如：192.168.0.1/24。 |
| data.n.subnetNum | Int | VPC 下子网个数。 |
| data.n.routeTableNum | Int | VPC 下路由表个数。 |
| data.n.vpnGwNum | Int | VPC 下 VPN 网关个数。 |
| data.n.vpcPeerNum | Int | VPC 下对等连接个数。 |
| data.n.vpcDeviceNum | Int | VPC 下云服务器个数。 |
| data.n.classicLinkNum | Int | VPC 下与 VPC 互通的基础网络设备个数。 |
| data.n.vpgNum | Int | VPC 下专线网关个数。 |
| data.n.natNum | Int | VPC 下 NAT 网关个数。 |
| data.n.createTime | String | VPC 创建时间。 |
| data.n.isDefault | Bool | 是否是默认 VPC。 |
4. 错误码表
以下错误码表仅列出了该接口的业务逻辑错误码，更多公共错误码详见 VPC 错误码。
| 错误码 | 描述 |
|---|---|
| InvalidVpc.NotFound | 无效的 VPC，VPC 资源不存在，请再次核实您输入的资源信息是否正确。 |
5. 示例
输入
https://vpc.api.qcloud.com/v2/index.php?Action=DescribeVpcEx
&<公共请求参数>
&vpcId=vpc-2ari9m7h
&offset=0
&limit=1
&orderDirection=desc
输出
{
"code": 0,
"message": "",
"totalCount":10,
"data":[
{
"vpcId":"gz_vpc_245",
"unVpcId":"vpc-8e0ypm3z",
"vpcName":"alblack.bbb",
"cidrBlock":"10.0.0.0/24",
"subnetNum":0,
"routeTableNum":5,
"vpnGwNum":3,
"vpcPeerNum":5,
"vpcDeviceNum":0,
"classicLinkNum":1,
"vpgNum":0,
"natNum":0,
"createTime":"2015-08-24 15:05:16"
}
]
}
