一、获取组网列表
GET /vlans
输出
data
为[Object0, …, ObjectN]的Array， 每个Object的格式：
| 字段 |
说明 |
示例 |
| id |
组网ID，即后文的 |
“20001” |
| name |
名称 |
“星星大药房连锁” |
| ctime |
创建时间(UNIX时间戳) |
“1531561950” |
| speedlimit |
限速 |
“4” |
| expiretime |
到期时间(UNIX时间戳) |
“1631561950” |
| type |
网络类型，星型网络为”1”，对等网络为”2” |
“1” |
| devs |
该字段为Array，包含参与组网设备的详情 |
- |
devs中每个元素的格式
| 字段 |
描述 |
示例 |
| id |
设备id |
“1001” |
| serial |
序列号 |
- |
| name |
设备名称 |
“星星药房总部” |
| is_online |
是否在线 |
“1” |
| ts_firstonline |
设备何时投入使用 |
“2018-1-1 00:00:00” |
| ip |
IP地址 |
“111.111.111.111” |
| iface_ip |
设备外网接口IP |
“192.168.1.100” |
| region |
IP归属地 |
“310000” |
| model |
型号 |
“S3A” |
| firmware |
固件版本 |
“4.2.6” |
| svn |
SVN号 |
“14567” |
| flver |
特征库版本 |
“14567” |
| uptime |
本次开机运行时间，单位秒 |
“86400” |
| vlan_ip |
设备的组网IP |
“10.10.10.1” |
二、获取可组网设备列表
GET /vlans/candidates
输入
| 参数名 |
说明 |
示例 |
| [groupid] |
指定为该项目内的可组网设备 |
— |
输出
data
[Object0, …, ObjectN]的Array， 每个Object的格式：
| 字段 |
说明 |
示例 |
| id |
设备id |
- |
| serial |
设备序列号 |
- |
| name |
设备名称 |
- |
| region |
IP归属地 |
- |
三、新建组网-a
POST /vlans
新建组网过程比较复杂，划分为多个步骤，这些步骤都是POST到/vlans，以step参数区分。
输入
| 参数名 |
说明 |
示例 |
| step |
固定为”a” |
“a” |
| devlist |
以”,”分隔的一个或者多个设备id |
- |
输出
data
| 字段 |
说明 |
示例 |
| vlanip |
系统自动分配的vlan网段 |
“10.10.10.0” |
| bcache |
不透明数据 |
- |
vlanip是系统自动分配的网段，可修改，高恪默认尽可能使用10.10.10.0。
四、新建组网-b
POST /vlans
输入
| 参数名 |
说明 |
示例 |
| step |
固定为”b” |
“b” |
| bcache |
即step-a返回数据的bcache |
- |
| type |
“1”为星型网络，”2”为对等网络 |
“1” |
| [coredev] |
中心节点的设备id，仅当type为1时有效 |
- |
输出
data
六、新建组网-c
POST /vlans
输入
| 参数名 |
说明 |
示例 |
| step |
固定为”c” |
“c” |
| bcache |
即step-b返回数据的bcache |
- |
| vlanip |
vlan的网段 |
“10.10.10.0” |
输出
data
七、新建组网-z
POST /vlans
输入
| 参数名 |
说明 |
示例 |
| step |
固定为”z” |
“z” |
| bcache |
即step-c返回数据的bcache |
- |
| iplist |
以”,”分隔的ip地址4分位最后一部分，与devlist一一对应。中心节点必须是1。 |
step-a中devlist为”1001,1002,1003”,step-c中”vlanip”为”10.10.10.0”,则step-z中iplist为”1,10,11”表示设备1001分配”10.10.10.1”,设备1002分配”10.10.10.10”, 设备1003分配”10.10.10.11” |
八、删除设备
DELETE /vlans/<vlan-id>/devices
输入
| 参数名 |
说明 |
示例 |
| devlist |
以”,”分隔的1个或者多个设备id。星型网络不能删除中心节点，必须全部删除所有设备，此时请指定devlist为”all” |
“1002,1003” |
删除设备不能返还已经充值的高恪币。但本次删除N台设备后，下次添加N台设备不会再次计费。
九、添加设备-a
POST /vlans/<vlan-id>/devices
添加设备过程比较复杂，划分为多个步骤，这些步骤都是POST到同一个URL，以step参数区分。
输入
| 参数名 |
说明 |
示例 |
| step |
固定为”a” |
“a” |
| devlist |
以”,”分隔的1个或者多个设备id。 |
“1002,1003,1004” |
| [coredev] |
中心节点的设备ID。如果是星型网络且当前没有设备，则该参数是必须的，其他情况下忽略。 |
- |
输出
data
| 字段 |
说明 |
示例 |
| coins |
需要的高恪币数目 |
“100” |
| vlanip |
组网的网段IP |
“10.10.10.0” |
| bcache |
不透明数据 |
- |
九、添加设备-z
POST /vlans/<vlan-id>/devices
输入
| 参数名 |
说明 |
示例 |
| step |
固定为”z” |
“z” |
| bcache |
即step-a返回数据的bcache |
- |
| [vlanip] |
“1”为星型网络，”2”为对等网络 |
“1” |
| iplist |
中心节点的设备id，仅当type为1时有效 |
- |
十、更改组网名称
POST /vlans/<vlan-id>/name
输入
十一、计算为组网充值所需的高恪币
GET /vlans/<vlan-id>/coins
输入
| 参数名 |
说明 |
示例 |
| months |
充值时长，以月为单位 |
- |
| [speedlimit] |
限速，单位 Mbit/s。如果这个组网是刚创建的，未曾充过值，则speedlimit是必须的，否则将忽略该参数，直接使用首次充值时的speedlimit |
- |
十二、为组网充值
POST /vlans/<vlan-id>/expiretime
输入
| 参数名 |
说明 |
示例 |
| months |
充值时长，以月为单位。 |
- |
| [speedlimit] |
限速，单位 Mbit/s。如果这个组网是刚创建的，未曾充过值，则speedlimit是必须的，否则将忽略该参数，直接使用首次充值时的speedlimit |
- |
若账户高恪币不足，系统将返回err为”notenough-coins”。为保证调用成功，请先确保有足够的高恪币。
十三、删除组网
DELETE /vlans/<vlan-id>
删除组网会导致充值丢失，请谨慎调用。本操作需要进行密码验证。
输入
| 参数名 |
说明 |
示例 |
| password |
您的账户在高恪云的登录密码 |
- |
文档更新时间: 2019-01-16 18:10 作者：Gocloud
