查询子网列表
功能介绍
查询子网列表。
调试
您可以在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
|
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取项目ID请参见获取项目ID。 |
|
marker |
否 |
String |
分页查询的起始资源ID，表示从指定资源的下一条记录开始查询。 marker需要和limit配合使用：
|
|
limit |
否 |
Integer |
分页查询每页返回的记录个数，取值范围为0~intmax（2^31-1），默认值2000。 limit需要和marker配合使用，详细规则请见marker的参数说明。 |
|
vpc_id |
否 |
String |
按照子网所在VPC ID过滤查询。 企业项目细粒度授权场景下，该字段必传。 |
请求参数
无
请求示例
GET https://{Endpoint}/v1/{project_id}/subnets
响应参数
|
名称 |
参数类型 |
说明 |
|---|---|---|
|
subnets |
Array of subnet objects |
subnet对象列表。 |
|
名称 |
参数类型 |
说明 |
|---|---|---|
|
id |
String |
uuid形式的一个资源标识。 |
|
name |
String |
|
|
description |
String |
|
|
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 |
|
|
neutron_network_id |
String |
对应网络（OpenStack Neutron接口）id。 |
|
neutron_subnet_id |
String |
对应子网（OpenStack Neutron接口）id。 |
|
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 |
|
|
tenant_id |
String |
|
|
created_at |
String |
|
|
updated_at |
String |
|
响应示例
{
"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",
"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"
}
],
"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",
"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"
}
]
}
状态码
请参见状态码。
错误码
请参考错误码。
