ListOTATaskByJob

更新时间：2025-10-10 06:58:32下载pdf

查询指定升级批次下的设备升级作业列表。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	ListOTATaskByJob	系统规定参数。取值：ListOTATaskByJob。
JobId	String	是	183634077921266****	升级批次ID，升级批次的唯一标识符。
PageSize	Integer	否	10	指定返回结果中，每页显示的设备升级作业数量。最大限制：100。
TaskStatus	String	否	FAILED	传入此参数，则查询指定升级状态下的设备升级作业。 - CONFIRM：待确认。 - QUEUED：待推送。 - NOTIFIED：已推送。 - IN_PROGRESS：升级中。 - SUCCEEDED：升级成功。 - FAILED：升级失败。 - CANCELED：已取消。不传入此参数，则查询指定升级批次下的全部设备升级作业。
CurrentPage	Integer	否	1	指定从返回结果中的第几页开始显示。页数从1开始排序。
DeviceNames.N	RepeatList	否	device1	指定查询的设备名称列表。

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

返回数据


名称	类型	示例值	描述
Code	String	iot.system.SystemException	调用失败时，返回的错误码。更多信息，请参见错误码。
CurrentPage	Integer	1	当前页码。
Data	Array of SimpleOTATaskInfo		调用成功时，返回的设备升级作业信息。
SimpleOTATaskInfo
DestVersion	String	1.0.1	升级的目标OTA升级包版本。
DeviceName	String	device2	设备名称。
FirmwareId	String	167	升级包ID。
IotId	String	ca460d9993c9d1eae0adba****	设备ID。
JobId	String	183634077921266****	升级批次ID。
ProductKey	String	k1nhvyl****	设备所属产品的ProductKey。
ProductName	String	product1	设备所属产品的名称。
Progress	String	50	当前的升级进度。
SrcVersion	String	1.0.0	设备的原固件版本。
TaskDesc	String	test task desc	升级作业描述信息。当设备升级超时、升级作业被取消等场景下，该参数承载具体的错误信息。
TaskId	String	183634077921266****	设备升级作业ID。
TaskStatus	String	FAILED	设备升级状态。 - CONFIRM：待确认。 - QUEUED：待推送。 - NOTIFIED：已推送。 - IN_PROGRESS：升级中。 - SUCCEEDED：升级成功。 - FAILED：升级失败。 - CANCELED：已取消。
Timeout	String	1440	设备升级超时时间，单位是分钟。
UtcCreate	String	2024-11-11T11:11:11.000Z	升级作业创建时的时间，UTC格式。
UtcModified	String	2024-11-11T11:11:11.000Z	升级作业最后一次修改时的时间，UTC格式。
ErrorMessage	String	系统异常	调用失败时，返回的出错信息。
PageCount	Integer	1	总页数。
PageSize	Integer	10	每页显示的设备升级作业数量。
RequestId	String	A59D3BE1-E9A3-43F3-9B50-B7C8DE165D9B	阿里云为该请求生成的唯一标识符。
Success	Boolean	true	表示是否调用成功。 - true：调用成功。 - false：调用失败。
Total	Integer	2	设备升级作业数量总计。

示例

请求示例

curl 'https://si-d6e8******958054.tuyacloud.com:8686/?Action=ListOTATaskByJob&SignatureNonce=9e6189124f5a4716ad2de849467b****&AccessKeyId=xMr9wgwXQLhv5AUa65o0****&SignatureMethod=HMAC-SHA1&Timestamp=2024-11-19T09%3A47%3A43Z&JobId=183634077921266****&PageSize=10&CurrentPage=1&Signature=WJN0Ee8%2BX6pogcD3loLHIqQNEN0%3D'

正常返回示例

{
    "code": "",
    "currentPage": 1,
    "data": {
        "simpleOTATaskInfo": [
            {
                "destVersion": "1.2.3",
                "deviceName": "device_actived",
                "firmwareId": "136",
                "iotId": "OZs5tjTkzRRTZSCekmbRk1****",
                "jobId": "183634077921266****",
                "productKey": "k1h9drZ****",
                "srcVersion": "0.0.0",
                "taskDesc": "fix device ota module",
                "taskId": "18363407798669****",
                "taskStatus": "FAILED",
                "timeout": "5",
                "utcCreate": "2024-09-18T09:45:34.139Z",
                "utcModified": "2024-09-18T09:45:34.148Z"
            }
        ]
    },
    "pageCount": 1,
    "pageSize": 10,
    "requestId": "fe273c87-abc9-483f-bd63-e9876d594cd3",
    "success": true,
    "total": 1
}

上一篇ListOTAJobByDevice

下一篇ListOTAUnfinishedTaskByDevice