获取用户名下所有设备最近一次的固件升级进度,只有在云端曾经存在过升级任务设备才会被返回。

路径 /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
}