すべてのプロダクト
Search
ドキュメントセンター

IoT Platform:CreateOTAFirmware

最終更新日:Apr 17, 2025

デバイスの Over-The-Air(OTA)アップデートパッケージを、OTA アップデートパッケージに追加する各ファイルの URL を生成した後に作成します。

使用方法

このオペレーションを呼び出して OTA アップデートパッケージを作成する前に、GenerateOTAUploadURL オペレーションを呼び出して、OTA アップデートパッケージに追加するファイルの情報を生成し、Object Storage Service(OSS)の PostObject オペレーションを呼び出してファイルをアップロードする必要があります。

制限

1 つのインスタンス内で最大 500 個のアップデートパッケージを作成できます。

QPS 制限

アカウントごとに、1 秒あたり最大 10 回までこのオペレーションを呼び出すことができます。

説明

Alibaba Cloud アカウントの Resource Access Management(RAM)ユーザーは、アカウントのクォータを共有します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこのオペレーションを呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK 用のオペレーションのサンプルコードを動的に生成します。

リクエストパラメータ

パラメータ

タイプ

必須

説明

Action

String

はい

CreateOTAFirmware

実行するオペレーション。値を CreateOTAFirmware に設定します。

DestVersion

String

はい

2.0.0

OTA アップデートパッケージのバージョン番号。バージョン番号には、文字、数字、ピリオド(.)、ハイフン(-)、アンダースコア(_)を含めることができます。バージョン番号は 1 ~ 64 文字の長さでなければなりません。

FirmwareName

String

はい

Firmware2

OTA アップデートパッケージの名前。名前は Alibaba Cloud アカウント内で一意である必要があります。 OTA アップデートパッケージの作成後、名前を変更することはできません。名前は 1 ~ 40 文字の長さで、文字、数字、ハイフン(-)、アンダースコア(_)、括弧()を含めることができます。名前は文字または数字で始まる必要があります。

IotInstanceId

String

いいえ

iot-cn-0pp1n8t****

インスタンス ID。 インスタンス ID は、IoT Platform コンソールの 概要 ページで確認できます。

重要
  • インスタンスに ID がある場合は、このパラメータを指定する必要があります。指定しない場合、リクエストは失敗します。

  • IoT Platform コンソールに 概要 ページまたは インスタンス ID が表示されない場合は、このパラメータを指定する必要はありません。

FirmwareUrl

String

いいえ

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

OTA アップデートパッケージに追加するファイルの URL。このパラメータは、OSS 内のファイルの格納場所を指定します。 GenerateOTAUploadURL オペレーションを呼び出して、ファイルの URL を生成できます。

重要

OTA アップデートパッケージに 1 つのファイルのみを追加する場合、このパラメータを指定する必要があります。

FirmwareSign

String

いいえ

93230c3bde425a9d7984a594ac55****

OTA アップデートパッケージに追加するファイルの署名値。署名値は、特定の 署名アルゴリズム(Secure Hash Algorithm 256(SHA-256)や MD5 アルゴリズムなど)を使用してファイルを署名することで計算されます。SHA-256MD5

重要

OTA アップデートパッケージに 1 つのファイルのみを追加する場合、このパラメータを指定できます。このパラメータを指定しない場合、OSS 内のファイルの MD5 値が使用されます。

SignMethod

String

いいえ

MD5

OTA アップデートパッケージに追加するファイルの署名アルゴリズム。有効な値:

  • MD5(デフォルト)

  • SHA256

FirmwareSize

Integer

いいえ

900

OTA アップデートパッケージに追加するファイルのサイズ。単位:バイト。

重要

OTA アップデート パッケージに 1 つのファイルのみを追加する場合、このパラメーターを指定できます。 このパラメーターを指定しない場合、OSS 内のファイルのサイズが使用されます。

ProductKey

String

いいえ

a1uctKe****

OTA アップデートパッケージが属するプロダクトの ProductKey です。

FirmwareDesc

String

いいえ

OTA 関数が更新されました

OTA アップデート パッケージの説明です。説明は最大 100 文字です。

タイプ

整数

いいえ

0

ファームウェアアップデート パッケージのタイプ。有効な値:

  • 0: アップロードされたファイルには、フルアップデート パッケージが含まれています。IoT Platform は、アップデートのためにデバイスにフルアップデート パッケージをプッシュします。

  • 1: アップロードされたファイルには、最新のアップデート パッケージと以前のアップデート パッケージの差分のみが含まれています。IoT Platform は、アップデートのために差分のみをデバイスにプッシュします。

デフォルト値: 0

ソースバージョン

文字列

いいえ

1.0.0

更新対象デバイスの OTA モジュールのバージョン番号です。

QueryDeviceDetail 操作を呼び出し、応答の [FirmwareVersion] の値を確認できます。

説明
  • [Type]1 に設定した場合、このパラメーターを指定する必要があり、このパラメーターの値は [DestVersion] の値と同じにすることはできません。

  • [Type]0 に設定した場合、このパラメーターを指定する必要はありません。

モジュール名

文字列

いいえ

WifiConfigModify

OTA モジュールの名前です。OTA モジュールは、同じプロダクトに属するデバイスの更新可能な単位です。

説明
  • このパラメーターを指定しない場合は、デフォルトの OTA モジュールが使用されます。デフォルト値は、デバイス ファームウェア全体が更新されることを示します。

  • CreateOTAModule 操作を呼び出して、カスタム OTA モジュールを作成できます。 ListOTAModuleByProduct 操作を呼び出して、プロダクトの既存の OTA モジュールをクエリできます。

