获取某一个设备的固件升级进度等信息,可以指定具体的子模块名称和固件版本号。当指定了具体的子模块和固件版本号时,如果存在对应固件,则返回该固件的升级进度等信息。

路径 /living/ota/progress/get
版本号 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固件上传界面,在操作固件上传时输入的子模块名称。入参为空时,则表示获取默认的default模块。
currentVersion String v1.0.0 当前设备子模块的固件版本信息,不为空时云端会以该版本信息作为设备当前子模块的实际版本进行逻辑处理。
firmwareVersion String v1.0.0 固件的版本号。可以通过获取设备当前可用的固件信息接口获取。当子模块名称不为空并且不是default时,该入参不允许为空。

返回数据

名称 类型 示例值 描述
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":{
		"iotId": "7bvbyRItBXQxxxxxxQt9X00109ea700",
		"productKey": "a1LxxxxXUqY",
		"deviceName": "wt0jxxxxxxxnU0pc4AHX",
		"moduleName": "default",
		"currentVersion": "v1.0.0",
		"firmwareVersion": "v1.0.0"
	}
}

正常返回示例

JSON 格式

{
    "id": "4de2c367-c1db-417c-aa15-8c5xxxxd92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data": {
        "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-5bfxxxx284",
    "code": 403,
    "message": "request forbidden.",
    "localizedMsg": "请求被禁止",
    "data": null
}