文档首页/ 虚拟私有云 VPC/ API参考（阿布扎比区域） / 历史API/ API（OpenStack Neutron V2.0 原生）/ 网络/ 查询网络列表
更新时间：2022-01-25 GMT+08:00
查看PDF
分享

查询网络列表

功能介绍

查询提交请求的租户的所有网络，

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。

表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，为空时为查询第一页

limit

否

Integer

每页返回的个数

取值范围：0~intmax

请求消息

无。

响应消息

表2 响应参数

参数名称

类型

说明

networks

Array of network objects

network对象列表，参见表3。

networks_links

Array of networks_link objects

分页信息，参见表4。
表3 network对象

属性

类型

说明

status

String

网络状态，可以为ACTIVE，BUILD，DOWN或ERROR。

subnets

Array of strings

网络关联的子网ID列表。

一个network仅支持关联一个 subnet。

name

String

网络名称。

name不能为admin_external_net。

router:external

Boolean

扩展属性：是否外部网络

admin_state_up

Boolean

管理状态。

只支持true。

tenant_id

String

项目ID

shared

Boolean

是否支持跨租户共享。

id

String

网络的id

【使用说明】在查询网络列表时候非必选

provider:network_type

String

扩展属性：网络类型（支持vxlan, geneve）。

租户只能创建geneve类型网络。

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

created_at

String

资源创建时间，UTC时间

格式：yyyy-MM-ddTHH:mm:ss

updated_at

String

资源更新时间，UTC时间

格式：yyyy-MM-ddTHH:mm:ss
表4 networks_link对象

参数名称

类型

说明

href

String

API链接

rel

String

API链接与该API版本的关系

样例

请求样例

GET https://{Endpoint}/v2.0/networks?limit=1

响应样例

{
    "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"
        }
    ]
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 网络