调用该接口创建静态升级批次。

使用说明

  • 若在调用CreateOTAFirmware接口创建升级包时，未指定“升级包可不通过验证”，则调用本接口创建批量升级批次前，必须保证升级包已验证成功。关于如何创建验证升级包任务，请参见CreateOTAVerifyJob。
  • 单次调用，对于定向升级，若直接传入设备名称，则最多可对200个设备发起升级任务；若使用待升级设备列表文件，则最多可对1,000,000个设备发起升级任务，需提前调用GenerateDeviceNameListURL生成文件URL，并按说明上传设备列表文件。
  • 对多个设备发起升级任务时，如果某设备已经是目标版本，则过滤该设备，继续升级任务。
  • 同一设备只能同时在一个升级批次中处于待升级或正在升级状态。对处于待升级或正在升级状态的设备发起新的升级任务，后发起的任务会直接失败。
  • 可以对单个升级包，同时发起多个静态升级批次。
  • 当前仅中国的华东2（上海）地域下，支持使用MQTT协议下载升级包。

QPS限制

单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为20。

说明 RAM用户共享阿里云账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 CreateOTAStaticUpgradeJob

系统规定参数。取值：CreateOTAStaticUpgradeJob。
FirmwareId String 是 nx3xxVvFdwvn6dim50PY03****

升级包ID，升级包的唯一标识符。

升级包ID是调用CreateOTAFirmware创建升级包时，返回的参数之一。

您也可以调用ListOTAFirmware接口，从返回参数中查看。

ProductKey String 是 a1Le6d0****

升级包所属产品的ProductKey。

ProductKey是物联网平台为产品颁发的全局唯一标识符。您可以在物联网平台控制台或调用QueryProductList，查看当前账号下所有产品的信息。

Tag.N.Key String 是 key1

批次标签key。仅支持英文字母、数字、半角句号（.），长度限制为1~30个字符。支持最多添加10个批次标签。

批次标签将在向设备推送升级通知时下发给设备。

说明 批次标签可以不传入。是否必选的是，表示如果传入批次标签Tag，Tag.N.Value与Tag.N.Key必须成对传入。
Tag.N.Value String 是 value1

批次标签value。长度限制为1~1024个字符。支持最多添加10个批次标签。所有批次标签key和value的长度总和，不能超过4096个字符。

说明 批次标签可以不传入。是否必选的是，表示如果传入批次标签Tag，Tag.N.Value与Tag.N.Key必须成对传入。
TargetSelection String 是 ALL

升级范围。

  • ALL：全量升级。
  • SPECIFIC：定向升级。
  • GRAY：灰度升级。
  • GROUP：分组升级。
IotInstanceId String 否 iot-cn-0pp1n8t****

实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。

重要
  • 若有ID值，必须传入该ID值，否则调用会失败。
  • 若无实例概览页面或ID值，则无需传入。

实例的更多信息，请参见实例概述。

SrcVersion.N RepeatList 否 V1.0.1

待升级版本号列表。

说明
  • 发起全量升级（TargetSelection=ALL）和灰度升级（TargetSelection=GRAY）任务时，可以传入该参数。
  • 使用差分升级包发起全量升级和灰度升级任务时，该参数值需指定为差分升级包的待升级版本号（SrcVersion）。
  • 发起定向升级（TargetSelection=SPECIFIC）或分组升级（TargetSelection=GROUP）任务时，不能传入该参数。
  • 可以调用QueryDeviceDetail，查看设备OTA模块版本号（FirmwareVersion）。
  • 列表中不能有重复的版本号。
  • 最多可传入10个版本号。
ScheduleTime Long 否 1577808000000

指定发起OTA升级的时间。

定时时间范围需为当前时间的5分钟后至7天内。取值为13位毫秒值时间戳。

不传入该参数，则表示立即升级。
RetryInterval Integer 否 60

设备升级失败后，自动重试的时间间隔，单位为分钟。可选值：

  • 0：立即重试。
  • 10：10分钟后重试。
  • 30：30分钟后重试。
  • 60：60分钟（即1小时）后重试。
  • 1440：1,440分钟（即24小时）后重试。
重要 RetryInterval的值需要小于TimeoutInMinutes的值。例如：
  • TimeoutInMinutes的值为60分钟，RetryInterval的值最大可设置为30。
  • TimeoutInMinutes的值为1440分钟，RetryInterval的值最大可设置为60。

若RetryInterval需设置为24小时后重试，则建议不传入TimeoutInMinutes。因升级超时后，不会再触发升级重试。

不传入此参数，则表示不重试。
RetryCount Integer 否 1

自动重试次数。

如果传入RetryInterval参数，则需传入该参数。

可选值：

  • 1：1次。
  • 2：2次。
  • 5：5次。
TimeoutInMinutes Integer 否 1440

设备升级超时时间，超过指定时间后，设备未完成升级，则升级失败。单位为分钟，取值范围为1~1,440。

说明
  • 从设备首次上报进度开始计算时间。升级期间若设备多次上下线，触发物联网平台多次推送升级包，都始终以设备最开始的第一次上报升级进度时间作为开始时间。
  • 因超时而导致的升级失败，物联网平台不会触发自动重试逻辑。

不传入该参数，则表示设备升级没有超时限制。
MaximumPerMinute Integer 否 1000

每分钟最多向多少个设备推送升级包下载URL。取值范围：10~10,000。

不传入该参数，则取默认值10,000。
GrayPercent String 否 33.33

设置灰度比例。取值为字符串格式的百分比，小数点后最多3位小数，系统计算结果向下取整。灰度升级的设备至少为1个。

例如有100个待升级设备，设置灰度升级的灰度比例为33.33，则系统计算结果为33。

