跳转至

网络

创建网络

接口描述

创建一个bridge网络。

接口路径

POST /v1/networks

请求参数

名称 类型 是否必须 默认值 备注
name string 网络名称
mode string bridge 可省略,当前仅支持bridge
bridge_name string br0 网桥名
datacenter_id int 数据中心ID
subnets []Subnet 子网

Subnet:

名称 类型 是否必须 默认值 备注
name string 子网名称
iptype string ipv4 or ipv6,默认为ipv4
cidr string CIDR
gateway string 网关
first string 子网中第一个可用地址
last string 子网中最后一个可用地址
dns []string dns

返回数据

名称 类型 是否必须 默认值 备注
code number 必须 状态码,100001表示正常,其它表示请求异常
msg string 非必须 状态码含义
network_id number 非必须 网络ID
reason string 非必须 请求异常时的原因

查看网络列表

接口描述

查看网络列表。

接口路径

GET /v1/networks/

请求参数

参数名称 是否必须 示例 备注
dcid_list dcid_list[]=1&dcid_List[]=2...... 数据中心列表
network_id ?network_id=1 网络id
network_name ?network_name=xxx 网络名称
limit ?limit=100 查询多少条数据
offset ?offset=100 第一条数据在表中的偏移量

返回数据

名称 类型 备注
code int 状态码,100001表示正常,其它表示请求异常
msg string 状态码含义
data []Network 返回的请求数据

Network:

名称 类型 备注
id int 网络ID
created_at string 创建时间
updated_at string 更新时间
name string 网络名称
mode string 网络模式
bridge_name string 网桥名称
datacenter_id int 数据中心ID

查看网络详情

接口描述

查看指定网络详情。

接口路径

GET /v1/networks/:id

请求参数

路径参数

名称 示例 备注
id /v1/networks/1 网络id

返回数据

名称 类型 描述
code intint 状态码,100001表示正常,其它表示请求异常
msg string 状态码含义
data Network 返回的请求数据

Network:

名称 类型 描述
id int 网络ID
created_at string 创建时间
updated_at string 更新时间
name string 网络名称
mode string 网络模式
bridge_name string 网桥名称
datacenter_id int 数据中心ID
subnets []Subnet 子网

Subnet:

名称 类型 描述
id int 网络ID
created_at string 创建时间
updated_at string 更新时间
name string 子网名称
ip_type string ip类型
cidr string CIDR
gateway string 网关
netmask string 子网掩码
first string 第一个可用ip
last string 最后一个可用ip
dns string DNS
network_id int 网络id

删除网络

接口描述

删除网络,网络中有ip再被使用时,无法删除。

接口路径

DELETE /v1/networks/:id

请求参数

路径参数

名称 类型 是否必须 默认值 备注
id int 网络id

返回数据

名称 类型 描述
code int 状态码(100001表示成功,其它表示异常)
msg string 状态码描述信息

删除子网

接口描述

删除子网。

接口路径

DELETE /v1/networks/subnets/:id

请求参数

路径参数

名称 类型 是否必须 默认值 备注
id int 子网id

返回数据

名称 类型 描述
code int 状态码(100001表示成功,其它表示异常)
msg string 状态码描述信息