调用该接口修改升级包信息，包括升级包名称、升级包描述和自定义信息。

QPS限制

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

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

调试

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

请求参数

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

系统规定参数。取值：ModifyOTAFirmware。
FirmwareId String 是 s8SSHiKjpBfrM3BSN0z803****

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

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

您也可以调用接口ListOTAFirmware，从返回参数中查看。
ProductKey String 是 a1uctKe****

OTA升级包所属产品的ProductKey。
FirmwareDesc String 否 OTA function updated

OTA升级包描述。长度不可超过100个字符。一个中文汉字算一个字符。
IotInstanceId String 否 iot-0pp1n8t****

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

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

实例的更多信息，请参见实例概述。
FirmwareName String 否 Firmwaretest

OTA升级包名称，需在阿里云账号下唯一。支持中文、英文字母、日文、数字、短划线（-）、下划线（_）和半角圆括号（()），必须以中文、英文、日文或数字开头，长度限制为1~40个字符。
FirmwareUdi String 否 {"ota_notice":"升级底层摄像头驱动，解决视频图像模糊的问题。"}

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

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

返回数据

名称 类型 示例值 描述
Code String iot.ota.FirmwareNotFound

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

调用失败时，返回的出错信息。
RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

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

是否调用成功。

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

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=ModifyOTAFirmware
&FirmwareUid=s8SSHiKjpBfrM3BSN0z803****
&ProductKey=a1uctKe****
&FirmwareName=Firmwaretest
&IotInstanceId=iot-0pp1n8t****
&<公共请求参数>

正常返回示例

XML格式

<ModifyOTAFirmwareResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Success>true</Success>
</ModifyOTAFirmwareResponse>

JSON格式

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Success": true
}

错误码

HttpCode 错误码 错误信息 描述
400 iot.firmware.AlreadyExistedFirmwareName The OTA update package already exists. 同名的OTA升级包已经存在。
400 iot.ota.FirmwareNotFound The specified firmware does not exist. 指定的升级包不存在。
400 iot.ota.FirmwareAndProductKeyMismatch The OTA update package is not consistent with the ProductKey. OTA升级包与产品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. OTA升级包名称格式错误。
400 iot.ota.InstanceIdMisMatch The instanceId is invalid. 实例ID不匹配。

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