IoT Platform:CreateOTAFirmware

Parameter

Type

Required

Example

Description

Action

String

Yes

CreateOTAFirmware

The operation that you want to perform. Set the value to CreateOTAFirmware.

DestVersion

String

Yes

2.0.0

The version number of the OTA update package. The version number can contain letters, digits, periods (.), hyphens (-), and underscores (_). The version number must be 1 to 64 characters in length.

FirmwareName

String

Yes

Firmware2

The name of the OTA update package. The name must be unique within an Alibaba Cloud account. The name cannot be modified after the OTA update package is created. The name must be 1 to 40 characters in length, and can contain letters, digits, hyphens (-), underscores (_), and parentheses (). The name must start with a letter or a digit.

IotInstanceId

String

No

iot-cn-0pp1n8t****

The instance ID. You can view the instance ID on the Overview page in the IoT Platform console.

FirmwareUrl

String

No

https://iotx-ota.oss-cn-shanghai.aliyuncs.com/ota/bcd6142594d0183a16d825ad8225****/A6B3400B70CA4D6D872160D1A91A****.bin

The URL of the file that you want to add to the OTA update package. This parameter specifies the storage location of the file in OSS. You can call the GenerateOTAUploadURL operation to generate the URL of the file.

FirmwareSign

String

No

93230c3bde425a9d7984a594ac55****

The signature value of the file that you want to add to the OTA update package. The signature value is calculated by using a specific signature algorithm, such as the Secure Hash Algorithm 256 (SHA-256) or MD5 algorithm, to sign the file.

SignMethod

String

No

MD5

The signature algorithm of the file that you want to add to the OTA update package. Valid values:

• MD5 (default)

• SHA256

FirmwareSize

Integer

No

900

The size of the file that you want to add to the OTA update package. Unit: bytes.

ProductKey

String

No

a1uctKe****

The ProductKey of the product to which the OTA update package belongs.

FirmwareDesc

String

No

OTA function updated

The description of the OTA update package. The description can be up to 100 characters in length.

Type

Integer

No

0

The type of the OTA update package. Valid values:

• 0: The uploaded file contains a full update package. IoT Platform pushes the full update package to a device for update.

• 1: The uploaded file contains only the differences between the latest update package and the previous update package. IoT Platform pushes only the differences to a device for update.

Default value: 0.

SrcVersion

String

No

1.0.0

The version number of the OTA module of the device to be updated.

You can call the QueryDeviceDetail operation and view the value of FirmwareVersion in the response.

ModuleName

String

No

WifiConfigModify

The name of the OTA module. OTA modules are the updatable units of devices that belong to the same product.

NeedToVerify

Boolean

No

true

Specifies whether to verify the OTA update package before you create a batch update task. Valid values:

• true (default)

• false

Udi

String

No

{"ota_notice":"Update the underlying camera driver to resolve the issue of blurry images in videos."}

The custom information that you want to send to a device. The format of the custom information has no limits. However, the information cannot exceed 4,096 characters in length.

After you create the OTA update package and create an update task, IoT Platform sends the custom information to the specified device when IoT Platform pushes an update notification.

MultiFiles.N.Name

String

No

Firmware1

The name of the file that you want to add to the OTA update package. The name must be 1 to 32 characters in length. You can specify up to 20 file names. Each name must be unique in the OTA update package.

MultiFiles.N.Size

Integer

No

200

The size of the file that you want to add to the OTA update package. Unit: bytes.

MultiFiles.N.Url

String

No

https://iotx-ota.oss-cn-shanghai.aliyuncs.com/ota/bcd6142594d0183a16d825ad8225****/A6B3400B70CA4D6D872160D1A91A****.bin

The URL of the file that you want to add to the OTA update package. This parameter specifies the storage location of the file in OSS. You can call the GenerateOTAUploadURL operation to generate a URL for each file that you want to add to the OTA update package.

MultiFiles.N.SignValue

String

No

93230c3bde425a9d7984a594ac45****

The signature value of the file that you want to add to the OTA update package. The signature value is calculated by using a specific signature algorithm to sign the file.

MultiFiles.N.FileMd5

String

No

93230c3bde425a9d7984a594ac56***

The MD5 value of the file that you want to add to the OTA update package.

Parameter

Type

Example

Description

Code

String

iot.system.SystemException

The error code returned if the request failed. For more information, see Error codes.

Data

Struct

The OTA update package information returned if the request was successful. For more information, see the following parameters.

FirmwareId

String

s8SSHiKjpBfrM3BSN0z803****

The ID of the OTA update package. The ID is a unique identifier issued by IoT Platform to the OTA update package.

UtcCreate

String

2019-11-04T06:21:54.607Z

The time when the OTA update package was created. The time is displayed in Coordinated Universal Time (UTC).

ErrorMessage

String

A system exception occurred.

The error message returned if the request failed.

RequestId

String

291438BA-6E10-4C4C-B761-243B9A0D324F

The request ID.

Success

Boolean

true

Indicates whether the request was successful. Valid values:

• true

• false