QueryOTAJob

更新时间：2025-10-10 06:57:22下载pdf

查询指定升级批次的详情。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	QueryOTAJob	系统规定参数。取值：QueryOTAJob。
JobId	String	是	183634077921266****	升级批次ID。

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

返回数据

名称	类型	示例值	描述
Code	String	iot.system.SystemException	调用失败时，返回的错误码。更多信息，请参见错误码。
Data	Struct		调用成功时，返回的升级批次信息。详情见以下Data所包含的参数。
DestVersion	String	1.0.1	升级目标版本号。
DownloadProtocol	String	HTTPS	升级包文件的下载协议。
FirmwareId	String	167	升级包ID。
GrayPercent	String	50	灰度升级的比例。仅升级范围为灰度升级时，返回该参数。
GroupId	String	18873***	分组升级的设备分组ID。
GroupName	String	test	分组升级的设备分组名称。
JobDesc	String	batch upgrade	升级批次描述。
JobId	String	183634077921266****	升级批次ID，批次的唯一标识符。
JobStatus	String	IN_PROGRESS	批次的状态。 - PLANNED：计划中。批次已创建，但是定时时间未到。仅定时静态升级的批次可能返回该值。 - IN_PROGRESS：执行中。 - COMPLETED：已完成。 - CANCELED：已取消。
JobType	String	UPGRADE_FIRMWARE	批次类型。 - VERIFY_FIRMWARE：升级包验证批次。 - UPGRADE_FIRMWARE：批量升级批次。
Name	String	Firmware2	升级包名称。
NeedConfirm	Boolean	false	是否App确认升级。
NeedPush	Boolean	true	物联网平台是否主动向设备推送升级任务。
ProductKey	String	a19mzPZ****	升级包所属产品的ProductKey。
RetryCount	Integer	1	设备升级失败后，自动重试次数。创建升级批次时，设置了失败重试策略，则返回该参数。
RetryInterval	Integer	60	设备升级失败后，自动重试时间间隔，单位：分钟。创建升级批次时，设置了失败重试策略，则返回该参数。
SrcVersions	List	{“SrcVersion”: [“1.0.0”]}	待升级版本号列表。
TargetSelection	String	ALL	升级范围。 - ALL：全量升级。 - SPECIFIC：定向升级。 - GRAY：灰度升级。
TimeoutInMinutes	Integer	5	设备升级超时时间，单位：分钟。创建升级批次时，设置了超时时间，则返回该参数。
UtcCreate	String	2024-11-11T11:11:11.000Z	批次创建时的时间，UTC格式。
UtcModified	String	2024-11-11T11:11:11.000Z	批次最后一次修改时的时间，UTC格式。
ErrorMessage	String	系统异常	调用失败时，返回的出错信息。
RequestId	String	30F1BB8D-EDBF-44FD-BBC0-BE97DEA73991	阿里云为该请求生成的唯一标识符。
Success	Boolean	true	是否调用成功。 - true：调用成功。 - false：调用失败。

示例

请求示例

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

正常返回示例

{
    "code": "",
    "data": {
        "destVersion": "2.8",
        "downloadProtocol": "HTTPS",
        "firmwareId": "126",
        "grayPercent": "10",
        "jobId": "183415776199966****",
        "jobStatus": "COMPLETED",
        "jobType": "UPGRADE_FIRMWARE",
        "name": "Test",
        "needConfirm": false,
        "needPush": true,
        "overwriteMode": 0,
        "productKey": "k1h9drZ****",
        "retryCount": 1,
        "retryInterval": 61,
        "selectionType": "STATIC",
        "targetSelection": "GRAY",
        "timeoutInMinutes": 1,
        "utcCreate": "2024-09-12T09:11:02.131Z",
        "utcModified": "2024-09-12T09:11:02.131Z"
    },
    "requestId": "f7d5db8c-df95-4c9b-96af-2273ae7fb457",
    "success": true
}

上一篇CreateOTAStaticUpgradeJob

下一篇CancelOTATaskByJob