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

接口说明

QPS 限制

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

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

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

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
暂无数据

请求参数

字段名称字段详情
ProductKeystring

OTA 升级包所属产品的 ProductKey

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

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

示例值:s8SSHiKjpBfrM3BSN0z803****参考取值来源:
    ListOTAFirmware
    CreateOTAFirmware
FirmwareDescstring

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

示例值:OTA function updated参考取值来源:
    ListOTAFirmware
    QueryOTAFirmware
IotInstanceIdstring

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

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

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

示例值:Firmwaretest参考取值来源:
    CreateOTAFirmware
    QueryOTAFirmware
    ListOTAFirmware
FirmwareUdistring

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

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

请求说明

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

返回参数

字段名称字段详情
Codestring

调用失败时,返回错误码。详细信息,请参见下文错误码

示例值:iot.ota.FirmwareNotFound
ErrorMessagestring

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

示例值:The specified firmware does not exist.
RequestIdstring

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

示例值:E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565
Successboolean

是否调用成功。展开详情

示例值:true

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
iot.firmware.AlreadyExistedFirmwareName
The OTA update package already exists.诊断
400
iot.ota.FirmwareNotFound
The specified firmware does not exist.诊断
400
iot.ota.FirmwareAndProductKeyMismatch
The OTA update package is not consistent with the ProductKey.诊断
400
iot.ota.TenantIdMisMatch
The tenantId is invalid.诊断
400
iot.firmware.FirmwareUdiExceedLimit
The UDI of the firmware is longer than the limit.诊断
400
iot.firmware.FirmwareDescExceedLimit
The description of the firmware is longer than the limit.诊断
400
iot.firmware.IncorrectFormattedFirmwareName
The format of the OTA update package name is invalid.诊断
400
iot.ota.InstanceIdMisMatch
The instanceId is invalid.诊断

变更历史

暂无变更历史

相关示例