すべてのプロダクト
Search

このプロダクト

    IoT Platform:BatchRegisterDevice

    ドキュメントセンター

    IoT Platform:BatchRegisterDevice

    最終更新日:Apr 17, 2025

    プロダクトに複数のデバイスを登録します。これらのデバイスの DeviceName はランダムに生成されます。

    使用方法

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

    • ランダムな DeviceName を生成する場合は、BatchRegisterDevice 操作を呼び出します。

      デバイスを登録して結果を表示するには、次の手順を実行します。

      1. BatchRegisterDevice 操作を呼び出して、複数のデバイスを登録します。応答が成功した場合は、登録リクエストが送信されたことを示します。実際の登録プロセスは非同期で実装され、数分かかります。

      2. QueryBatchRegisterDeviceStatus 操作を呼び出して、デバイスの登録結果をクエリします。

      3. QueryPageByApplyId 操作を呼び出して、登録済みデバイスの詳細を表示します。詳細には、DeviceName、DeviceSecret、IotId パラメーターが含まれます。

    • カスタム DeviceName を指定する場合は、BatchRegisterDeviceWithApplyId 操作を呼び出します。詳細については、「BatchRegisterDeviceWithApplyId」をご参照ください。

    制限

    • 1 回の呼び出しで最大 10,000 台のデバイスを作成できます。
    • Alibaba Cloud アカウントごとに、最大 10 クエリ/秒（QPS）を実行できます。
      説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

    デバッグ

    Alibaba Cloud は、API の使用を簡素化するために OpenAPI Explorer を提供しています。OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

    リクエストパラメーター

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

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

    CountIntegerはい100

    登録するデバイスの数。

    説明 1 回の呼び出しで最大 10,000 台のデバイスを登録できます。
    ProductKeyStringはいa1BwAGV****

    デバイスが属するプロダクトの ProductKey。

    IotInstanceIdStringいいえiot_instc_pu****_c*-v64********

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

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

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

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

    レスポンスパラメーター

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

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

    DataStruct

    呼び出しが成功した場合に返されるデータ。

    ApplyIdLong1295006

    呼び出しが成功した場合にリクエストに対して返されるアプリケーション ID（ApplyId）。

    ErrorMessageStringシステム例外が発生しました。

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

    RequestIdStringE55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

    リクエストの ID。

    SuccessBooleantrue

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

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

    例

    リクエストの例

    https://iot.cn-shanghai.aliyuncs.com/?Action=BatchRegisterDevice
&ProductKey=a1BwAGV****
&Count=10
&<共通リクエストパラメーター>

    成功レスポンスの例

    XML 形式

    <BatchRegisterDeviceResponse>
  <Data>
        <ApplyId>12345678</ApplyId>
  </Data>
  <RequestId>92C67DC1-41B5-45F8-9AFD-1FB42448D405</RequestId>
  <Success>true</Success>
</BatchRegisterDeviceResponse>

    JSON 形式

    {
    "Data": {
        "ApplyId": 12345678
    },
    "RequestId": "92C67DC1-41B5-45F8-9AFD-1FB42448D405",
    "Success": true
}

    エラーコード

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