上报设备的固件升级的进度信息给到云端进行记录。
路径 | /living/ota/progress/report |
版本号 | 1.0.0 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 是 |
超时时间 | 3000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
iotId | String | 否 | 7bvbyRItBXQxxxxxxQt9X00109ea700 | 设备的ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。产品的Key或设备名称为空时,该参数不允许为空。设备ID、产品的Key和设备名称若同时填写,以设备ID为准。 |
productKey | String | 否 | a1LxxxxXUqY | 产品的Key,设备证书信息之一。创建产品时,生活物联网平台为该产品颁发的全局唯一标识。设备ID为空时,该参数不允许为空。设备ID、产品的Key和设备名称若同时填写,以设备ID为准。 |
deviceName | String | 否 | wt0jxxxxxxxnU0pc4AHX | 设备的名称,设备证书信息之一。在注册设备时,自定义的或系统生成的设备名称,具备产品维度内的唯一性。设备ID为空时,该参数不允许为空。设备ID、产品的Key和设备名称若同时填写,以设备ID为准。 |
moduleName | String | 否 | default | 设备子模块的名称,控制台的OTA固件上传界面,在操作固件上传时输入的子模块名称。 |
firmwareVersion | String | 是 | v1.0.0 | 固件的版本号。可以通过获取设备当前可用的固件信息接口获取。 |
step | String | 是 | 100 | 固件升级进度信息,可取值[-1,100]。 |
desc | String | 否 | 升级已完成 | 升级进度的描述信息。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
接口返回码。200表示成功。 |
|
message | String |
调用失败时,返回的出错信息。 |
|
localizedMsg | String |
本地语言的错误消息。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.0",
"iotToken": "token"
},
"params":{
"iotId": "7bvbyRItBXQxxxxxxQt9X00109ea700",
"productKey": "a1LxxxxXUqY",
"deviceName": "wt0jxxxxxxxnU0pc4AHX",
"moduleName": "default",
"firmwareVersion": "v1.0.0",
"step": "100",
"desc": "升级已完成"
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}