一、获取设备列表

GET /devices

输入

参数名 描述 示例
[groupid] 项目id。获取指定项目的设备。如未提供则获取所有项目的设备。 -
[offset] 分页偏移。默认0。 -
[limit] 分页的设备数目。默认100。 -

输出

data
[Object0, …, ObjectN]的Array。每个Object的格式如下

字段 描述 示例
id 设备id,对应后文中的 “1234567”
serial 序列号 “OPENAPI001”
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”
group_id 设备所在项目ID “100001”
group_name 设备所在项目名称 “上海张江网咖”
hostnum 当前主机数和历史最大主机数 “10/20”
autoweb 是否支持webuiurl和ajaxurl接口 “1”

额外字段

字段 类型 描述 示例
offset int 同输入参数offset。 -
limit int 同输入参数limit。 -
total int 符合查询条件设备总数 -

二、添加设备

POST /devices

设备被添加后将出现在我的设备列表中。需要输入该设备的外网IP地址或者MAC地址进行验证。
已经有管理者的设备不能被添加。

输入

参数名 描述 示例
serial 设备序列号 -
ip 设备外网IP地址或者MAC地址 “11:22:33:44:55:66”

三、删除设备

DELETE /devices/<device-id>

从设备列表中移除。

获取免密登录设备的url

GET devices/<device-id>/webuiurl

输出

data

字段 描述 示例
urldomain 以可解析域名访问的url http://openapi0001.luyou.gocloud.cn:8864/cgi-bin/webui?cloudtoken=Q76GW873r5pzCj9C"
[urlip] 以ip访问的url,仅当设备有公网IP时存在 http://112.112.128.128:8088:/cgi-bin/webui?cloudtoken=Q76GW873r5pzCj9C"

四、获取设备ajax接口的url

GET devices/<device-id>/ajaxurl

输出

data

字段 说明 示例
token “1543893044/1092397094”
urldomain 以可解析域名访问的url http://openapi0001.luyou.gocloud.cn:8864"
[urlip] 以ip访问的url,仅当设备有公网IP时存在 http://112.112.128.128:8088"

五、修改设备名称

POST /devices/<device-id>/name

输入

参数名 说明 示例
newname 新的名称 “星星网咖”

六、获得固件版本信息

GET /devices/firmwares

输入

参数名 说明 示例
devlist 以”,”分隔的多个设备id “1001,1002”

这些设备的型号必须相同,否则返回”conflicted-model”错误。

输出

data

[Object0, …, ObjectN]的Array,每个Object的格式为

字段 描述 示例
name 固定为”firmware” “firmware”
model 型号 “S3A”
version 版本 “4.2.6.14567”
desc 版本变动详情 “该版本修复了某某功能,等等”
文档更新时间: 2019-01-16 17:50   作者:Gocloud