> 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/bmc/vpc/subnet/describesubnets.md).

# DescribeSubnets

## 1. 接口描述

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

## 2. 请求参数

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

| 参数名称            | 必选 | 类型                                                                  | 描述                                                         |
| --------------- | -- | ------------------------------------------------------------------- | ---------------------------------------------------------- |
| subnetIds       | 否  | Array of String                                                     | <p>Subnet ID。</p><p>取值可以由多个Subnet ID组成一个。最多支持100个ID查询。</p> |
| subnetName      | 否  | String                                                              | Subnet的名称。                                                 |
| cidrBlock       | 否  | String                                                              | Subnet的CIDR。                                               |
| subnetStatus    | 否  | [SubnetStatus](/api-reference/cn/bmc/datastructure.md#subnetstatus) | Subnet的状态。                                                 |
| zoneId          | 否  | String                                                              | Subnet所属的可用区ID。                                            |
| vpcId           | 否  | String                                                              | VPC ID。                                                    |
| resourceGroupId | 否  | String                                                              | <p>资源组的ID。</p><p>如果不传，则返回该用户可见的所有资源组内的Subnet。</p>          |
| pageSize        | 否  | Integer                                                             | <p>返回的分页大小。</p><p>默认为20，最大为1000。</p>                       |
| pageNum         | 否  | Integer                                                             | <p>返回的分页数。</p><p>默认值：1</p>                                 |

## 3. 响应结果

| 参数名称       | 类型                                                                       | 描述                                                       |
| ---------- | ------------------------------------------------------------------------ | -------------------------------------------------------- |
| requestId  | String                                                                   | <p>唯一请求 ID。</p><p>每次请求都会返回。定位问题时需要提供该次请求的 requestId。</p> |
| totalCount | Integer                                                                  | 符合条件的数据总数。                                               |
| dataSet    | Array of [SubnetInfo](/api-reference/cn/bmc/datastructure.md#subnetinfo) | SubnetInfo结果集。                                           |

## 4. 代码示例

{% tabs %}
{% tab title="示例" %}
**1. 分页查询CidrBlock为“10.0.0.0/8”的Subnet列表**

```json
POST /api/v2/bmc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeSubnets
Request:
{
  "cidrBlock": "10.0.0.0/8",
  "pageSize": 10,
  "pageNum": 1
}
Response:
{
  "requestId": "T2CF86177-29D1-41C0-91E7-542C38C194D7",
  "response": {
    "requestId": "T2CF86177-29D1-41C0-91E7-542C38C194D7",
    "totalCount": 8,
    "dataSet": [
      {
        "subnetId": "your-subnet-id",
        "subnetName": "Subnet-LAXB-Default",
        "zoneId": "LAX-B",
        "availableIpCount": "16777213",
        "cidrBlock": "10.0.0.0/8",
        "subnetStatus": "AVAILABLE",
        "createTime": "2022-07-13T09:43:16Z",
        "vpcSubnetStatus": "BINDED",
        "vpcId": null,
        "vpcName": null,
        "resourceGroupId": "your-resource-group",
        "resourceGroupName": "Default Resource Group",
        "subnetInstanceSet": null
      }
    ]
  }
}
```

{% 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状态码 | 错误码 | 说明 |
| ------- | --- | -- |