BatchRegisterDeviceWithApplyId - IoT Platform - Alibaba Cloud ドキュメントセンター

アプリケーション ID を使用して一度に複数のデバイスを登録します。

使用方法

次のいずれかの方法を使用して、一度に複数のデバイスを登録できます。

BatchRegisterDevice 操作を呼び出して、ランダムな DeviceName を生成します。
BatchRegisterDeviceWithApplyId 操作と BatchCheckDeviceNames 操作を呼び出して、カスタム DeviceName を指定します。手順：

BatchCheckDeviceNames 操作を呼び出し、登録するデバイスの名前を指定します。DeviceName が有効な場合、IoT Platform は ApplyId パラメーターで指定されたアプリケーション ID を返します。ApplyId を使用して、DeviceName の設定結果、デバイスの登録結果、およびデバイスの詳細を照会できます。

QueryBatchRegisterDeviceStatus 操作を呼び出して、名前設定結果を照会します。

BatchRegisterDeviceWithApplyId 操作を呼び出して、複数のデバイスを登録します。この操作によって返される成功結果は、バッチ登録リクエストが送信されたことのみを示します。実際のシナリオでは、登録プロセスには数分かかります。

オプション。 QueryBatchRegisterDeviceStatus 操作を呼び出して、デバイスの登録結果を照会します。

QueryPageByApplyId 操作を呼び出して、バッチで登録されたデバイスの詳細を表示します。

QPS 制限

各 Alibaba Cloud アカウントは、最大 500 クエリ/秒（QPS）を実行できます。

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

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	BatchRegisterDeviceWithApplyId	実行する操作。値を BatchRegisterDeviceWithApplyId に設定します。
ApplyId	Long	はい	1295006	アプリケーションの ID。BatchCheckDeviceNames 操作によってアプリケーション ID が返されます。
ProductKey	String	はい	a1BwAGV****	デバイスが属するプロダクトの ProductKey。
IotInstanceId	String	いいえ	iot_instc_pu***_c-v64********	インスタンスの ID。IoT Platform コンソールの概要ページでインスタンスの ID を表示できます。重要インスタンスに ID がある場合は、このパラメーターに ID を指定する必要があります。指定しないと、呼び出しは失敗します。インスタンスに対して概要ページまたは ID が生成されない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	Struct		呼び出しが成功した場合に返されるデータ。詳細については、以下のパラメーターを参照してください。
ApplyId	Long	1295006	アプリケーション ID。
ErrorMessage	String	システム例外が発生しました。	リクエストが失敗した場合に返されるエラーメッセージ。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=BatchRegisterDeviceWithApplyId
&ProductKey=alNdd3i****
&ApplyId=1234567
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<BatchRegisterDeviceWithApplyIdResponse>
  <Data>
        <ApplyId>1234567</ApplyId>
  </Data>
  <RequestId>82C16DC1-41B5-45F8-9AFD-1FB42448D405</RequestId>
  <Success>true</Success>
</BatchRegisterDeviceWithApplyIdResponse>

JSON 形式

{
	"Data": {
		"ApplyId": 1234567
	},
	"RequestId": "82C16DC1-41B5-45F8-9AFD-1FB42448D405",
	"Success": true
}

エラーコード

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