更新时间:2024-01-02 GMT+08:00
分享

创建子网

功能介绍

根据用户的请求内容,创建子网。

调试

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

URI

POST /v1/subnets

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表2 请求Body参数

参数

是否必选

参数类型

描述

subnet

CreateSubnetOption object

创建子网的请求体。

表3 CreateSubnetOption

参数

是否必选

参数类型

描述

name

String

子网名称

约束:由中文字符、字母、数字、中划线和下划线和点组成,长度为1~64个字符

cidr

String

子网的网段

取值范围:必须在vpc对应cidr范围内

约束:必须是cidr格式。掩码长度不能大于28

gateway_ip

String

子网的网关

取值范围:子网网段中的IP地址

约束:必须是ip格式

dhcp_enable

Boolean

子网是否开启dhcp功能

取值范围:true(开启),false(关闭)

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

primary_dns

String

子网dns服务器地址1

约束:ip格式,不支持IPv6地址

secondary_dns

String

子网dns服务器地址2

约束:ip格式,不支持IPv6地址

dnsList

Array of strings

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

约束:是子网dns服务器地址1跟子网dns服务器地址2的合集的父集,不支持IPv6地址。

vpc_id

String

子网所在VPC的ID。

site_id

String

子网归属的站点ID,从站点信息列表中获取。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

subnet

Subnet object

子网字典对象。

表5 Subnet

参数

参数类型

描述

id

String

子网的ID。

name

String

子网名称

取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)

cidr

String

子网的网段

取值范围:必须在vpc对应cidr范围内

约束:必须是cidr格式。掩码长度不能大于28

dnsList

Array of strings

子网dns服务器地址列表

gateway_ip

String

子网的网关

取值范围:子网网段中的IP地址

约束:必须是ip格式

dhcp_enable

Boolean

子网是否开启dhcp功能

primary_dns

String

子网dns服务器地址1

secondary_dns

String

子网dns服务器地址2

status

String

子网的状态

取值范围:

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

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

  • ERROR:表示子网状态故障

vpc_id

String

虚拟私有云ID。

site_id

String

子网所属的站点ID。

site_info

String

子网所属的站点信息。

neutron_network_id

String

对应网络(OpenStack Neutron接口) id。

neutron_subnet_id

String

对应子网(OpenStack Neutron接口) id。

cidr_v6

String

IPv6子网的网段,如果子网为IPv4子网,则不返回此参数

ipv6_enable

Boolean

是否是IPv6子网

取值范围:true,false

pool_id

String

IPv6线路ID,如果子网为IPv4子网,则不返回此参数。

neutron_subnet_id_v6

String

对应IPv6子网(OpenStack Neutron接口)id,如果子网为IPv4子网,则不返回此参数。

gateway_ip_v6

String

IPv6子网的网关,如果子网为IPv4子网,则不返回此参数。

请求示例

创建一个子网,所在vpc的id为1016972d-357e-4a2a-912b-cf2ab9673790,命名为test-subent,设置cidr为10.1.0.0/8,网关IP为10.1.1.1

POST https://{{endpoint}}/v1/subnets

{
  "subnet" : {
    "name" : "test-subnet",
    "cidr" : "10.1.0.0/8",
    "gateway_ip" : "10.1.1.1",
    "dhcp_enable" : false,
    "vpc_id" : "1016972d-357e-4a2a-912b-cf2ab9673790",
    "site_id" : "6813be76-7322-11ea-9ce0-286ed488d287"
  }
}

响应示例

状态码: 200

OK

{
  "subnet" : {
    "id" : "7958af28-bf1a-4e8d-a6a3-67f836d60272",
    "name" : "test-subnet",
    "vpc_id" : "1016972d-357e-4a2a-912b-cf2ab9673790",
    "cidr" : "10.1.0.0/8",
    "gateway_ip" : "10.1.1.1",
    "dhcp_enable" : false,
    "dnsList" : [ ],
    "status" : "UNKNOWN",
    "site_id" : "6813be76-7322-11ea-9ce0-286ed488d287",
    "site_info" : "中国/华南地区/广东/中山市",
    "neutron_network_id" : "7958af28-bf1a-4e8d-a6a3-67f836d60272",
    "neutron_subnet_id" : "de247b44-26d2-4cb2-9ba0-f62aac73ff1d"
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档