CreateOTAFirmware_物联网平台_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.

接口说明

使用说明

在调用此接口创建升级包前,已调用 GenerateOTAUploadURL 生成升级包上传信息,并已调用 OSS PostObject 接口上传了升级包文件。

使用限制

单个阿里云账号下最多可有 500 个升级包。

QPS 限制

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

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

流控信息

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

授权信息

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

具体说明如下:展开详情

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

请求参数

字段名称字段详情
IotInstanceIdstring

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

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

OTA 升级包名称,需在阿里云账号下唯一,创建后不可修改。支持中文、英文字母、日文、数字、短划线(-)、下划线(_)和半角圆括号(()),必须以中文、英文、日文或数字开头,长度限制为 1~40 个字符。

示例值:Firmware2参考取值来源:
    QueryOTAFirmware
    ListOTAFirmware
DestVersionstring

当前 OTA 升级包的版本号,仅支持英文字母、数字、半角句号(.)、短划线(-)和下划线(_)。长度限制为 1~64 个字符。

示例值:2.0.0
FirmwareUrlstring

OTA 升级包文件的 URL,即升级包文件在对象存储(OSS)上的存储地址。您可调用 GenerateOTAUploadURL 生成升级包文件的 URL。展开详情

示例值:https://iotx-ota.oss-cn-shanghai.aliyuncs.com/ota/bcd6142594d0183a16d825ad8225****/A6B3400B70CA4D6D872160D1A91A****.bin参考取值来源:
    QueryOTAFirmware
FirmwareSignstring

OTA 升级包文件的签名值。使用 SignMethod 对升级包文件内容加签计算得出的值。展开详情

示例值:93230c3bde425a9d7984a594ac55****参考取值来源:
    ListOTAFirmware
    QueryOTAFirmware
SignMethodstring

OTA 升级包签名方法。目前仅支持取值为 MD5(MD5 签名)。展开详情

示例值:MD5
FirmwareSizeinteger<int32>

OTA 升级包文件的大小,单位:字节。展开详情

示例值:900
ProductKeystring

OTA 升级包所属产品的 ProductKey

示例值:a1uctKe****参考取值来源:
    CreateProduct
    QueryProductList
    ReleaseProduct
    ListProductByTags
    BindLicenseProduct
    BatchBindProductsIntoProject
FirmwareDescstring

OTA 升级包描述。长度不可超过 100 个字符。一个中文汉字算一个字符。

示例值:OTA function updated参考取值来源:
    ListOTAFirmware
    QueryOTAFirmware
Typeinteger<int32>

OTA 升级包类型。可选:展开详情

示例值:0
SrcVersionstring

待升级 OTA 模块版本号,即待升级设备的当前 OTA 模块版本号。展开详情

示例值:1.0.0
ModuleNamestring

OTA 模块名称。OTA 模块是同产品下设备的不同可升级模块。展开详情

示例值:WifiConfigModify参考取值来源:
    CreateOTAModule
NeedToVerifyboolean

是否需要在创建批量升级任务前通过升级包验证。展开详情

示例值:true
Udistring

推送给设备的自定义信息。不限制文本内容格式,长度不超过 4096 个字符。展开详情

示例值:{"ota_notice":"升级底层摄像头驱动,解决视频图像模糊的问题。"}
MultiFilesarray<object>

OTA 升级包文件列表信息。

子级条数 <= 21

请求说明

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

返回参数

字段名称字段详情
Codestring

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

示例值:iot.system.SystemException
ErrorMessagestring

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

示例值:系统异常
RequestIdstring

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

示例值:291438BA-6E10-4C4C-B761-243B9A0D324F
Successboolean

是否调用成功。展开详情

示例值:true
Dataobject

调用成功时,返回的升级包信息。更多信息,请参见 Data 下参数描述。

返回示例

变更历史

暂无变更历史

相关示例

物联网平台/监控运维/OTA升级/升级包管理
2022-03-24