# 查询子网列表 - ListSubnets #### 功能介绍 查询子网列表。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=VPC&version=v2&api=ListSubnets)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-vpc/vpc_permission_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | vpc:subnets:list | List | subnet \* | - | - vpc:subnets:get | - | | vpc:subnets:list | List | - | [g:EnterpriseProjectId](https://support.huaweicloud.com/usermanual-iam5/iam_01_1287.html) | - vpc:subnets:get | - | #### URI GET /v1/{project_id}/subnets 样例： ``` GET https://{Endpoint}/v1/{project_id}/subnets?limit=10&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d&vpc_id=3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85 ``` 参数说明请参见[表1]。 表1参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取项目ID请参见[获取项目ID](https://support.huaweicloud.com/api-vpc/vpc_api_0011.html)。 | | marker | 否 | String | 分页查询的起始资源ID，表示从指定资源的下一条记录开始查询。 marker需要和limit配合使用： - 若不传入marker和limit参数，查询结果返回第一页全部资源记录。 - 若不传入marker参数，limit为10，查询结果返回第1\~10条资源记录。 - 若marker为第10条记录的资源ID，limit为10，查询结果返回第11\~20条资源记录。 - 若marker为第10条记录的资源ID，不传入limit参数，查询结果返回第11\~2000条（limit默认值2000）资源记录。 | | limit | 否 | Integer | 分页查询每页返回的记录个数，取值范围为0\~2000，默认值2000。 limit需要和marker配合使用，详细规则请见marker的参数说明。 | | vpc_id | 否 | String | 按照子网所在VPC ID过滤查询。 企业项目细粒度授权场景下，该字段必传。 | #### 请求参数 无 #### 请求示例 ``` GET https://{Endpoint}/v1/{project_id}/subnets ``` #### 响应参数 表2响应参数 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | subnets | Array of [subnet] objects | subnet对象列表。 | 表3subnet对象 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | id | String | uuid形式的一个资源标识。 | | name | String | - 功能说明：子网名称。 - 取值范围：1-64个字符，支持数字、字母、中文字符、_(下划线)、-（中划线）、.（点）。 | | description | String | - 功能说明：子网描述。 - 取值范围：0-255个字符，不能包含"\<"和"\>"。 | | cidr | String | 子网的网段。 | | gateway_ip | String | 子网的网关。 | | ipv6_enable | Boolean | 是否开启IPv6功能。 | | cidr_v6 | String | IPv6子网的网段，如果子网为IPv4子网，则不返回此参数。 | | gateway_ip_v6 | String | IPv6子网的网关，如果子网为IPv4子网，则不返回此参数。 | | dhcp_enable | Boolean | 子网是否开启dhcp功能。 | | primary_dns | String | 子网dns服务器地址1。 | | secondary_dns | String | 子网dns服务器地址2。 | | dnsList | Array of strings | 子网dns服务器地址列表集。 | | availability_zone | String | 子网所在的可用区标识，仅标识创建子网时指定的可用区，不会限制子网的可用区范围。 | | vpc_id | String | 子网所在VPC标识。 | | status | String | - 功能说明：子网的状态。 - 取值范围：ACTIVE,UNKNOWN,ERROR。 - ACTIVE表示子网已挂载到VPC上。 - UNKNOWN表示子网还未挂载到VPC上。 - ERROR表示子网状态故障。 | | neutron_network_id | String | 对应网络（OpenStack Neutron接口）id。 | | neutron_subnet_id | String | 对应子网（OpenStack Neutron接口）id。 | | enable_network_address_usage_metrics | Boolean | - 功能说明：是否开启当前子网的IPv4地址使用量指标监控。 - 取值范围： - true：开启 - false：不开启 | | available_ip_address_count | Integer | - 功能说明：子网内剩余可用的IPv4地址数量。 | | neutron_subnet_id_v6 | String | 对应IPv6子网（OpenStack Neutron接口）id，如果子网为IPv4子网，则不返回此参数。 | | extra_dhcp_opts | Array of [extra_dhcp_opt] objects | 子网配置的NTP地址或租约时间，详情请参见[extra_dhcp_opt对象]。 | | scope | String | - 功能说明：子网作用域（边缘云场景）。 - 取值范围： - center：表示作用域为中心。 - {publicBorderGroup}：表示作用域为具体的公网边界组。公网边界组限制子网的可用区范围，可关联多个边缘可用区，通过[查询可用区列表](https://support.huaweicloud.com/api-ecs/ecs_02_1501.html)获取。 | | tenant_id | String | - 功能说明：项目ID。 | | created_at | String | - 功能说明：资源创建时间，UTC时间。 - 格式：yyyy-MM-ddTHH:mm:ss。 | | updated_at | String | - 功能说明：资源更新时间，UTC时间。 - 格式：yyyy-MM-ddTHH:mm:ss。 | 表4extra_dhcp_opt对象 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | opt_value | 否 | String | - 功能说明：子网配置的NTP地址、DNS域名或租约到期时间。 - 约束： opt_name配置为"ntp"，则表示是子网ntp地址，目前只支持IPv4地址，每个IP地址以逗号隔开，IP地址个数不能超过4个，不能存在相同地址。 opt_name配置为"domainname"，则该值表示是DNS配置的域名，用于向DNS服务器获取IP地址。域名只能由字母，数字，中划线组成，中划线不能在开头或末尾。域名至少包含两个字符串，单个字符串不超过63个字符，字符串间以点分隔。域名长度不超过254个字符。 opt_name配置为"addresstime"，则该值表示是IPv4子网租约到期时间，取值格式有两种，取-1，表示无限租约；数字+h，数字范围是1\~175200，比如5h，默认值为87600h。 opt_name配置为"ipv6_addresstime"，则该值表示是IPv6子网租约到期时间，取值格式有两种，取-1，表示无限租约；数字+h，数字范围是1\~175200，比如5h，默认值为2h。 该字段为null表示删除该子网的NTP地址、DNS域名或租约到期时间的配置，不能为" "(空字符串)。 | | opt_name | 是 | String | - 功能说明：子网配置的NTP地址、DNS域名或租约到期时间的名称。 - 约束：目前只支持填写字符串"ntp"、"domainname"、"addresstime"或"ipv6_addresstime"。 | #### 响应示例 ``` { "subnets": [ { "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", "name": "subnet", "description": "", "cidr": "192.168.20.0/24", "dnsList": [ "114.xx.xx.114", "114.xx.xx.115" ], "status": "ACTIVE", "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "gateway_ip": "192.168.20.1", "ipv6_enable": true, "cidr_v6": "2001:db8:a583::/64", "gateway_ip_v6": "2001:db8:a583::1", "dhcp_enable": true, "primary_dns": "114.xx.xx.114", "secondary_dns": "114.xx.xx.115", "availability_zone": "aa-bb-cc", "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12", "enable_network_address_usage_metrics": false, "available_ip_address_count": 251, "neutron_subnet_id_v6": "e0fa7de1-a6e2-44c9-b052-b9d8cebe93c4", "extra_dhcp_opts": [ { "opt_value": "10.100.0.33,10.100.0.34", "opt_name": "ntp" }, { "opt_value": "24h", "opt_name": "addresstime" }, { "opt_value": "2h", "opt_name": "ipv6_addresstime" } ], "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", "created_at": "2022-12-15T02:42:07", "updated_at": "2022-12-15T02:42:07" }, { "id": "531dec0f-3116-411b-a21b-e612e42349fd", "name": "Subnet1", "description": "", "cidr": "192.168.1.0/24", "dnsList": [ "114.xx.xx.114", "114.xx.xx.115" ], "status": "ACTIVE", "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "gateway_ip": "192.168.1.1", "ipv6_enable": false, "dhcp_enable": true, "primary_dns": "114.xx.xx.114", "secondary_dns": "114.xx.xx.115", "availability_zone": "aa-bb-cc", "neutron_network_id": "531dec0f-3116-411b-a21b-e612e42349fd", "neutron_subnet_id": "1aac193-a2ad-f153-d122-12d64c2c1d78", "enable_network_address_usage_metrics": false, "available_ip_address_count": 251, "extra_dhcp_opts": [ { "opt_value": "10.100.0.33,10.100.0.34", "opt_name": "ntp" }, { "opt_value": "24h", "opt_name": "addresstime" } ], "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", "created_at": "2022-12-15T03:41:22", "updated_at": "2022-12-15T03:41:22" } ] } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-vpc/vpc_api_0002.html)。 #### 错误码 请参考[错误码](https://support.huaweicloud.com/api-vpc/vpc_api_0003.html)。