UpdateOTAJob

调用接口UpdateOTAJob更新OTA升级批次的配置,支持更新静态升级批次和动态升级批次。

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

说明 单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String UpdateOTAJob

系统规定参数。取值:UpdateOTAJob。

JobId String 7glPHmaDYLAYMD1HHutT02****

待修改的升级批次ID。

创建升级批次任务(CreateOTAStaticUpgradeJobCreateOTADynamicUpgradeJob)后,会返回升级批次ID(JobId)。

MaximumPerMinute Integer 5000

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

说明 即使MaximumPerMinute值不变,也需要传入该参数。
Tags.N.Key String key1

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

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

说明 Tag.N.ValueTag.N.Key必须成对传入。如果创建升级批次任务时,设置了批次标签,即使不修改标签,调用本接口时也必须传入已设置的标签。如果不传入,批次标签会被清空。
Tags.N.Value String value1

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

说明 Tag.N.ValueTag.N.Key必须成对传入。如果创建升级批次任务时,设置了批次标签,即使不修改标签,调用本接口时也必须传入已设置的标签。如果不传入,批次标签会被清空。
TargetSelection String All

升级策略。

  • ALL:全量升级。
  • SPECIFIC:定向升级。
  • GRAY:灰度升级。
  • GROUP:分组升级。
UpgradeType String STATIC

待修改的升级批次类型。

  • STATIC:静态升级批次。
  • DYNAMIC:动态升级批次。
TimeoutInMinutes Integer 600

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

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

待升级版本号列表。

说明
  • 仅动态升级批次基于版本升级时,可修改待升级版本号。静态升级批次,该参数不生效,无需传入该参数。
  • 可以调用QueryDeviceDetail,查看设备OTA模块版本号FirmwareVersion
  • 列表中不能有重复的版本号。
  • 最多可传入30个版本号。如果超出30个,超出部分不生效。
IotInstanceId String iot-0pp1n8t****

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

重要
  • 若有ID值,必须传入该ID值,否则调用会失败。
  • 若无ID值,则无需传入。

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

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

返回数据

名称

类型

示例值

描述

Code String 400

调用结果状态码:

  • 调用成功,返回200。
  • 调用失败,返回错误码。详细信息,请参见下文错误码
ErrorMessage String The specified firmware does not exist.

调用失败时,返回的出错信息。

RequestId String E55***B7-4***-4***-8***-D3******F565

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

Success Boolean true

是否调用成功。

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

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=UpdateOTAJob
&JobId=7glPHmaDYLAYMD1HHutT02****
&IotInstanceId=iot-0pp1n8t****
&MaximumPerMinute=5000
&Tags.1.Key=key1
&Tags.1.Value=value1
&TargetSelection=All
&UpgradeType=STATIC
&<公共请求参数>

正常返回示例

XML格式

<UpdateOTAJobResponse>
  <RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>
  <Code>200</Code>
  <Success>true</Success>
</UpdateOTAJobResponse>

JSON格式

{
    "RequestId": "E55***B7-4***-4***-8***-D3******F565",
    "Code": 200,
    "Success": true
}