设备版本
大约 3 分钟
设备版本
记录设备的「模块-版本」信息(如 MCU、模组各自独立升级的版本)。除手动维护外,设备通过 /ota/device/inform 上报版本时会自动写入/更新对应记录。
创建设备版本记录
| POST | /admin-api/iot/device-version/create |
|---|
请求数据类型 :application/json;charset=UTF-8
请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| deviceId | 设备id | json | true | long |
| productKey | 产品productKey | json | false | string |
| deviceName | 设备唯一标识 | json | false | string |
| moduleName | 模块名称,如 default、MCU | json | false | string |
| version | 版本号 | json | false | string |
| Authorization | 认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌 | header | true | string |
响应状态
| 状态码 | 说明 |
|---|---|
| 200 | OK |
响应参数
| 参数名称 | 参数说明 | 数据类型 |
|---|---|---|
| status | 状态码,值为0正常,其他值为异常 | int |
| code | 结果同status一样,冗余字段 | int |
| data | 创建成功返回记录id | long |
| msg | 状态消息 | string |
查询版本记录分页
| GET | /admin-api/iot/device-version/page |
|---|
请求数据类型 :application/json;charset=UTF-8
请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| pageNo | 页码,从 1 开始,示例值(1) | query | false | int32 |
| pageSize | 每页条数,最大值为 1000,示例值(10) | query | false | int32 |
| deviceId | 设备id | query | false | long |
| productKey | 产品productKey | query | false | string |
| deviceName | 设备唯一标识 | query | false | string |
| moduleName | 模块名称 | query | false | string |
| version | 版本号 | query | false | string |
| createTime | 创建时间时间范围 | query | false | array[datetime] |
| Authorization | 认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌 | header | true | string |
响应状态
| 状态码 | 说明 |
|---|---|
| 200 | OK |
响应参数
| 参数名称 | 参数说明 | 数据类型 |
|---|---|---|
| status | 状态码,值为0正常,其他值为异常 | int |
| code | 结果同status一样,冗余字段 | int |
| data | 分页数据 | object |
| ---total | 返回结果条数 | int |
| ---list | 返回数据列表 | array |
| ------id | 记录id | long |
| ------deviceId | 设备id | long |
| ------productKey | 产品productKey | string |
| ------deviceName | 设备唯一标识 | string |
| ------moduleName | 模块名称 | string |
| ------version | 版本号 | string |
| ------createTime | 创建时间 | string |
| msg | 状态消息 | string |
查询指定模块的版本号列表
| GET | /admin-api/iot/device-version/list |
|---|
请求数据类型 :application/json;charset=UTF-8
接口描述
查询某产品某模块下已存在的版本号列表(去重),常用于 OTA 创建批次时选择「待升级版本」或「目标版本」。
请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| productKey | 产品productKey | query | true | string |
| moduleName | 模块名称 | query | true | string |
| excludedVersion | 排除的版本号(从结果中过滤掉该版本) | query | false | string |
| Authorization | 认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌 | header | true | string |
响应状态
| 状态码 | 说明 |
|---|---|
| 200 | OK |
响应参数
| 参数名称 | 参数说明 | 数据类型 |
|---|---|---|
| status | 状态码,值为0正常,其他值为异常 | int |
| code | 结果同status一样,冗余字段 | int |
| data | 版本号列表,如 ["1.0.0","1.0.3"] | array |
| msg | 状态消息 | string |
更新 / 删除
| 方法 | 路径 | 说明 |
|---|---|---|
| PUT | /admin-api/iot/device-version/update | 更新版本记录,请求参数同创建,另需传 id(必填) |
| DELETE | /admin-api/iot/device-version/delete | 删除版本记录,query 参数:id(必填) |