すべてのプロダクト
Search

このプロダクト

    IoT Platform:CreateOTAModule

    ドキュメントセンター

    IoT Platform:CreateOTAModule

    最終更新日:Apr 17, 2025

    プロダクトの Over-The-Air（OTA）モジュールを作成します。

    制限

    OTA モジュールは、同じプロダクトに属するデバイスの更新可能な単位です。デフォルトモジュールは、デバイスのファームウェア全体を示します。この操作を呼び出して、カスタム OTA モジュールを作成できます。

    • プロダクトごとに最大 10 個のカスタム OTA モジュールを作成できます。
    • OTA モジュールを作成した後、その名前を変更することはできません。UpdateOTAModule 操作を呼び出して、モジュールのエイリアスと説明を変更できます。
    • 各 Alibaba Cloud アカウントは、最大 10 クエリ/秒（QPS）を実行できます。
      説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

    デバッグ

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

    リクエストパラメーター

    パラメータータイプ必須例説明
    ActionStringはいCreateOTAModule

    実行する操作。値を CreateOTAModule に設定します。

    ModuleNameStringはいbarcodeScanner

    OTA モジュールの名前。名前はプロダクト内で一意であり、変更できません。名前には、文字、数字、ピリオド（.）、ハイフン（-）、およびアンダースコア（_）を含めることができます。名前は 1 ～ 64 文字の長さでなければなりません。

    説明 文字の大文字と小文字は区別されません。たとえば、モジュール名 scanner と Scanner を同時に使用することはできません。
    ProductKeyStringはいa1Le6d0****

    OTA モジュールが属するプロダクトの ProductKey。

    AliasNameStringいいえBarcode_scanner

    OTA モジュールのエイリアス。エイリアスは 1 ～ 64 文字の長さでなければならず、文字、数字、ピリオド（.）、ハイフン（-）、およびアンダースコア（_）を含めることができます。

    IotInstanceIdStringいいえiot-cn-0pp1n8t****

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

    重要
    • インスタンスに ID がある場合は、このパラメーターを設定する必要があります。このパラメーターを設定しないと、呼び出しは失敗します。
    • インスタンスに 概要 ページまたは ID がない場合は、このパラメーターを設定する必要はありません。

    詳細については、「概要」をご参照ください。

    DescStringいいえThe firmware module of the barcode scanner.

    OTA モジュールの説明。説明は最大 100 文字まで入力できます。

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

    レスポンスパラメーター

    パラメータータイプ例説明
    CodeStringiot.system.SystemException

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

    ErrorMessageStringA system exception occurred.

    呼び出しが失敗した場合に返されるエラーメッセージ。

    RequestIdString74C2BB8D-1D6F-41F5-AE68-6B2310883F63

    リクエストの ID。

    SuccessBooleantrue

    呼び出しが成功したかどうかを示します。

    • true: 呼び出しは成功しました。
    • false: 呼び出しは失敗しました。

    例

    リクエストの例

    https://iot.cn-shanghai.aliyuncs.com/?Action=CreateOTAModule
&ModuleName=barcodeScanner
&ProductKey=a1Le6d0****
&<Common request parameters>

    成功レスポンスの例

    XML 形式

    <CreateOTAModuleResponse>
     <RequestId>29EC7245-0FA4-4BB6-B4F5-5F04818FDFB1</RequestId>
     <Success>true</Success>
</CreateOTAModuleResponse>

    JSON 形式

    {
  "RequestId": "9F41D14E-CB5F-4CCE-939C-057F39E688F5",
  "Success": true
}

    エラーコード

    エラーコードのリストについては、API エラーセンターをご覧ください。