ListOTAUnfinishedTaskByDevice

更新时间:2025-10-10 07:00:16下载pdf

查询指定设备下未完成状态的设备升级作业。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListOTAUnfinishedTaskByDevice 系统规定参数。取值:ListOTAUnfinishedTaskByDevice。
ModuleName String ble OTA模块名称。

- 传入时,表示查询指定模块的升级任务。

- 不传入时,表示查询所有模块的升级任务。
TaskStatusList.N RepeatList QUEUED 查询多个指定升级状态下的设备升级作业。

- CONFIRM:待确认。

- QUEUED:待推送。

- NOTIFIED:已推送。

- IN_PROGRESS:升级中。
ProductKey String k1nhvyl**** 设备所属产品的ProductKey。
DeviceName String ble 设备名称。
TaskStatus String CONFIRM 查询单个指定升级状态下的设备升级作业。

- CONFIRM:待确认。

- QUEUED:待推送。

- NOTIFIED:已推送。

- IN_PROGRESS:升级中。
IotId String ca460d9993c9d1eae0adba**** 要查询设备的设备ID。

注意:调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException 调用失败时,返回的错误码。更多信息,请参见错误码
Data Array of SimpleOTATaskInfo 调用成功时,返回的升级作业信息。详细内容,请参见以下SimpleOTATaskInfo
SimpleOTATaskInfo
DestVersion String 1.0.1 升级的目标版本。
DeviceName String light 设备名称。
FirmwareId String 167 升级包ID。
IotId String ca460d9993c9d1eae0adba**** 物联网平台为该设备颁发的ID,设备的唯一标识符。
JobId String 183634077921266**** 升级批次ID。
ModuleName String BLE OTA模块名称。
ProductKey String k1nhvyl**** 设备所属产品的ProductKey。
ProductName String product1 设备所属产品的名称。
SrcVersion String 1.0.1 设备的原版本。
TaskId String 183634077949482**** 设备升级作业ID。
TaskStatus String CONFIRM 设备升级作业状态。

- CONFIRM:待确认。

- QUEUED:待推送。

- NOTIFIED:已推送。

- IN_PROGRESS:升级中。
UtcCreate String 2024-11-11T11:11:11.000Z 升级作业创建时的时间,UTC格式。
UtcModified String 2024-11-11T11:11:11.000Z 升级作业最后一次修改时的时间,UTC格式。
ErrorMessage String 系统异常 调用失败时,返回的出错信息。
RequestId String A59D3BE1-E9A3-43F3-9B50-B7C8DE165D9B 物联网平台为该请求生成的唯一标识符。
Success Boolean true 表示是否调用成功。

- true:调用成功。

- false:调用失败。

示例

请求示例

curl 'https://si-d6e******958054.tuyacloud.com:8686/?Action=ListOTAUnfinishedTaskByDevice&SignatureNonce=9e6189124f5a4716ad2de849467b****&AccessKeyId=xMr9wgwXQLhv5AUa65o0****&SignatureMethod=HMAC-SHA1&Timestamp=2024-11-19T09%3A47%3A43Z&ProductKey=k1nhvyl****&DeviceName=blelight1&TaskStatus=CONFIRM&Signature=WJN0Ee8%2BX6pogcD3loLHIqQNEN0%3D'

正常返回示例

{
    "code": "",
    "data": {
        "simpleOTATaskInfo": [
            {
                "destVersion": "3.9.0",
                "deviceName": "device_actived",
                "firmwareId": "123",
                "iotId": "OZs5tjTkzRRTZSCekmbRk1****",
                "jobId": "183371207742901****",
                "moduleName": "ble",
                "productKey": "k1h9drZ****",
                "productName": "testProduct1",
                "srcVersion": "1.8",
                "taskId": "183371207782747****",
                "taskStatus": "NOTIFIED",
                "utcCreate": "2024-09-11T03:40:02.734Z",
                "utcModified": "2024-09-11T06:27:24.649Z"
            }
        ]
    },
    "requestId": "352b8d45-4544-45b2-9d79-b9b5e6640ce7",
    "success": true
}