獲取用戶名下所有設備最近一次的固件升級進度,只有在云端曾經存在過升級任務設備才會被返回。

路徑 /living/ota/progress/list
版本號 1.0.0
協議 HTTPS
請求方法 POST
是否需要用戶身份鑒權
超時時間 20000

請求參數

返回數據

名稱 類型 示例值 描述
code Int

接口返回碼。200表示成功。

message String

調用失敗時,返回的出錯信息。

localizedMsg String

本地語言的錯誤消息。

data JSON

調用成功時,返回固件升級進度信息列表。

iotId String

設備的ID,生活物聯網平臺為設備頒發的ID,設備的唯一標識符。

moduleName String

設備子模塊的名稱,控制臺的OTA固件上傳界面,在操作固件上傳時輸入的子模塊名稱。

currentVersion String

當前設備子模塊的固件版本信息。

firmwareVersion String

固件文件對應的版本號。

otaType String

固件信息的推送類型,可取值:CONFIRM(用戶確認升級); COMPELLENT(強制升級)。固件升級狀態為TO_BE_UPGRADED時該參數有效。

needConfirm Boolean

是否需要用戶進行確認操作,可取值:true(表示需要進行確認操作); false(表示不需要進行確認操作)。otaType為CONFIRM時有效。

status String

固件升級狀態。可取值: TO_BE_UPGRADED(表示待升級);UPGRADING(表示升級中);SUCCEEDED(表示升級成功);FAILED(表示升級失?。?。

step Int

升級進度百分比,當升級失敗時該參數為負數。

desc String

固件進度的描述信息。

示例

請求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.0",
		"iotToken": "token"
	},
	"params":{}
}

正常返回示例

JSON 格式

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data": [
        {
            "iotId": "xxxx",
            "moduleName": "default",
            "currentVersion": "1.0.1-2020030301",
            "firmwareVersion": "1.0.1",
            "step": 10,
            "desc": "xxxxxx",
            "otaType": "CONFIRM",
            "needConfirm": true,
            "status": "UPGRADING"
        },
        {
            "iotId": "xxxx",
            "moduleName": "default",
            "currentVersion": "1.0.1-2020030301",
            "firmwareVersion": "1.0.1",
            "step": 10,
            "desc": "xxxxxx",
            "otaType": "CONFIRM",
            "needConfirm": true,
            "status": "UPGRADING"
        }
    ]
}

異常返回示例

JSON 格式

{
    "id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
    "code": 403,
    "message": "request forbidden.",
    "localizedMsg": "請求被禁止",
    "data": null
}