查询子网列表
功能介绍
根据查询条件获取子网的列表信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/subnets
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
limit |
否 |
Integer |
查询返回边缘子网列表数量。取值范围：0~1000。 最小值：0 最大值：1000 |
offset |
否 |
Integer |
查询的偏移量。 |
site_id |
否 |
String |
站点ID。 |
vpc_id |
否 |
String |
虚拟私有云ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
subnets |
Array of Subnet objects |
子网数组。 |
count |
Integer |
子网数目。 |
参数 |
参数类型 |
描述 |
|---|---|---|
id |
String |
子网的ID。 |
name |
String |
子网名称 取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点） |
cidr |
String |
子网的网段 取值范围：必须在vpc对应cidr范围内 约束：必须是cidr格式。掩码长度不能大于28 |
dnsList |
Array of strings |
子网dns服务器地址列表 |
gateway_ip |
String |
子网的网关 取值范围：子网网段中的IP地址 约束：必须是ip格式 |
dhcp_enable |
Boolean |
子网是否开启dhcp功能 |
primary_dns |
String |
子网dns服务器地址1 |
secondary_dns |
String |
子网dns服务器地址2 |
status |
String |
子网的状态 取值范围：
|
vpc_id |
String |
虚拟私有云ID。 |
site_id |
String |
子网所属的站点ID。 |
site_info |
String |
子网所属的站点信息。 |
neutron_network_id |
String |
对应网络（OpenStack Neutron接口） id。 |
neutron_subnet_id |
String |
对应子网（OpenStack Neutron接口） id。 |
cidr_v6 |
String |
IPv6子网的网段，如果子网为IPv4子网，则不返回此参数 |
ipv6_enable |
Boolean |
是否是IPv6子网 取值范围：true，false |
pool_id |
String |
IPv6线路ID，如果子网为IPv4子网，则不返回此参数。 |
neutron_subnet_id_v6 |
String |
对应IPv6子网（OpenStack Neutron接口）id，如果子网为IPv4子网，则不返回此参数。 |
gateway_ip_v6 |
String |
IPv6子网的网关，如果子网为IPv4子网，则不返回此参数。 |
请求示例
GET https://{{endpoint}}/v1/subnets?limit=1000&offset=0
响应示例
状态码： 200
OK
{
"subnets" : [ {
"id" : "99d9d709-8478-4b46-9f3f-2206b1023fd3",
"name" : "dc1_subnet_001",
"cidr" : "172.168.1.0/24",
"dnsList" : [ "10.2.3.21", "10.32.54.2" ],
"gateway_ip" : "172.168.1.1",
"dhcp_enable" : true,
"primary_dns" : null,
"secondary_dns" : null,
"status" : "ACTIVE",
"vpc_id" : "4a532e51-0649-41b1-b120-49c60c6b0638",
"site_id" : "e3b52316-05be-11ea-bc35-286ed488d287",
"site_info" : "中国/华中地区/湖北/武汉市",
"neutron_network_id" : "e3b52316-05be-11ea-bc35-286ed488d287",
"neutron_subnet_id" : "e3b52316-05be-11ea-bc35-286ed488d287"
} ],
"count" : 1
}
状态码
状态码 |
描述 |
|---|---|
200 |
OK |
错误码
请参见错误码。
