列举网络

功能介绍

列出租户有权访问的网络。除具有管理权限的用户提交列举子网的请求外，默认策略是只返回提交请求的用户所拥有的网络。

URI

GET /v2.0/networks

请求消息

无。

请求示例

无。

响应消息

参数	参数类型	描述
id	String	网络ID。
tenant_id	String	项目ID。
project_id	String	项目ID。
name	String	资源的人类可读名称。
admin_state_up	boolean	该网络是否启动。
port_security_enabled	boolean	该网络是否开启网络安全防护功能。如果使用安全组功能，此配置项一定为打开。
mtu	integer	该网络数据包最大传输单元大小。
shared	boolean	该网络是否允许全资源池项目都可见。
router:external	boolean	该网络是否为外部网络。
availability_zone_hints	array	该网络的可用区候补选项。
availability_zones	array	该网络的可用区。
subnets	array	该网络的状态。
provider:network_type	String	该网络的类型。例如flat、vlan、vxlan。
provider:physical_network	String	该网络的segment来自哪个物理网络。
provider:segmentation_id	String	该网络的segmentation ID。
ipv4_address_scope	String	该网络关联的ipv4地址scope。
status	String	该网络的状态。
description	String	该网络的自定义描述。
tags	array	该网络的自定义标签。
updated_at	String	该网络最新更新时间。
created_at	String	该网络创建时间。
qos_policy_id	String	该网络绑定的qos策略ID。
revision_number	integer	该网络的操作码。
ipv6_address_scope	String	该网络关联的ipv6地址scope。

响应示例

{
    network: {
        id: "553f02e3-b0d0-4f9a-a818-42e0c82448ba", 
        name: "test", 
        tenant_id: "5608307e73d845918339684a78503e78", 
        project_id: "5608307e73d845918339684a78503e78", 
        admin_state_up: true, 
        port_security_enabled: true, 
        mtu: 1500, 
        shared: false, 
        router:external: false, 
        availability_zone_hints: ["default-az"], 
        availability_zones: ["default-az"], 
        subnets: [
            "0ce8208f-8c50-4a10-92e6-894edc025e2a", 
            "a6b9609c-aac5-4cf0-9IDc0c-45b247de6228"
        ], 
        provider:network_type: "vlan"
        provider:physical_network: "physnet2", 
        provider:segmentation_id: 1015, 
        ipv4_address_scope: null, 
        status: "ACTIVE", 
        description: "", 
        tags: [ ], 
        updated_at: "2021-02-19T03:54:41Z", 
        created_at: "2021-02-19T03:04:35Z", 
        qos_policy_id: null, 
        revision_number: 7,
        ipv6_address_scope: null, 
    }
}

正常响应代码

200

错误码

401

创建网络

功能介绍

创建一个网络。

URI

POST /v2.0/networks

请求消息

参数	参数类型	是否必选	描述
name	String	是	该网络的名称。默认是一个空字符串。
project_id	String	否	该网络所属的项目ID。
availability_zone_hints	array	否	该网络所属的可用区候选。
availability_zones	array	否	该网络所属的可用区。
shared	boolean	否	该网络是否全局共享。
router:external	boolean	否	该网络是否为外部网络。默认是内部网络。
provider:network_type	String	否	该网络的类型。例如flat、vlan、vxlan。
provider:physical_network	String	否	该网络的segment来自哪个物理网络。
provider:segmentation_id	integer	否	该网络的segmentation ID。
subnets	array	否	该网络中的子网。
tags	array	否	该网络的标签。

请求示例

{
    "network": {
        "name": "test",
    }
}

响应消息

参数	参数类型	描述
id	String	网络ID。
tenant_id	String	项目ID。
project_id	String	项目ID。
name	String	资源的人类可读名称。
admin_state_up	boolean	该网络是否启动。
port_security_enabled	boolean	该网络是否开启网络安全防护功能。如果使用安全组功能，此配置项一定为打开。
mtu	integer	该网络数据包最大传输单元大小。
shared	boolean	该网络是否允许全资源池项目都可见。
router:external	boolean	该网络是否为外部网络。
availability_zone_hints	array	该网络的可用区候补选项。
availability_zones	array	该网络的可用区。
subnets	array	该网络的状态。
provider:network_type	String	该网络的类型。例如flat、vlan、vxlan。
provider:physical_network	String	该网络的segment来自哪个物理网络。
provider:segmentation_id	String	该网络的segmentation ID。
ipv4_address_scope	String	该网络关联的ipv4地址scope。
status	String	该网络的状态。
description	String	该网络的自定义描述。
tags	array	该网络的自定义标签。
updated_at	String	该网络最新更新时间。
created_at	String	该网络创建时间。
qos_policy_id	String	该网络绑定的qos策略ID。
revision_number	integer	该网络的操作码。
ipv6_address_scope	String	该网络关联的ipv6地址scope。

响应示例

{
    network: {
        id: "553f02e3-b0d0-4f9a-a818-42e0c82448ba", 
        name: "test", 
        tenant_id: "5608307e73d845918339684a78503e78", 
        project_id: "5608307e73d845918339684a78503e78", 
        admin_state_up: true, 
        port_security_enabled: true, 
        mtu: 1500, 
        shared: false, 
        router:external: false, 
        availability_zone_hints: ["default-az"], 
        availability_zones: ["default-az"], 
        subnets: [], 
        provider:network_type: "vlan"
        provider:physical_network: "physnet2", 
        provider:segmentation_id: 1015, 
        ipv4_address_scope: null, 
        status: "ACTIVE", 
        description: "", 
        tags: [], 
        updated_at: "2021-02-19T03:54:41Z", 
        creat"ed_at: "2021-02-19T03:04:35Z", 
        qos_policy_id: null, 
        revision_number: 7,
        ipv6_address_scope: null, 
    }
}