升级范围指定为灰度升级（TargetSelection=GRAY）时，需传入此参数。

TargetDeviceName.N RepeatList 否 deviceName1

定向升级的设备名称列表。

说明
  • 发起定向升级（TargetSelection=SPECIFIC）任务时，需传入该参数或DnListFileUrl，不可同时传入。
  • 使用差分升级包进行定向升级时，要升级的设备的当前OTA模块版本号需与差分升级包的待升级版本号（SrcVersion）相同。
  • 可以调用QueryDeviceDetail，查看设备OTA模块版本号（FirmwareVersion）。
  • 列表中的设备所属的产品必须与升级包所属产品一致。
  • 列表中不能有重复的设备名称。
  • 最多可传入200个设备名称。
ScheduleFinishTime Long 否 1577909000000

指定结束升级的时间。

结束时间距发起时间（ScheduleTime）最少1小时，最多为30天。取值为13位毫秒值时间戳。

不传入该参数，则表示不会强制结束升级。
OverwriteMode Integer 否 1

是否覆盖之前的升级任务。取值：

  • 1（默认）：不覆盖。若设备已有升级任务，则只执行已有任务。
  • 2：覆盖。设备只执行新的升级任务。此时MultiModuleMode不能传入true。
说明 不覆盖升级中的任务。
DnListFileUrl String 否 https://iotx-ota.oss-cn-shanghai.aliyuncs.com/ota/65dfcda0473be29836dfde585472****/ck2nfzljo00023g7kysg0****.bin

定向升级设备列表文件的URL。

说明
  • 发起定向升级（TargetSelection=SPECIFIC）任务时，需传入该参数或TargetDeviceName.N，不可同时传入。
  • 请调用GenerateDeviceNameListURL生成文件URL，并按说明上传设备列表文件。
  • 整包升级时，会过滤列表中已经升级成功的设备。
  • 差分升级时，会过滤列表中已经升级成功，和初始版本号跟升级包不相符的设备。
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）任务时，需传入该参数和GroupType。

您可调用QueryDeviceGroupList接口查询分组ID（GroupId）。

GroupType String 否 LINK_PLATFORM

分组类型，仅可取值LINK_PLATFORM。

仅当发起分组升级（TargetSelection=GROUP）任务时，需传入该参数和GroupId。

DownloadProtocol String 否 HTTPS

升级包下载协议，可选：HTTPS（默认）或MQTT。设备端收到物联网平台推送的升级包下载信息后，通过该协议下载升级包。

重要 使用MQTT协议下载升级包，必须符合以下条件：
  • 支持的地域：仅中国的华东2（上海）、华北2（北京）和华南1（深圳）。
  • OTA升级包：仅包含一个文件，且文件大小不超过16 MB。
  • 设备端SDK：必须使用物联网平台提供的C语言Link SDK最新版本的软件包，开发OTA升级和MQTT下载文件的能力。详细内容，请参见使用MQTT协议下载升级包的OTA升级代码示例。
MultiModuleMode Boolean 否 false

设备是否支持多模块同时升级。

  • false（默认）：否，设备不支持多模块同时升级。

  • true：是，设备支持多个不同模块同时独立升级。MultiModuleMode为true时，OverwriteMode不能传入2。

    相同模块下的升级任务会被覆盖，但不会覆盖升级中的任务。多个不同模块升级互不影响。

重要
  • 支持的实例：企业版实例和新版公共实例。
  • 设备端SDK：必须使用物联网平台提供的设备端C语言4.x版本的Link SDK。

更多信息，请参见设备支持多模块同时升级说明表。

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

返回数据

名称 类型 示例值 描述
Code String MissingFirmwareId

调用失败时，返回的错误码。更多信息，请参见错误码。

Data Struct

调用成功时，返回的升级批次信息。更多信息，请参见Data下参数说明。
JobId String wahVIzGkCMuAUE2gDERM02****

升级批次ID，升级批次的唯一标识符。
UtcCreate String 2019-11-04T06:22:19.566Z

升级批次的创建时间，UTC格式。
ErrorMessage String FirmwareId is mandatory for this action.

调用失败时，返回的出错信息。
RequestId String 29EC7245-0FA4-4BB6-B4F5-5F04818FDFB1

阿里云为该请求生成的唯一标识符。
Success Boolean true

是否调用成功。

  • true：调用成功。
  • false：调用失败。

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=CreateOTAStaticUpgradeJob
&FirmwareId=nx3xxVvFdwvn6dim50PY03****
&ProductKey=a1Le6d0****
&Tag.1.Key=key1
&Tag.1.Value=value1
&TargetSelection=ALL
&MaximumPerMinute=1000
&RetryCount=1
&RetryInterval=60
&TimeoutInMinutes=1440
&SrcVersion.1=V1.0.1
&<公共请求参数>

正常返回示例

XML格式 

<CreateOTAStaticUpgradeJobResponse>
   <Data>
       <JobId>wahVIzGkCMuAUE2gDERM02****</JobId>
       <UtcCreate>2019-11-04T06:22:19.566Z</UtcCreate>
   </Data>
   <RequestId>29EC7245-0FA4-4BB6-B4F5-5F04818FDFB1</RequestId>
   <Success>true</Success>
</CreateOTAStaticUpgradeJobResponse>

JSON格式 

{
  "Data": {
    "JobId": "wahVIzGkCMuAUE2gDERM02****",
    "UtcCreate": "2019-11-04T06:22:19.566Z"
  },
  "RequestId": "29EC7245-0FA4-4BB6-B4F5-5F04818FDFB1",
  "Success": true
}

错误码

访问错误中心查看更多错误码。