通过CreateOTAStaticUpgradeJob创建静态升级批次_云市场(Marketplace)-阿里云帮助中心

CreateOTAStaticUpgradeJob

创建静态升级批次。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	CreateOTAStaticUpgradeJob	系统规定参数。取值：CreateOTAStaticUpgradeJob。
FirmwareId	String	是	178	升级包ID，升级包的唯一标识符。
ProductKey	String	是	k1nhvyl****	升级包所属产品的ProductKey。
TargetSelection	String	是	ALL	升级范围。 ALL：全量升级。 SPECIFIC：定向升级。 GRAY：灰度升级。 GROUP：分组升级。
SrcVersion.N	RepeatList	否	V1.0.1	待升级版本号列表。说明
RetryInterval	Integer	否	60	设备升级失败后，自动重试的时间间隔，单位为分钟。可选值： 0：立即重试。 10：10分钟后重试。 30：30分钟后重试。 60：60分钟（即1小时）后重试。 1440：1,440分钟（即24小时）后重试。不传入此参数，则表示不重试。
RetryCount	Integer	否	1	自动重试次数。如果传入RetryInterval参数，则需传入该参数。可选值： 1：1次。 2：2次。 5：5次。
TimeoutInMinutes	Integer	否	1440	设备升级超时时间，超过指定时间后，设备未完成升级，则升级失败。单位为分钟，取值范围为1~1,440。不传入该参数，则表示设备升级没有超时限制。
GrayPercent	String	否	33	设置灰度比例。取值为字符串格式的整数升级范围指定为灰度升级（`TargetSelection=GRAY`）时，需传入此参数。
TargetDeviceName.N	RepeatList	否	deviceName1	定向升级的设备名称列表。
NeedPush	Boolean	否	true	物联网平台是否主动向设备推送升级任务。 true（默认）：是。批次任务创建完成后，物联网平台主动将升级任务，直接推送给升级范围内的在线设备。此时，设备仍可主动向物联网平台发起请求，来获取OTA升级任务信息。 false：否。设备必须通过向物联网平台发起请求，来获取OTA升级任务信息。
NeedConfirm	Boolean	否	false	如需自主控制设备OTA升级时，可配置此参数，通过手机App来控制，设备是否可进行OTA升级。手机App需您自行开发。 false（默认）：否。直接按照NeedPush设置，获取OTA升级任务信息。 true：是。设备无法获取OTA升级任务，需App侧确认OTA升级后，才能按照NeedPush设置，获取OTA升级任务信息。
GroupId	String	否	CtjzCkNuOx***	分组ID。仅当发起分组升级（`TargetSelection=GROUP`）任务时，需传入该参数。
DownloadProtocol	String	否	HTTPS	升级包下载协议，当前仅可选：HTTPS。设备端收到物联网平台推送的升级包下载信息后，通过该协议下载升级包。

重要

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

返回数据

名称	类型	示例值	描述
Code	String	iot.system.SystemException	调用失败时，返回的错误码。更多信息，请参见错误码。
Data	Struct		调用成功时，返回的升级批次信息。更多信息，请参见Data下参数描述。
JobId	String	183634077921266****	升级批次ID，升级批次的唯一标识符。
UtcCreate	String	2024-11-11T11:21:54.607Z	升级批次的创建时间，UTC格式。
ErrorMessage	String	系统异常	调用失败时，返回的出错信息。
RequestId	String	291438BA-6E10-4C4C-B761-243B9A0D324F	物联网平台为该请求生成的唯一标识符。
Success	Boolean	true	是否调用成功。 true：调用成功，表示OTA升级包创建成功。 false：调用失败，表示OTA升级包创建失败。

示例

请求示例

curl 'https://si-d6e8d812acb848958054.tuyacloud.com:8686/?Action=CreateOTAStaticUpgradeJob&SignatureNonce=9e6189124f5a4716ad2de849467b****&AccessKeyId=xMr9wgwXQLhv5AUa65o0****&SignatureMethod=HMAC-SHA1&Timestamp=2024-11-19T09%3A47%3A43Z&FirmwareId=167&ProductKey=k1nhvyl****&TargetSelection=ALL&RetryCount=1&RetryInterval=60&TimeoutInMinutes=1440&SrcVersion.1=1.0&Signature=WJN0Ee8%2BX6pogcD3loLHIqQNEN0%3D'

正常返回示例

{
    "code": "",
    "data": {
        "firmwareId": "183634077921266****",
        "utcCreate": "2024-11-20T08:50:00.239Z"
    },
    "requestId": "d2fce065-8238-4ee2-a793-0226f69b0542",
    "success": true
}