# 查询子网列表 - ListSubnets
#### 功能介绍
查询子网列表。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Workspace/doc?api=ListSubnets)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                            | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项                                                                                                                                                                                             |
  |:---|:---|:---|:---|:---|:---|
  | workspace:networks:listSubnets | List | -           | -   | -  | - vpc:subnets:list  - vpc:subnets:get   |
     
  
 
#### URI
GET /v2/{project_id}/subnets
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述    |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目ID。 |
   
表2Query参数 
| 参数                   | 是否必选 | 参数类型   | 描述       |
|:---|:---|:---|:---|
| vpc_id               | 否    | String | 虚拟私有云ID。 |
| availability_zone_id | 否    | String | 可用区id。   |
   
#### 请求参数
无
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数          | 参数类型                                                                         | 描述    |
|:---|:---|:---|
| subnets     | Array of [SingleSubnetInfo] objects | 子网列表。 |
| subnet_size | Integer                                                                      | 子网数量。 |
   
 表4SingleSubnetInfo 
| 参数                     | 参数类型    | 描述                                          |
|:---|:---|:---|
| id                     | String  | 子网ID。                                       |
| unused                 | Boolean | 是否未被workspace真正使用。如果未使用，则表示可以从workspace中删除。 |
| checked                | Boolean | 是否已被workspace选择使用。                          |
| vpc_id                 | String  | VPC ID。                                     |
| name                   | String  | 子网名称。                                       |
| cidr                   | String  | 子网网段。                                       |
| gateway_ip             | String  | 子网网关。                                       |
| dhcp_enable            | Boolean | 是否支持DHCP。                                   |
| ipv6_enable            | Boolean | 是否支持IPV6。                                   |
| primary_dns            | String  | 主DNS。                                       |
| secondary_dns          | String  | 备DNS。                                       |
| status                 | String  | 子网状态。                                       |
| availability_zone      | String  | 可用区。                                        |
| neutron_subnet_id      | String  | 网络id。                                       |
| neutron_ipv6_subnet_id | String  | ipv6网络id。                                   |
| description            | String  | 描述。                                         |
   
**状态码：400**
表5响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码。                                                         |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
**状态码：401**
表6响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码。                                                         |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
**状态码：403**
表7响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码。                                                         |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
**状态码：404**
表8响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码。                                                         |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
**状态码：405**
表9响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码。                                                         |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
**状态码：500**
表10响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码。                                                         |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
**状态码：503**
表11响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码。                                                         |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
#### 请求示例
```
GET /v2/0e3f393ae380f5d12facc005678bcd4b/subnets?vpc_id=dec4a11c-717e-4337-8985-81425133dc32
```
#### 响应示例
**状态码：200**
查询子网列表响应。
```
{
  "subnets" : [ {
    "id" : "63cdf62c-6114-469d-a16d-9b8128e75106",
    "vpc_id" : "210a7165-439f-46ea-96a8-3ba3981b6f49",
    "name" : "subnet-cyctest",
    "cidr" : "192.168.2.0/24",
    "gateway_ip" : "192.168.2.1",
    "dhcp_enable" : "true",
    "ipv6_enable" : "false",
    "primary_dns" : "100.79.1.250",
    "status" : "ACTIVE",
    "availability_zone" : "cn-north-7a",
    "neutron_subnet_id" : "6081c420-23cb-4741-9bfd-743e71372604",
    "description" : "aabb"
  }, {
    "id" : "7f8022b3-937d-4259-8459-b58ce160dca5",
    "vpc_id" : "46eddaf2-fb03-4645-8d23-5f741aee76ed",
    "name" : "subnet-sce01",
    "cidr" : "192.168.0.0/24",
    "gateway_ip" : "192.168.0.1",
    "dhcp_enable" : true,
    "ipv6_enable" : false,
    "primary_dns" : "100.79.1.250",
    "status" : "ACTIVE",
    "availability_zone" : "cn-north-7a",
    "neutron_subnet_id" : "f002b78d-bba3-4e78-95ad-60448b5c5d56",
    "description" : "test"
  } ]
}
```
#### 状态码
| 状态码 | 描述                      |
|:---|:---|
| 200 | 查询子网列表响应。               |
| 400 | 由于包含语法错误，当前请求无法被服务器理解。  |
| 401 | 鉴权失败。                   |
| 403 | 没有操作权限。                 |
| 404 | 找不到资源。                  |
| 405 | 请求中指定的方法不被允许。           |
| 500 | 服务内部错误，具体返回错误码请参见错误码说明。 |
| 503 | 服务不可用。                  |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode.html)。