確認が必要

ブール値

いいえ

true

一括更新タスクを作成する前に、ファームウェアアップデートパッケージの検証を行うかどうかを指定します。有効な値:

  • true (デフォルト)

  • false

Udi

String

いいえ

{"ota_notice":"ビデオ内の画像のぼやけの問題を解決するために、基盤となるカメラ ドライバーを更新します。"}

デバイスに送信するカスタム情報。カスタム情報のフォーマットに制限はありません。ただし、情報は 4,096 文字を超えることはできません。

ファームウェアアップデート パッケージを作成し、アップデート タスクを作成すると、IoT Platform はアップデート通知をプッシュするときに指定されたデバイスにカスタム情報を送信します。

MultiFiles.N.Name

String

いいえ

Firmware1

ファームウェアアップデート パッケージに追加するファイルの名前。名前は 1 ~ 32 文字である必要があります。最大 20 個のファイル名を指定できます。各名前は、ファームウェアアップデート パッケージ内で一意である必要があります。

重要

ファームウェアアップデート パッケージに複数のファイルを追加する場合、このパラメーターを指定する必要があります。

MultiFiles.N.Size

Integer

いいえ

200

ファームウェアアップデート パッケージに追加するファイルのサイズです。単位:バイト。

説明

ファームウェアアップデート パッケージに複数のファイルを追加する場合、このパラメーターを指定できます。このパラメーターを指定しない場合は、OSS 内のファイルのサイズが使用されます。

MultiFiles.N.Url

String

いいえ

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

ファームウェアアップデート パッケージに追加するファイルの URL です。このパラメーターは、OSS でのファイルのストレージ場所を指定します。ファームウェアアップデート パッケージに追加するファイルごとに URL を生成するには、GenerateOTAUploadURL 操作を呼び出すことができます。

重要

ファームウェアアップデート パッケージに複数のファイルを追加する場合、このパラメーターを指定する必要があります。

MultiFiles.N.SignValue

String

いいえ

93230c3bde425a9d7984a594ac45****

ファームウェアアップデート パッケージに追加するファイルの署名値。 署名値は、特定の 署名アルゴリズム を使用してファイルを署名することで計算されます。

説明

ファームウェアアップデート パッケージに複数のファイルを追加する場合、このパラメーターを指定できます。 このパラメーターを指定しない場合、OSS 内のファイルの MD5 値が使用されます。

MultiFiles.N.FileMd5

String

いいえ

93230c3bde425a9d7984a594ac56***

ファームウェアアップデート パッケージに追加するファイルの MD5 値です。

説明

ファームウェアアップデート パッケージに複数のファイルを追加する場合、このパラメーターを指定できます。 このパラメーターを指定しない場合、OSS 内のファイルの MD5 値が使用されます。

上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは、共通のリクエストパラメーターを指定する必要があります。共通のリクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

レスポンスパラメーター

パラメーター

タイプ

説明

Code

String

iot.system.SystemException

リクエストが失敗した場合に返されるエラーコード。 詳細については、「エラーコード」をご参照ください。

Data

Struct

リクエストが成功した場合に返されるファームウェアアップデート パッケージ情報。 詳細については、以下のパラメーターをご参照ください。

FirmwareId

String

s8SSHiKjpBfrM3BSN0z803****

ファームウェアアップデート パッケージの ID。 ID は、IoT Platform がファームウェアアップデート パッケージに発行する一意の識別子です。

UtcCreate

String

2019-11-04T06:21:54.607Z

ファームウェアアップデート パッケージが作成された時刻。 時刻は協定世界時 (UTC) で表示されます。

ErrorMessage

String

A system exception occurred.

リクエストが失敗した場合に返されるエラーメッセージ。

RequestId

String

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

リクエスト ID。

Success

Boolean

true

リクエストが成功したかどうかを示します。有効な値:

  • true

  • false

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=CreateOTAFirmware
&ProductKey=a1uctKe****
&FirmwareName=Firmware2
&DestVersion=2.0.0
&FirmwareUrl=https%3A%2F%2Fiotx-ota.oss-cn-shanghai.aliyuncs.com%2Fota%2F****%2F****.bin
&SignMethod=MD5
&FirmwareSign=93230c3bde425a9d7984a594ac55****
&FirmwareSize=900
&FirmwareDesc=OTA function updated
&Type=0
&ModuleName=WifiConfigModify
&<Common request parameters>

正常なレスポンスの例

XML フォーマット

<CreateOTAFirmwareResponse>
    <Data>
        <FirmwareId>s8SSHiKjpBfrM3BSN0z803****</FirmwareId>
        <UtcCreate>2019-11-04T06:21:54.607Z</UtcCreate>
    </Data>
    <RequestId>E4BD5A12-7C1D-4712-A7D5-B2432331165E</RequestId>
    <Success>true</Success>
</CreateOTAFirmwareResponse>

JSON フォーマット

{  
  "Data": {
    "FirmwareId": "s8SSHiKjpBfrM3BSN0z803****",
    "UtcCreate": "2019-11-04T06:21:54.607Z"
  },
  "RequestId": "291438BA-6E10-4C4C-B761-243B9A0D324F",
  "Success": true
}

エラーコード

エラーコードのリストについては、「サービス エラーコード」をご参照ください。