更新时间:2024-03-05 GMT+08:00

更新网络

功能介绍

更新网络。

URI

PUT /v2.0/networks/{network_id}

参数说明请参见表1

表1 参数说明

名称

是否必选

说明

network_id

网络id

请求参数

表2 请求参数

参数名称

类型

必选

说明

network

network object

network对象,参见表3

更新操作时至少指定一项属性

表3 network对象

属性

是否必选

类型

说明

name

String

网络名称。

【使用说明】name不能为admin_external_net(预置网络名称,不可占用)。

admin_state_up

Boolean

管理状态。

【使用说明】只支持true。

port_security_enabled

Boolean

端口安全使能标记,如果不能使,则network下所有虚机的安全组和dhcp防欺骗不生效

请求示例

更新id为c360322d-5315-45d7-b7d2-481f98c56edb的network,名称更新为network-test02。

PUT https://{Endpoint}/v2.0/networks/c360322d-5315-45d7-b7d2-481f98c56edb

{
  "network": {
    "name": "network-test02"
  }
}

响应参数

表4 响应参数

参数名称

类型

说明

network

network object

network对象,参见表5

表5 network对象

属性

类型

说明

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,用户不可配置。

【使用说明】

  • 创建geneve类型的网络,请指定此参数为geneve。
  • 创建vxlan类型的网络,请求时请不要指定此参数。

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

响应示例

{
    "network": {
        "id": "c360322d-5315-45d7-b7d2-481f98c56edb",
        "name": "network-test02",
        "status": "ACTIVE",
        "shared": false,
        "subnets": [],
        "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-09-20T01:53:18",
        "updated_at": "2018-09-20T01:55:47"
    }
}

状态码

请参见状态码

错误码

请参见错误码