上報設備的固件升級的進度信息給到云端進行記錄。
路徑 | /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
}