错误码
4.2.1 创建子网
功能介绍
创建子网。
调试
您可以在API Explorer中调试该接口。
URI
POST /v1/{project_id}/subnets 参数说明请参见表4-23。
表4-23 参数说明
名称 是否必选 说明
project_id 是 项目ID，获取项目ID请参
见A.5 获取项目ID。
请求消息
● 请求参数
表4-24 请求参数
名称 是否必选 参数类型 说明
subnet 是 subnet
object subnet对象
表4-25 subnet 对象
名称 是否必选 参数类型 说明
name 是 String ● 功能说明：子网名称
● 取值范围：1-64个字符，支持数
字、字母、中文、_(下划线)、-（中划线）、.（点）
description 否 String ● 功能说明：子网描述
● 取值范围：0-255个字符，不能 包含“<”和“>”。
cidr 是 String ● 功能说明：子网的网段
● 取值范围：必须在vpc对应cidr 范围内
● 约束：必须是cidr格式。掩码长 度不能大于28
gateway_ip 是 String ● 功能说明：子网的网关
● 取值范围：子网网段中的IP地址
● 约束：必须是ip格式
ipv6_enable 否 Boolean ● 功能说明：是否创建IPv6子网
● 取值范围：true（开启），false
（关闭）
● 约束：不填时默认为false dhcp_enable 否 Boolean ● 功能说明：子网是否开启dhcp
功能
● 取值范围：true（开启），false
（关闭）
● 约束：不填时默认为true。当设 置为false时，会导致新创建的 ECS无法获取IP地址，Cloud-init 无法注入帐号密码，请谨慎操 作。
primary_dns 否 String ● 功能说明：子网dns服务器地址 1
● 约束：ip格式，不支持IPv6地 址。不填时，默认为空
内网DNS地址请参见华为云提供的 内网DNS地址是多少？
可以通过查询名称服务器列表查看 DNS服务器的地址。
名称 是否必选 参数类型 说明
secondary_dns 否 String ● 功能说明：子网dns服务器地址 2
● 约束：ip格式，不支持IPv6地 址。不填时，默认为空
内网DNS地址请参见华为云提供的 内网DNS地址是多少？
可以通过查询名称服务器列表查看 DNS服务器的地址。
dnsList 否 Array of
strings ● 功能说明：子网dns服务器地址 的集合；如果想使用两个以上 dns服务器，请使用该字段
● 约束：是子网dns服务器地址1 跟子网dns服务器地址2的合集 的父集，不支持IPv6地址。不填 时，默认为空
内网DNS地址请参见华为云提供的 内网DNS地址是多少？
可以通过查询名称服务器列表查看 DNS服务器的地址。
availability_zo
ne 否 String ● 功能说明：子网所在的可用区标
识，从终端节点获取，参考1.3 终端节点（Endpoint）
● 约束：系统存在的可用区标识；
不填时，默认为空 vpc_id 是 String 子网所在VPC标识 extra_dhcp_op
ts 否 Array of
extra_dhc p_opt objects
子网配置的NTP地址或租约时间，
详情请参见extra_dhcp_opt对象。
表4-26 extra_dhcp_opt 对象
名称 是否必选 参数类型 说明
opt_value 否 String ● 功能说明：子网配置的NTP地 址或子网配置的租约到期时
opt_name 是 String ● 功能说明：子网配置的NTP地 址名称或子网配置的租约到期 "secondary_dns": "114.xx.xx.115", "dnsList": [
"114.xx.xx.114", "114.xx.xx.115"
],
"availability_zone": "aa-bb-cc",//假设可用区标识为aa-bb-cc "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "extra_dhcp_opts": [
} }
响应消息
● 响应参数
表4-27 响应参数
名称 参数类型 说明
subnet subnet object subnet对象
表4-28 subnet 对象
名称 参数类型 说明
id String uuid形式的一个资源标识
name String ● 功能说明：子网名称
● 取值范围：1-64个字符，支持数
字、字母、中文、_(下划线)、-（中划线）、.（点）
description String ● 功能说明：子网描述
● 取值范围：0-255个字符，不能包 含“<”和“>”。
cidr String ● 功能说明：子网的网段
● 取值范围：必须在vpc对应cidr范围 内
● 约束：必须是cidr格式。掩码长度 不能大于28
gateway_ip String ● 功能说明：子网的网关
● 取值范围：子网网段中的IP地址
● 约束：必须是ip格式 ipv6_enable Boolean 是否创建IPv6子网
cidr_v6 String IPv6子网的网段，如果子网为IPv4子 网，则不返回此参数
gateway_ip_v6 String IPv6子网的网关，如果子网为IPv4子 网，则不返回此参数
dhcp_enable Boolean 子网是否开启dhcp功能
primary_dns String ● 功能说明：子网dns服务器地址1
● 约束：ip格式，不支持IPv6地址。
不填时，默认为空
名称 参数类型 说明
secondary_dns String ● 功能说明：子网dns服务器地址2
● 约束：ip格式，不支持IPv6地址。
不填时，默认为空 dnsList Array of
strings ● 功能说明：子网dns服务器地址的 集合；如果想使用两个以上dns服
availability_zone String ● 功能说明：子网所在的可用区标 识，从终端节点获取，参考1.3 终 端节点（Endpoint）
● 约束：系统存在的可用区标识；不 填时，默认为空
vpc_id String 子网所在VPC标识
status String ● 功能说明：子网的状态。
● 取值范围：
neutron_network_id String 对应网络（OpenStack Neutron接 口）id
neutron_subnet_id String 对应子网（OpenStack Neutron接 口）id
neutron_subnet_id_
v6 String 对应IPv6子网（OpenStack Neutron 接口）id，如果子网为IPv4子网，则不 返回此参数
名称 参数类型 说明 extra_dhcp_opts Array of
extra_dhcp_o pt objects
子网配置的NTP地址或租约时间，详 情请参见表4-29。
scope String 子网作用域。
取值范围：
● center：表示作用域为中心
● {azId}：表示作用域为具体的可用 区
表4-29 extra_dhcp_opt 对象
名称 是否必选 参数类型 说明
opt_value 否 String ● 功能说明：子网配置的NTP地 址或子网配置的租约到期时
opt_name 是 String ● 功能说明：子网配置的NTP地 址名称或子网配置的租约到期
"id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", "name": "subnet",
"status": "UNKNOWN",
"vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "gateway_ip": "192.168.20.1",
"ipv6_enable": true,
"cidr_v6": "2001:db8:a583::/64", "gateway_ip_v6": "2001:db8:a583::1", "dhcp_enable": true,
"primary_dns": "114.xx.xx.114", "secondary_dns": "114.xx.xx.115",
"availability_zone": "aa-bb-cc",//假设可用区标识为aa-bb-cc。
"neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12", "neutron_subnet_id_v6": "e0fa7de1-a6e2-44c9-b052-b9d8cebe93c4", "extra_dhcp_opts": [
project_id 是 项目ID，获取项目ID请参
见A.5 获取项目ID。