CreateOTADynamicUpgradeJob_物联网平台_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

使用说明

  • 若未在调用 CreateOTAFirmware 创建升级包时指定升级包无需验证,则调用本接口创建批量升级批次前,必须保证升级包已验证成功。创建验证升级包任务,请参见 CreateOTAVerifyJob
  • 同一设备只能同时在一个升级批次中处于待升级或正在升级状态。对处于待升级或正在升级状态的设备发起新的升级任务,后发起的任务会直接失败。
  • 同一升级包下,只能有一个状态为执行中的动态升级批次。
  • 如果同一个设备处于不同升级包的动态升级策略中,则设备执行最新发起的动态升级。
  • 创建动态升级批次后,系统将自动创建对应的动态升级策略。可以调用 CancelOTAStrategyByJob 取消动态升级策略。
  • 目前仅华东 2(上海)地域下,企业版实例和新版公共实例,支持创建动态分组的动态升级批次。实例详细说明,请参见实例管理
  • 目前仅中国的华东 2(上海)、华北 2(北京)和华南 1(深圳)地域下,支持使用 MQTT 协议下载升级包。

QPS 限制

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

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

流控信息

请求速率为10/1(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
iot:CreateOTADynamicUpgradeJob
Create
全部资源
*

请求参数

字段名称字段详情
IotInstanceIdstring

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

示例值:iot-cn-0pp1n8t****
FirmwareIdstring

升级包 ID,升级包的唯一标识符。展开详情

示例值:nx3xxVvFdwvn6dim50PY03****参考取值来源:
    ListOTAFirmware
    CreateOTAFirmware
ProductKeystring

升级包所属产品的 ProductKey

示例值:a1Le6d0****参考取值来源:
    CreateProduct
    QueryProductList
    ReleaseProduct
    ListProductByTags
    BindLicenseProduct
    BatchBindProductsIntoProject
RetryIntervalinteger<int32>

设备升级失败后,自动重试的时间间隔,单位为分钟。可选值:展开详情

示例值:60
RetryCountinteger<int32>

自动重试次数。展开详情

示例值:1
TimeoutInMinutesinteger<int32>

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

示例值:1440
MaximumPerMinuteinteger<int32>

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

示例值:1000
OverwriteModeinteger<int32>

是否覆盖之前的升级任务。取值:展开详情

示例值:2
DynamicModeinteger<int32>

动态升级模式。取值范围:展开详情

示例值:1
NeedPushboolean

物联网平台是否主动向设备推送升级任务。展开详情

示例值:true
NeedConfirmboolean

如需自主控制设备 OTA 升级时,可配置此参数,通过手机 App 来控制,设备是否可进行 OTA 升级。手机 App 需您自行开发。展开详情

示例值:false
GroupIdstring

分组 ID。展开详情

示例值:IwOwQj7DJ***参考取值来源:
    CreateDeviceGroup
GroupTypestring

分组类型,仅可取值LINK_PLATFORM_DYNAMIC(动态分组)。展开详情

示例值:LINK_PLATFORM_DYNAMIC参考取值来源:
    QueryDeviceGroupList
DownloadProtocolstring

升级包下载协议,可选:HTTPS(默认)或 MQTT。设备端收到物联网平台推送的升级包下载信息后,通过该协议下载升级包。展开详情

示例值:HTTPS
MultiModuleModeboolean

设备是否支持多模块同时升级。展开详情

示例值:false
SrcVersionarray<string>

待升级版本号列表。展开详情

示例值:V1.0.1子级条数 <= 50
Tagarray<object>

标签列表。

子级条数 <= 10

请求说明

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

返回参数

字段名称字段详情
Codestring

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

示例值:iot.system.SystemException
ErrorMessagestring

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

示例值:系统异常
RequestIdstring

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

示例值:9F41D14E-CB5F-4CCE-939C-057F39E688F5
Successboolean

表示是否调用成功。展开详情

示例值:true
Dataobject

调用成功时,返回的升级批次信息。详情见以下 Data 包含的参数。

返回示例

变更历史

暂无变更历史