查询网络列表
功能介绍
查询提交请求的租户的所有网络，单次查询最多返回2000条数据，超过2000后会返回分页标记分页。
调试
您可以在API Explorer中调试该接口。
URI
GET /v2.0/networks
样例：
GET https://{Endpoint}/v2.0/networks?id={network_id}&status={network_status}&name={network_name}&admin_state_up=${admin_state_up}&tenant_id={tenant_id}&shared={is_shared}&provider:network_type={geneve}
分页查询样例：
GET https://{Endpoint}/v2.0/networks?limit=2&marker=0133cd73-34d4-4d4c-bf1f-e65b24603206&page_reverse=False
参数说明请参见表1。
|
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
id |
否 |
String |
按照网络对应的ID过滤查询 |
|
name |
否 |
String |
按照网络的名称过滤查询 |
|
admin_state_up |
否 |
Boolean |
按照网络的管理状态过滤查询 取值范围：true or false |
|
provider:network_type |
否 |
String |
按照网络的类型过滤查询 |
|
shared |
否 |
Boolean |
按照网络是否支持跨租户共享过滤查询 取值范围：true or false |
|
status |
否 |
String |
按照网络的状态过滤查询 取值范围：ACTIVE、BUILD、DOWN |
|
router:external |
否 |
Boolean |
按照网络是否外部网络过滤查询 取值范围：true or false |
|
tenant_id |
否 |
String |
按照网络所属的项目ID过滤查询 |
|
marker |
否 |
String |
分页查询的起始资源ID，表示从指定资源的下一条记录开始查询。 marker需要和limit配合使用：
|
|
limit |
否 |
Integer |
分页查询每页返回的记录个数，取值范围为0~intmax（2^31-1），默认值2000。 limit需要和marker配合使用，详细规则请见marker的参数说明。 |
请求参数
无。
请求示例
GET https://{Endpoint}/v2.0/networks?limit=1
响应参数
|
参数名称 |
类型 |
说明 |
|---|---|---|
|
networks |
Array of network objects |
network对象列表，参见表3。 |
|
networks_links |
Array of networks_link objects |
分页信息，参见表4。 只有在使用limit过滤，并且资源个数超过limit或者资源个数超过2000时（limit默认值），该参数的rel和href取值才会显示为next和其对应的link。 |
|
属性 |
类型 |
说明 |
|---|---|---|
|
status |
String |
网络状态，可以为ACTIVE，BUILD，DOWN或ERROR。 |
|
subnets |
Array of strings |
网络关联的子网ID。 一个network仅支持关联一个subnet。 |
|
name |
String |
网络名称。 name不能为admin_external_net（预置网络名称，不可占用）。 |
|
router:external |
Boolean |
扩展属性：是否外部网络，默认值false。 |
|
admin_state_up |
Boolean |
管理状态。 只支持true。 |
|
tenant_id |
String |
项目ID |
|
shared |
Boolean |
是否支持跨租户共享。 |
|
id |
String |
网络的id |
|
provider:network_type |
String |
扩展属性：网络类型。 取值范围：支持租户创建geneve、vxlan类型的网络 租户只能指定此参数为geneve，不指定时网络类型自动分配，一般分配为vxlan类型。预置网络admin_external_net的情况下，此参数为vlan，用户不可配置。 【使用说明】
|
|
availability_zone_hints |
Array of strings |
本网络的候选可用域，当前版本不支持可用域调度。 |
|
availability_zones |
Array of strings |
本网络的可用域。 |
|
port_security_enabled |
Boolean |
端口安全使能标记，如果不使能，则network下所有虚机的安全组和dhcp防欺骗不生效 |
|
dns_domain |
String |
默认内网DNS域地址，系统自动生成维护，不支持设置和更新 |
|
project_id |
String |
项目ID，请参见获取项目ID。 |
|
created_at |
String |
资源创建时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss |
|
updated_at |
String |
资源更新时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss |
响应示例
{
"networks": [
{
"id": "0133cd73-34d4-4d4c-bf1f-e65b24603206",
"name": "3804f26c-7862-43b6-ad3c-48445f42de89",
"status": "ACTIVE",
"shared": false,
"subnets": [
"423796f5-e02f-476f-bf02-2b88c8ddac8b"
],
"availability_zone_hints": [],
"availability_zones": [
"az2.dc2",
"az5.dc5"
],
"admin_state_up": true,
"tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"project_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"provider:network_type": "vxlan",
"router:external": false,
"port_security_enabled": true,
"created_at": "2018-03-23T03:51:58",
"updated_at": "2018-03-23T03:51:58"
}
],
"networks_links": [
{
"rel": "next",
"href": "https://{Endpoint}/v2.0/networks?limit=1&marker=0133cd73-34d4-4d4c-bf1f-e65b24603206"
},
{ "rel": "previous",
"href": "https://{Endpoint}/v2.0/subnets?limit=1&marker=0133cd73-34d4-4d4c-bf1f-e65b24603206&page_reverse=True"
}
]
}
状态码
请参见状态码。
错误码
请参见错误码。
