通用服务

API 列表

action	描述
device.name	修改设备名称
device.freeEditionLogs	查询免费版设备日志
device.paidEditionLogs	查询收费版设备日志
device.reset-factory	恢复设备出厂设置
device.remove	移除设备
device.upgradeInfos	查询设备当前固件信息和升级信息
device.upgrade	确认设备升级

修改设备名称

请求地址

action: device.name

params 请求参数

参数名	类型	说明	是否必填
device_id	String	设备 ID	是
name	String	命令集	是

请求示例

{
    "action": "device.name",
    "params": {
        "device_id": "vdevo158132564936223",
        "name": "测试冷暖白光灯-vdevo-test"
    }
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功： true：成功 false：失败
msg	String	请求失败的信息，成功为空
result	Boolean	是否成功

查询免费版设备日志

接口说明：

根据查询条件，查询免费版设备的操作历史记录。

接口地址：

action: device.freeEditionLogs

params 请求参数：

参数名	类型	说明	必填
device_id	String	设备 ID	是
codes	String	设备支持的功能点（支持多个功能点的查询，用 “,” 隔开，默认为空）	是
type	String	日志查询支持的类型（支持多个事件类型的查询，用 “,” 隔开，必传。详见 设备日志附录 的 事件类型说明）	是
start_row_key	String	查询 HBase 的行键（默认为空）	否
size	int	查询的日志数量大小（默认为 20），每页最多不能超过 100	否
start_time	Long	查询的开始时间戳	是
end_time	Long	查询的结束时间戳	是

请求示例：

{
    "action": "device.freeEditionLogs",
    "params": {
            "device_id": "vdevo158132564936223",
                "codes": 'code1,code2',
                "type": "1,2",
            "size": 20,
                "start_time": 0,
                "end_time": 1585898159935
    }
}

响应参数：

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功： true：成功 false：失败
msg	String	请求失败的信息，成功为空
result	Object	返回结果
t	Long	时间戳

result 说明：

参数名	类型	说明
logs	Object	日志消息体
has_next	Boolean	是否还有下一条
device_id	String	设备 ID
current_row_key	String	HBase 的当前行键
next_row_key	String	下一条满足查询条件的 HBase 行键（为 null 的话，表示为没有满足查询条件的下一条日志）

logs 说明

参数名	类型	说明
code	String	功能点 code
value	String	功能点的值
event_time	String	事件发生的时间戳
event_from	String	事件触发的来源（详情见 设备日志附录 的 事件来源说明）
event_id	String	事件的类型（详情见 设备日志附录 的 事件类型说明）
status	String	数据有效，没有被删除（默认为 1）

返回示例

{
    "success": true,
    "t": 1561344464370,
    "result": {
        "logs": [
            {
                "code": "switch_1",
                "value": "false",
                "event_time": 1560872567955,
                "event_from": "1",
                "event_id": 7
            },
            {
                "code": "switch_1",
                "value": "false",
                "event_time": 1560783276382,
                "event_from": "1",
                "event_id": 7
            }
        ],
        "device_id": "75500780ecfabc9a86f5",
        "has_next": true,
        "current_row_key": "NjUwODIzNDU1ZjY4YTljYmFmY2UwODcwMDU1N185MjIzMzcwNDc1OTgyMjA3ODUyXzdfMQ==",
        "next_row_key": "NjUwODIzNDU1ZjY4YTljYmFmY2UwODcwMDU1N185MjIzMzcwNDc2MDcxNDk5OTM0XzdfMQ=="
    }
}

查询收费版设备日志

接口说明：

根据查询条件，查询收费版设备的操作历史记录。

接口地址：

action: device.paidEditionLogs

params 请求参数：

参数名	类型	说明	必填
device_id	String	设备 ID	是
codes	String	设备支持的功能点（支持多个功能点的查询，用 “,” 隔开，默认为空）	否
type	String	日志查询支持的类型（支持多个事件类型的查询，用 “,” 隔开，必传。详情见 设备日志附录 的 事件类型说明）	是
last_row_key	String	分页参数，最后一条数据的行键（默认为空查第一页）	是
last_event_time	Long	分页参数，最后一条数据的事件发生时间(默认为空查第一页）	是
size	int	查询的日志数量大小（默认为 20），每页最多不能超过 100	否
start_time	Long	查询的开始时间戳	是
end_time	Long	查询的结束时间戳	是

请求示例：

{
    "action": "device.paidEditionLogs",
    "params": {
                "device_id": "vdevo158132564936223",
                "type": "5",
                "last_row_key": "650823455f68a9cbafce08700557_9223370475075511414_1",
                "last_event_time": 1581779264393,
        "size": 20,
                "start_time": 0,
                "end_time": 1585898159935
    }
}

响应参数：

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功： true：成功 false：失败
msg	String	请求失败的信息，成功为空
result	Object	返回结果
t	Long	时间戳

result 说明：

参数名	类型	说明
logs	Object	日志消息体
has_next	Boolean	是否还有下一条
device_id	String	设备 ID
count	Long	满足查询条件的日志总数

logs 说明

参数名	类型	说明
code	String	功能点 code
value	String	功能点的值
event_time	String	事件发生的时间戳
event_from	String	事件触发的来源（详情见 设备日志附录 的 事件来源说明）
event_id	String	事件的类型（详情见 设备日志附录 的 事件类型说明）
status	String	数据有效，没有被删除（默认为 1）
row	String	当前 HBase 行键

返回示例

{
    "success":true,
        "t":1561344464370,
        "result":{
            "count":32,
            "device_id":"75500780ecfabc9a86f5",
            "has_next":true,
            "logs":[
                {
                    "event_id":1,
                    "event_time":1562031576431,
                    "event_from":"1",
                    "row":"650823455f68a9cbafce08700557_9223370474823199376_1",
                    "status":"1"
                },
                {
                    "event_id":1,
                    "event_time":1562031394665,
                    "event_from":"1",
                    "row":"650823455f68a9cbafce08700557_9223370474823381142_1",
                    "status":"1"
                },
                {
                    "event_id":1,
                    "event_time":1562031277824,
                    "event_from":"1",
                    "row":"650823455f68a9cbafce08700557_9223370474823497983_1",
                    "status":"1"
                },
                {
                    "event_id":1,
                    "event_time":1561935500636,
                    "event_from":"1",
                    "row":"650823455f68a9cbafce08700557_9223370474919275171_1",
                    "status":"1"
                }
            ]
        }
}

设备日志附录

事件来源说明：

code	说明
1	设备本身
2	客户端指令
3	第三方平台
4	云端指令
-1	未知

事件类型说明：

code	说明
1	上线
2	下线
3	设备激活
4	设备重置
5	指令下发
6	固件升级
7	功能点上报
8	设备信号量
9	设备重启
10	定时信息

恢复设备出厂设置

接口说明

根据设备 ID，恢复出厂设置。

接口地址

action: device.reset-factory

params 请求参数

参数名	类型	说明	必填
device_id	String	设备 ID	是

请求示例

{
    "action": "device.reset-factory",
    "params": {
        "device_id": "vdevo158132564936223"
    }
}

返回信息

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功： true：成功 false：失败
msg	String	请求失败的信息，成功为空
result	Boolean	返回结果

返回示例

{
    "success": true,
    "t": 1550642917632,
    "result": true
}

移除设备

请求地址

action: device.remove

params 请求参数

参数名	类型	说明	是否必填
device_id	String	设备 ID	是

请求示例

{
    "action": "device.remove",
    "params": {
        "device_id": "vdevo158346027181013"
    }
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功： true：成功 false：失败
msg	String	请求失败的信息，成功为空
result	Boolean	是否成功

查询设备当前固件信息和升级信息

请求地址

action: device.upgradeInfos

params 请求参数

参数名	类型	说明	是否必填
device_id	String	设备 ID	是

请求示例

{
    "action": "device.upgradeInfos",
    "params": {
        "device_id": "vdevo158132564936223"
    }
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功： true：成功 false：失败
msg	String	请求失败的信息，成功为空
result	Object	设备的固件信息和升级信息

result 说明

参数名	类型	说明
upgrade_status	Integer	升级状态： 0：不需要升级 1：硬件准备就绪 2：升级中 3：升级完成 4：升级异常
current_version	String	当前版本
upgrade_version	String	升级版本
module_type	String	模组类型： 0：Wi-Fi 1：Bluetooth LE 2：GPRS 9：MCU
module_desc	String	模组描述信息
last_upgrade_time	String	最近升级时间

确认设备升级

请求地址

action: device.upgrade

params 请求参数

参数名	类型	说明	是否必填
device_id	String	设备 ID	是
module_type	String	模组类型	是

请求示例

{
    "action": "device.upgrade",
    "params": {
            "device_id": "vdevo158313016266290",
                "module_type": "0"
    }
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功： true：成功 false：失败
msg	String	请求失败的信息，成功为空
result	Boolean	是否成功