接口列表
本节包含设备开关状态操作的相关接口等。
接口列表如下:
序号 | 接口功能 | 描述 |
---|---|---|
1 | 获取设备版本信息 | 获取设备的版本信息 |
2 | 设备升级固件 | 升级设备固件 |
3 | 获取设备升级状态 | 获取设备升级状态,包含升级进度、状态等 |
获取设备版本信息
接口功能
查询用户下指定设备的版本信息
请求地址
https://open.ys7.com/api/lapp/device/version/info
请求方式
POST
子账户token请求所需最小权限
"Permission":"Get"
"Resource":"dev:序列号"
- 请求参数
参数名 | 类型 | 描述 | 是否必选 |
---|---|---|---|
accessToken | String | 授权过程获取的access_token | Y |
deviceSerial | String | 设备序列号,存在英文字母的设备序列号,字母需为大写 | Y |
- HTTP请求报文
POST /api/lapp/device/version/info HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734888
- 返回数据
{
"data": {
"latestVersion": "V5.2.7 build 170628",
"currentVersion": "V5.2.6 build 160919",
"isNeedUpgrade": 1,
"isUpgrading": 1
},
"code": "200",
"msg": "操作成功!"
}
- 返回字段
字段名 | 类型 | 描述 |
---|---|---|
latestVersion | String | 最新版本 |
currentVersion | String | 当前版本 |
isNeedUpgrade | int | 是否需要升级:0-不需要,1-需要 |
isUpgrading | int | 是否正在升级 0 -未升级, 1-正在升级 |
注:萤石型号设备可根据
isNeedUpgrade
字段是否为1或比较当前版本和最新版本是否一致来确认设备是否需要升级,海康型号设备只能根据isNeedUpgrade
字段是否为1确认设备是否需要升级。
- 返回码
返回码 | 返回消息 | 描述 |
---|---|---|
200 | 操作成功 | 请求成功 |
10001 | 参数错误 | 参数为空或格式不正确 |
10002 | accessToken异常或过期 | 重新获取accessToken |
10005 | appKey异常 | appKey被冻结 |
20002 | 设备不存在 | |
20014 | deviceSerial不合法 | |
20018 | 该用户不拥有该设备 | 检查设备是否属于当前账户 |
49999 | 数据异常 | 接口调用异常 |
设备升级固件
接口功能
升级设备固件至最新版本
请求地址
https://open.ys7.com/api/lapp/device/upgrade
请求方式
POST
子账户token请求所需最小权限
"Permission":"Upgrade"
"Resource":"dev:序列号"
请求参数
参数名 | 类型 | 描述 | 是否必选 |
---|---|---|---|
accessToken | String | 授权过程获取的access_token | Y |
deviceSerial | String | 设备序列号,存在英文字母的设备序列号,字母需为大写 | Y |
- HTTP请求报文
POST /api/lapp/device/upgrade HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.20h863523v1zfck75qgmwhoy7vl2teqp&deviceSerial=427734888
- 返回数据
{
"code": "200",
"msg": "操作成功!"
}
- 返回码
返回码 | 返回消息 | 描述 |
---|---|---|
200 | 操作成功 | 请求成功 |
10001 | 参数错误 | 参数为空或格式不正确 |
10002 | accessToken异常或过期 | 重新获取accessToken |
10005 | appKey异常 | appKey被冻结 |
20002 | 设备不存在 | |
20006 | 网络异常 | 检查设备网络状况,稍后再试 |
20007 | 设备不在线 | 检查设备是否在线 |
20008 | 设备响应超时 | 操作过于频繁,稍后再试 |
20014 | deviceSerial不合法 | |
20018 | 该用户不拥有该设备 | 检查设备是否属于当前账户 |
49999 | 数据异常 | 接口调用异常 |
60013 | 设备版本已是最新 | |
60014 | 设备正在升级 | |
60015 | 设备正在重启 | |
60016 | 设备升级失败 | 检查设备网络等状况 |
获取设备升级状态
接口功能
查询用户下指定设备的升级状态,包括升级进度。
请求地址
https://open.ys7.com/api/lapp/device/upgrade/status
请求方式
POST
子账户token请求所需最小权限
"Permission":"Get"
"Resource":"dev:序列号"
请求参数
参数名 | 类型 | 描述 | 是否必选 |
---|---|---|---|
accessToken | String | 授权过程获取的access_token | Y |
deviceSerial | String | 设备序列号,存在英文字母的设备序列号,字母需为大写 | Y |
- HTTP请求报文
POST /api/lapp/device/upgrade/status HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.20h863523v1zfck75qgmwhoy7vl2teqp&deviceSerial=427734888
- 返回数据
{
"data": {
"progress": 43,
"status": 0
},
"code": "200",
"msg": "操作成功!"
}
- 返回字段
字段名 | 类型 | 描述 |
---|---|---|
progress | int | 升级进度,仅status为正在升级状态时有效,取值范围为1-100 |
status | int | 升级状态: 0-正在升级,1-设备重启,2-升级成功,大于2-升级失败 |
- 返回码
返回码 | 返回消息 | 描述 |
---|---|---|
200 | 操作成功 | 请求成功 |
10001 | 参数错误 | 参数为空或格式不正确 |
10002 | accessToken异常或过期 | 重新获取accessToken |
10005 | appKey异常 | appKey被冻结 |
20002 | 设备不存在 | |
20007 | 设备不在线 | 检查设备是否在线 |
20014 | deviceSerial不合法 | |
20018 | 该用户不拥有该设备 | 检查设备是否属于当前账户 |
49999 | 数据异常 | 接口调用异常 |