正常响应代码

200

错误码

400，401

显示网络详情

功能介绍

显示某个网络的详细信息。

URI

GET /v2.0/networks/{network_id}

参数	是否必选	描述
network_id	是	获取详情的network的ID。

请求消息

无

请求示例

无

响应消息

参数	参数类型	描述
id	String	网络ID。
tenant_id	String	项目ID。
project_id	String	项目ID。
name	String	资源的人类可读名称。
admin_state_up	boolean	该网络是否启动。
port_security_enabled	boolean	该网络是否开启网络安全防护功能。如果使用安全组功能，此配置项一定为打开。
mtu	integer	该网络数据包最大传输单元大小。
shared	boolean	该网络是否允许全资源池项目都可见。
router:external	boolean	该网络是否为外部网络。
availability_zone_hints	array	该网络的可用区候补选项。
availability_zones	array	该网络的可用区。
subnets	array	该网络的状态。
provider:network_type	String	该网络的类型。例如flat、vlan、vxlan。
provider:physical_network	String	该网络的segment来自哪个物理网络。
provider:segmentation_id	String	该网络的segmentation ID。
ipv4_address_scope	String	该网络关联的ipv4地址scope。
status	String	该网络的状态。
description	String	该网络的自定义描述。
tags	array	该网络的自定义标签。
updated_at	String	该网络最新更新时间。
created_at	String	该网络创建时间。
qos_policy_id	String	该网络绑定的qos策略ID。
revision_number	integer	该网络的操作码。
ipv6_address_scope	String	该网络关联的ipv6地址scope。

响应示例

{
    network: {
        id: "553f02e3-b0d0-4f9a-a818-42e0c82448ba", 
        name: "test", 
        tenant_id: "5608307e73d845918339684a78503e78", 
        project_id: "5608307e73d845918339684a78503e78", 
        admin_state_up: true, 
        port_security_enabled: true, 
        mtu: 1500, 
        shared: false, 
        router:external: false, 
        availability_zone_hints: ["default-az"], 
        availability_zones: ["default-az"], 
        subnets: [], 
        provider:network_type: "vlan"
        provider:physical_network: "physnet2", 
        provider:segmentation_id: 1015, 
        ipv4_address_scope: null, 
        status: "ACTIVE", 
        description: "", 
        tags: [], 
        updated_at: "2021-02-19T03:54:41Z", 
        creat"ed_at: "2021-02-19T03:04:35Z", 
        qos_policy_id: null, 
        revision_number: 7,
        ipv6_address_scope: null, 
    }
}

正常响应代码

200

错误码

400，401

更新网络

功能介绍

更新一个网络。

URI

PUT /v2.0/networks/{network_id}

参数	是否必选	描述
network_id	是	需要更新的network的ID。

请求消息

参数	参数类型	是否必选	描述
name	String	否	该网络的名称。

请求示例

{
    "network": {
        "name": "test-new"
    }
}

响应消息

参数	参数类型	描述
id	String	网络ID。
tenant_id	String	项目ID。
project_id	String	项目ID。
name	String	资源的人类可读名称。
admin_state_up	boolean	该网络是否启动。
port_security_enabled	boolean	该网络是否开启网络安全防护功能。如果使用安全组功能，此配置项一定为打开。
mtu	integer	该网络数据包最大传输单元大小。
shared	boolean	该网络是否允许全资源池项目都可见。
router:external	boolean	该网络是否为外部网络。
availability_zone_hints	array	该网络的可用区候补选项。
availability_zones	array	该网络的可用区。
subnets	array	该网络的状态。
provider:network_type	String	该网络的类型。例如flat、vlan、vxlan。
provider:physical_network	String	该网络的segment来自哪个物理网络。
provider:segmentation_id	String	该网络的segmentation ID。
ipv4_address_scope	String	该网络关联的ipv4地址scope。
status	String	该网络的状态。
description	String	该网络的自定义描述。
tags	array	该网络的自定义标签。
updated_at	String	该网络最新更新时间。
created_at	String	该网络创建时间。
qos_policy_id	String	该网络绑定的qos策略ID。
revision_number	integer	该网络的操作码。
ipv6_address_scope	String	该网络关联的ipv6地址scope。

响应示例

{
    network: {
        id: "553f02e3-b0d0-4f9a-a818-42e0c82448ba", 
        name: "test-new", 
        tenant_id: "5608307e73d845918339684a78503e78", 
        project_id: "5608307e73d845918339684a78503e78", 
        admin_state_up: true, 
        port_security_enabled: true, 
        mtu: 1500, 
        shared: false, 
        router:external: false, 
        availability_zone_hints: ["default-az"], 
        availability_zones: ["default-az"], 
        subnets: [], 
        provider:network_type: "vlan"
        provider:physical_network: "physnet2", 
        provider:segmentation_id: 1015, 
        ipv4_address_scope: null, 
        status: "ACTIVE", 
        description: "", 
        tags: [], 
        updated_at: "2021-02-19T03:54:41Z", 
        creat"ed_at: "2021-02-19T03:04:35Z", 
        qos_policy_id: null, 
        revision_number: 7,
        ipv6_address_scope: null, 
    }
}

正常响应代码

200

错误码

400，401，403，404，412

删除网络

功能介绍

删除一个网络。

URI

DELETE /v2.0/networks/{network_id}

参数	是否必选	描述
network_id	是	需要删除网络的ID。

请求消息

无

请求示例

无

响应消息

无

响应示例

成功删除请求的响应没有正文内容。

正常响应代码

204

错误码

401，404，409，412