获取设备当前可用于升级的固件信息。

路径 /living/ota/firmware/file/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 当前设备子模块的固件版本信息，不为空时云端会以该版本信息作为设备当前子模块的实际版本进行逻辑处理。

返回数据

名称类型示例值描述
名称 类型 示例值 描述
code Int

接口返回码。200表示成功。
message String

调用失败时，返回的出错信息。
localizedMsg String

本地语言的错误消息。
data JSON

调用成功时，返回固件信息。
moduleName String

当前固件对应的设备子模块名称，为空或default表示主模块。
currentVersion String

当前设备子模块实际烧录的固件版本号。
status String

固件升级状态。可取值： TO_BE_UPGRADED（表示待升级）；SUCCEEDED（表示升级成功）。
firmwareVersion String

当前固件的版本号。固件升级状态为TO_BE_UPGRADED时该参数有效。
size String

固件文件包大小，单位Byte，固件升级状态为TO_BE_UPGRADED时该参数有效。
sign String

版本固件文件加签处理后的数据内容，固件升级状态为TO_BE_UPGRADED时该参数有效。
signMethod String

当前固件校验数据的加签方式，可取值：MD5（表示采用md5加签）；SHA256（表示采用sha256加签），固件升级状态为TO_BE_UPGRADED时该参数有效。
url String

当前固件文件的下载地址，固件升级状态为TO_BE_UPGRADED时该参数有效。
details String

固件的信息描述，固件升级状态为TO_BE_UPGRADED时该参数有效。
otaType String

固件信息的推送类型，可取值：CONFIRM（用户确认升级）； COMPELLENT（强制升级），固件升级状态为TO_BE_UPGRADED时该参数有效。

示例

请求示例

{
	"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"
	}
}

正常返回示例

JSON 格式 

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data": {
        "moduleName": "default",
        "currentVersion": "1.0.1-2020030301",
        "status": "TO_BE_UPGRADED",
        "firmwareVersion": "1.0.3-2020061802",
        "size": "4000000",
        "sign": "xxxxxxx",
        "signMethod": "MD5",
        "url": "xxxxxxx",
        "details": "xxxxxxx",
        "otaType": "CONFIRM"
    }
}

异常返回示例

JSON 格式 

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