通过ListOTAJobByFirmware获取升级包下的升级任务批次列表

ListOTAJobByFirmware

获取升级包下的升级任务批次列表。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	ListOTAJobByFirmware	系统规定参数。取值：ListOTAJobByFirmware。
CurrentPage	Integer	是	1	指定从返回结果中的第几页开始显示。页数从1开始排序。
FirmwareId	String	是	197	升级包ID，升级包的唯一标识符。
PageSize	Integer	是	10	指定返回结果中，每页显示的升级批次数量。最大值200。

重要

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

返回数据

名称	类型	示例值	描述
Code	String	iot.system.SystemException	调用失败时，返回的错误码。更多信息，请参见错误码。
CurrentPage	Integer	1	当前页码。
Data	Array of SimpleOTAJobInfo		调用成功时，返回的批次信息。详情请参见SimpleOTAJobInfo下的参数。
SimpleOTAJobInfo
FirmwareId	String	176	升级包ID。
JobId	String	183634077921266****	升级批次ID，批次的唯一标识符。
JobStatus	String	IN_PROGRESS	批次的状态。 PLANNED：计划中。批次已创建，但是定时时间未到。仅定时静态升级的批次可能返回该值。 IN_PROGRESS：执行中。 COMPLETED：已完成。 CANCELED：已取消。
JobType	String	UPGRADE_FIRMWARE	批次类型。 VERIFY_FIRMWARE：升级包验证批次。 UPGRADE_FIRMWARE：批量升级批次。
ProductKey	String	a19mzPZ****	升级包所属产品的唯一标识。
TargetSelection	String	SPECIFIC	升级范围。 ALL：全量升级。 SPECIFIC：定向升级。 GRAY：灰度升级。
UtcCreate	String	2019-12-28T02:43:10.000Z	批次创建时的时间，UTC格式。
UtcModified	String	2019-12-28T02:43:10.000Z	批次最后一次修改时的时间，UTC格式。
ErrorMessage	String	系统异常	调用失败时，返回的出错信息。
PageCount	Integer	1	总页数。
PageSize	Integer	10	每页显示的设备升级作业数量。
RequestId	String	5D58AC86-D5BF-4B39-834E-913E7F2C985D	物联网平台为该请求生成的唯一标识符。
Success	Boolean	true	是否调用成功。 true：调用成功。 false：调用失败。
Total	Integer	1	设备升级作业数量总计。

示例

请求示例

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

正常返回示例

{
    "code": "",
    "currentPage": 1,
    "data": {
        "simpleOTAJobInfo": [
            {
                "firmwareId": "125",
                "jobId": "183414358556252****",
                "jobStatus": "COMPLETED",
                "jobType": "UPGRADE_FIRMWARE",
                "productKey": "k1h9drZ****",
                "selectionType": "STATIC",
                "targetSelection": "SPECIFIC",
                "utcCreate": "2024-09-12T08:14:42.214Z",
                "utcModified": "2024-09-12T08:14:42.214Z"
            }
        ]
    },
    "pageCount": 1,
    "pageSize": 10,
    "requestId": "78159f9b-5b3c-446c-b51a-28d701f7de88",
    "success": true,
    "total": 1
}