文档首页/ 智能边缘云 IEC/ API参考/ API/ 子网/ 更新子网
更新时间：2024-01-02 GMT+08:00
查看PDF
分享

更新子网

功能介绍

更新子网的基本信息。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

PUT /v1/subnets/{subnet_id}

表1 路径参数

参数

是否必选

参数类型

描述

subnet_id

是

String

子网ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

subnet

否

UpdateSubnetOption object

更新子网的结构体。
表4 UpdateSubnetOption

参数

是否必选

参数类型

描述

name

否

String

子网名称

取值范围：0-64，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）

dhcp_enable

否

Boolean

子网是否开启dhcp功能

取值范围：true（开启），false（关闭）

约束：不填时默认为true。当设置为false时，会导致新创建的实例无法获取IP地址，cloudinit无法注入帐号密码，请谨慎操作。

primary_dns

否

String

子网dns服务器地址1

约束：ip格式

secondary_dns

否

String

子网dns服务器地址2

约束：ip格式

dnsList

否

Array of strings

子网dns服务器地址的集合；如果想使用两个以上dns服务器，请使用该字段。

约束：是子网dns服务器地址1跟子网dns服务器地址2的合集的父集

ipv6_enable

否

Boolean

是否创建IPv6子网

取值范围：

  • true：开启

  • false：关闭

约束： 1、若该字段为true，则pool_id字段必填；若该字段为false，则pool_id字段不生效。 2、子网开启IPv6后不支持关闭。

pool_id

否

String

IPv6线路ID。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

subnet

UpdateSubnetResponseObject object

子网对象
表6 UpdateSubnetResponseObject

参数

参数类型

描述

id

String

子网ID

status

String

子网的状态

取值范围：

  • ACTIVE：表示子网已挂载到ROUTER上

  • UNKNOWN：表示子网还未挂载到ROUTER上

  • ERROR：表示子网状态故障

ipv6_enable

Boolean

是否开启IPv6

neutron_subnet_id_v6

String

对应IPv6子网（OpenStack Neutron接口）id，如果子网为IPv4子网，则不返回此参数。

请求示例

更新子网名为test-subnet，更新dhcp和dns

PUT https://{{endpoint}}/v1/subnets/ceff6c37-1dd2-4232-922c-a59d64dbb7f3

{
  "subnet" : {
    "name" : "test-subnet",
    "dhcp_enable" : true,
    "primary_dns" : "4.4.4.4",
    "secondary_dns" : "4.4.4.4",
    "dnsList" : [ "4.4.4.4" ]
  }
}

响应示例

状态码： 200

OK

{
  "subnet" : {
    "id" : "99d9d709-8478-4b46-9f3f-2206b1023fd3",
    "status" : "ACTIVE"
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 子网

相关文档