UpdateOTAModule の呼び出し - OTA モジュールのエイリアスと説明文の変更 - IoT Platform

OTA モジュールのエイリアスと説明を変更します。

制限

Alibaba Cloud アカウントごとに、最大 10 クエリ/秒（QPS）を実行できます。

説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	UpdateOTAModule	実行する操作。値を UpdateOTAModule に設定します。
ModuleName	String	はい	barcodeScanner	OTA モジュールの名前。
ProductKey	String	はい	a1Le6d0****	OTA モジュールが属するプロダクトの ProductKey。
AliasName	String	いいえ	Barcode_scanner_2	OTA モジュールの新しいエイリアス。エイリアスは 1 ～ 64 文字で、文字、数字、ピリオド(.)、ハイフン (-)、アンダースコア (_) を使用できます。
IotInstanceId	String	いいえ	iot-cn-0pp1n8t****	インスタンスの ID。インスタンス ID は、IoT Platform コンソールの概要ページで確認できます。重要インスタンスに ID がある場合は、このパラメーターを設定する必要があります。このパラメーターを設定しないと、呼び出しは失敗します。インスタンスに概要ページまたは ID がない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。
Desc	String	いいえ	The firmware module of the barcode scanner.	OTA モジュールの新しい説明。説明は最大 100 文字まで入力できます。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
ErrorMessage	String	A system exception occurred.	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	74C2BB8D-1D6F-41F5-AE68-6B2310883F63	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

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

成功レスポンスの例

XML 形式

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

JSON 形式

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

エラーコード

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