固件升级服务
更新时间：2018-03-16 10:44:13
获取固件升级信息
定义描述
| path | 版本 | 描述 | 是否需要登陆 |
|---|---|---|---|
| /thing/ota/progress/getByUser | 1.0.1 | 获取云端获取指定版本的固件的升级信息 | 是 |
请求参数
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| iotId | String | 是 | 设备id |
| version | String | 是 | 固件版本号 |
返回参数
| 字段名 | 字段类型 | 详细描述 |
|---|---|---|
| iotId | String | 设备ID |
| step | String | 升级进度 |
| desc | String | 描述信息 |
| success | String | 是否成功 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request": {
"apiVer": "1.0.1",
"iotToken": "token"
},
"params": {
"iotId": "",
"version": "1.0.1"
}
}
正常返回示例
{
"id": "94e0871c-0770-4bb3-9e29-e840d86b3ba6",
"code": 200,
"data": {
"currentVersion": "xxxx",
"version": "1.2.3",
"size": "4000000",
"md5": "",
"name": "",
"url": "",
"desc": "xxxxxxx"
}
}
错误码
| 错误码 | 错误信息 | 详细描述 |
|---|---|---|
| 200 | success | 成功 |
| 9112 | device not found | 设备不存在 |
| 9119 | firmware not exist | 固件不存在 |
| 9146 | upgrade record not exist | 升级记录不存在 |
获取设备固件
定义描述
| path | 版本 | 描述 | 是否需要登陆 |
|---|---|---|---|
| /thing/ota/info/queryByUser | 1.0.1 | 获取指定设备的升级固件信息 | 是 |
请求参数
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| iotId | String | 是 | 设备id |
返回参数
|
字段名
|
字段类型
|
详细描述
|
|
currentVersion
|
String
|
设备当前版本号
|
|
version
|
String
|
版本固件版本号，有新版本时以下信息提供，无新版本时提供当前版本对应信息
|
|
size
|
String
|
文件包大小，单位Byte
|
|
md5
|
String
|
版本固件文件md5
|
|
name
|
String
|
版本固件名称
|
|
url
|
String
|
版本固件地址，sts加密
|
|
desc
|
String
|
版本详情描述
|
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request": {
"apiVer": "1.0.1",
"iotToken": "token"
},
"params": {
"iotId": ""
}
}
正常返回示例
{
"id": "94e0871c-0770-4bb3-9e29-e840d86b3ba6",
"code": 200,
"data": {
"currentVersion": "xxxx",
"version": "1.2.3",
"size": "4000000",
"md5": "",
"name": "",
"url": "",
"desc": "xxxxxxx"
}
}
错误码
| 错误码 | 错误信息 | 详细描述 |
|---|---|---|
| 200 | success | 成功 |
| 9112 | device not found | 设备不存在 |
| 9132 | non-existent job record. | 升级记录不存在 |
| 9119 | firmware not exist | 固件不存在 |
取消固件升级
定义描述
| path | 版本 | 描述 | 是否需要登陆 |
|---|---|---|---|
| /thing/ota/unupgradeByUser | 1.0.1 | 取消指定设备的固件升级 | 是 |
请求参数
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| version | String | 是 | 固件版本号 |
| iotId | String | 是 | 设备id |
返回参数
| 字段名 | 字段类型 | 详细描述
|
| :--- | :--- | :--- |
| data | boolean | 是否成功 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request": {
"apiVer": "1.0.1",
"iotToken": "token"
},
"params": {
"iotId": "",
"version": "1.0.1"
}
}
正常返回示例
{
"id": "94e0871c-0770-4bb3-9e29-e840d86b3ba6",
"code": 200,
"data": "true"
}
错误码
| 错误码 | 错误信息 | 详细描述 |
|---|---|---|
| 200 | success | 成功 |
| 9112 | device not found | 设备不存在 |
| 9132 | non-existent job record. | 升级记录不存在 |
| 9119 | firmware not exist | 固件不存在 |
触发固件升级
定义描述
| path | 版本 | 描述 | 是否需要登陆 |
|---|---|---|---|
| /thing/ota/upgradeByUser | 1.0.1 | 触发启动指定设备的固件升级动作 | 是 |
请求参数
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| version | String | 是 | 固件版本号 |
| iotId | String | 是 | 设备id |
返回参数
|
字段名
|
字段类型
|
详细描述
|
|
version
|
String
|
版本固件版本号，有新版本时以下信息提供，无新版本时提供当前版本对应信息
|
|
size
|
Integer
|
文件包大小，单位Byte
|
|
md5
|
String
|
版本固件文件md5
|
|
name
|
String
|
版本固件名称
|
|
url
|
String
|
版本固件地址，sts加密
|
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request": {
"apiVer": "1.0.1",
"iotToken": "token"
},
"params": {
"iotId": "",
"version": "1.0.1"
}
}
正常返回示例
{
"id": "94e0871c-0770-4bb3-9e29-e840d86b3ba6",
"code": 200,
"data": {
"version": "1.2.3",
"size": "4000000",
"md5": "",
"name": "",
"url": ""
}
}
错误码
| 错误码 | 错误信息 | 详细描述 |
|---|---|---|
| 200 | success | 成功 |
| 9112 | device not found | 设备不存在 |
| 9132 | non-existent job record. | 升级记录不存在 |
| 9103 | update data failed | 升级失败 |
获取正在升级的设备列表
定义描述
| path | 版本 | 描述 | 是否需要登陆 |
|---|---|---|---|
| /thing/ota/upgrade/listByUser | 1.0.1 | 获取当前正在升级的设备列表信息 | 是 |
请求参数
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
返回参数
| 字段名 | 字段类型 | 详细描述 |
|---|---|---|
| data | List | 升级设备信息 |
列表结构
| 字段名 | 字段类型 | 详细描述 |
|---|---|---|
| iotId | String | 设备Id |
| step | String | 步长 |
| desc | String | 描述信息 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request": {
"apiVer": "1.0.1",
"iotToken": "token"
},
"params": {
}
}
正常返回示例
{
"id": "94e0871c-0770-4bb3-9e29-e840d86b3ba6",
"code": 200,
"data": [
{
"iotid": "",
"step": "1",
"desc": "xxxx"
},
{
"iotid": "",
"step": "1",
"desc": "xxxx"
}
]
}
错误码
| 错误码 | 错误信息 | 详细描述 |
|---|---|---|
| 200 | success | 成功 |
| 9144 | device count exceeded | 设备数量超限 |
| 9131 | invalid device. | 非法的设备 |
上报固件升级进度
定义描述
| path | 版本 | 描述 | 是否需要登陆 |
|---|---|---|---|
| /ota/progress/postByUser | 1.0.1 | 上报指定设备的固件升级进度信息到云端 | 是 |
请求参数
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| iotId | String | 是 | 设备id |
| step | String | 是 | 固件升级进度 |
| desc | String | 是 | 升级信息 |
| version | String | 是 | 固件版本号 |
返回参数
| 字段名 | 字段类型 | 详细描述 |
|---|---|---|
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request": {
"apiVer": "1.0.1",
"iotToken": "token"
},
"params": {
"iotId": "",
"step": "1",
"desc": "xxxx",
"version": "1.0.1"
}
}
正常返回示例
{
"id": "94e0871c-0770-4bb3-9e29-e840d86b3ba6",
"code": 200
}
错误码
| 错误码 | 错误信息 | 详细描述 |
|---|---|---|
| 200 | success | 成功 |
| 9112 | device not found | 设备不存在 |
| 9143 | upgrade info posted is invalid | 升级进度上报错误 |
上报版本号
定义描述
| path | 版本 | 描述 | 是否需要登陆 |
|---|---|---|---|
| /thing/ota/version/reportByUser | 1.0.1 | 上报指定设备的固件升级进度信息到云端 | 是 |
请求参数
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| iotId | String | 是 | 设备id |
| version | String | 是 | 固件版本号 |
返回参数
| 字段名 | 字段类型 | 详细描述 |
|---|---|---|
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request": {
"apiVer": "1.0.1",
"iotToken": "token"
},
"params": {
"iotId": "",
"version": "1.0.1"
}
}
正常返回示例
{
"id": "94e0871c-0770-4bb3-9e29-e840d86b3ba6",
"code": 200
}
错误码
| 错误码 | 错误信息 | 详细描述 |
|---|---|---|
| 200 | success | 成功 |
| 9112 | device not found | 设备不存在 |
| 9153 | evice auth failed | 设备校验失败 |