> For the complete documentation index, see [llms.txt](https://docs.console.zenlayer.com/api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.console.zenlayer.com/api-reference/cn/compute/zec/vpc-network/describevpcs.md).

# DescribeVpcs

## 1. 接口描述

本接口(DescribeVpcs)用于查询私有网络（VPC）列表，用户可以根据 VPC ID、VPC 名称等信息来筛选过滤VPC信息。

## 2. 请求参数

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

| 参数名称            | 必选 | 类型                                                                 | 描述                                                  |
| --------------- | -- | ------------------------------------------------------------------ | --------------------------------------------------- |
| vpcIds          | 否  | Array of String                                                    | <p>VPC的ID列表。</p><p>最多可传100个ID。</p>                  |
| name            | 否  | String                                                             | <p>根据VPC名称过滤。</p><p>支持模糊查询。</p>                     |
| cidrBlock       | 否  | String                                                             | <p>根据VPC的IPv4 CIDR过滤。</p><p>支持模糊查询。</p>             |
| pageSize        | 否  | Integer                                                            | <p>返回的分页大小。</p><p>可选值范围：\[1, 1000]</p><p>默认值：20</p> |
| pageNum         | 否  | Integer                                                            | <p>返回的分页数。</p><p>可选值范围：\[1, +)</p><p>默认值：1</p>      |
| resourceGroupId | 否  | String                                                             | 根据资源组ID过滤。                                          |
| tagKeys         | 否  | Array of String                                                    | <p>根据标签键进行搜索。</p><p>最长不得超过20个标签键。</p>               |
| tags            | 否  | Array of [Tag](/api-reference/cn/compute/zec/datastructure.md#tag) | <p>根据标签进行搜索。</p><p>最长不得超过20个标签。</p>                 |

## 3. 响应结果

| 参数名称       | 类型                                                                         | 描述                                                       |
| ---------- | -------------------------------------------------------------------------- | -------------------------------------------------------- |
| requestId  | String                                                                     | <p>唯一请求 ID。</p><p>每次请求都会返回。定位问题时需要提供该次请求的 requestId。</p> |
| totalCount | Integer                                                                    | 匹配筛选条件的vpc总数量。                                           |
| dataSet    | Array of [VpcInfo](/api-reference/cn/compute/zec/datastructure.md#vpcinfo) | 返回分页的vpc集合数据。                                            |

## 4. 代码示例

{% tabs %}
{% tab title="示例" %}
**1. 查询CidrBlock为`10.0.0.0/24`的VPC列表**

```json
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",
    "dataSet": [
      {
        "vpcId": "xxx",
        "name": "xxx",
        "cidrBlock": "10.0.0.0/8",
        "ipv6CidrBlock": "",
        "mtu": 1000,
        "isDefault": true,
        "createTime": "2022-01-01T01:00:00Z",
        "usageIpv4Count": 256,
        "securityGroupId": "xxx",
        "resourceGroup":{
          "resourceGroupId": "<resourceGroupId>",
          "resourceGroupName": "Test"
        },
        "tags":null
      }
    ],
    "totalCount": 1
  }
}
```

{% endtab %}
{% endtabs %}

## 5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的[开发工具集（SDK）](/api-reference/cn/api-introduction/toolkit.md)，未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

## 6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见[公共错误码](/api-reference/cn/api-introduction/instruction/commonerrorcode.md)

| HTTP状态码 | 错误码 | 说明 |
| ------- | --- | -- |