错误码
4.2.3 查询子网列表
}
状态码
请参见A.3 状态码。
错误码
请参考A.4 错误码。
4.2.3 查询子网列表
功能介绍
查询子网列表。
调试
您可以在API Explorer中调试该接口。
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
表4-34 参数说明
名称 是否必选 参数类型 说明
project_id 是 String 项目ID,获取项目ID请参见A.5 获取项 目ID。
marker 否 String 分页查询的起始资源ID,表示从指定资 源的下一条记录开始查询。
marker需要和limit配合使用:
● 若不传入marker和limit参数,查询 结果返回全部资源记录。
● 若不传入marker参数,limit为10,
查询结果返回第1~10条资源记录。
● 若marker为第10条记录的资源ID,
limit为10,查询结果返回第11~20 条资源记录。
● 若marker为第10条记录的资源ID,
不传入limit参数,查询结果返回第 11条及之后的所有资源记录。
名称 是否必选 参数类型 说明
limit 否 Integer 分页查询每页返回的记录个数,取值范 围为0~intmax。
limit需要和marker配合使用,详细规 则请见marker的参数说明。
vpc_id 否 String 按照vpc_id过滤查询
企业项目细粒度授权场景下,该字段必 传
请求消息
● 请求参数 无
● 请求样例
GET https://{Endpoint}/v1/{project_id}/subnets
响应消息
● 响应参数
表4-35 响应参数
名称 参数类型 说明
subnets Array of
subnet objects subnet对象列表
表4-36 subnet 对象
名称 参数类型 说明
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 neutron_subnet_id_v
6 String 对应IPv6子网(OpenStack Neutron接 口)id,如果子网为IPv4子网,则不返回 此参数
extra_dhcp_opts Array of extra_dhc p_opt objects
子网配置的NTP地址或租约时间,详情请 参见extra_dhcp_opt对象。
scope String 子网作用域。
取值范围:
● center:表示作用域为中心
● {azId}:表示作用域为具体的可用区
表4-37 extra_dhcp_opt 对象
名称 是否必选 参数类型 说明
opt_value 否 String ● 功能说明:子网配置的NTP地 址或子网配置的租约到期时
opt_name 是 String ● 功能说明:子网配置的NTP地 址名称或子网配置的租约到期
"id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", "name": "subnet",
"vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "gateway_ip": "192.168.20.1",
"neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12", "neutron_subnet_id_v6": "e0fa7de1-a6e2-44c9-b052-b9d8cebe93c4", "extra_dhcp_opts": [
"opt_value": "24h",
"id": "531dec0f-3116-411b-a21b-e612e42349fd", "name": "Subnet1",
"vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "gateway_ip": "192.168.1.1",
"neutron_network_id": "531dec0f-3116-411b-a21b-e612e42349fd", "neutron_subnet_id": "1aac193-a2ad-f153-d122-12d64c2c1d78", "extra_dhcp_opts": [