すべてのプロダクト
Search

このプロダクト

    IoT Platform:BatchCheckImportDevice

    ドキュメントセンター

    IoT Platform:BatchCheckImportDevice

    最終更新日:Apr 17, 2025

    Standard Enterprise Edition インスタンスまたは MQTT クラウドゲートウェイ プロダクトに追加される複数のデバイスを一度に検証します。

    QPS 制限

    この操作は、アカウントごとに 1 秒あたり最大 100 回呼び出すことができます。

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

    デバッグ

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

    リクエストパラメーター

    パラメーター

    タイプ

    必須

    例

    詳細
    Action String Yes BatchCheckImportDevice

    実行する操作。値を BatchCheckImportDevice に設定します。
    ProductKey String Yes a1BwAGV****

    追加するデバイスが属するプロダクトの ProductKey。
    DeviceList.N.DeviceName String Yes light

    デバイスの DeviceName。

    DeviceName は 4 ～ 32 文字で、文字、数字、ハイフン（-）、アンダースコア（_）、アットマーク（@）、ピリオド（.）、コロン（:）を含めることができます。

    DeviceName はプロダクト内で一意である必要があります。

    説明 1 回の呼び出しで最大 10,000 個の DeviceName を指定できます。 DeviceName の数が制限を超えると、超過した DeviceName は破棄されます。
    DeviceList.N.DeviceSecret String Yes b4d43f7******10ba5e5

    デバイスの DeviceSecret。

    DeviceSecret は 1 ～ 32 文字で、文字、数字、ハイフン（-）、アンダースコア（_）、アットマーク（@）、ピリオド（.）、コロン（:）を含めることができます。

    説明 1 回の呼び出しで最大 10,000 個の DeviceSecret を指定できます。 DeviceSecret の数が制限を超えると、超過した DeviceSecret は破棄されます。
    DeviceList.N.Sn String No QC4******001

    デバイスのシリアル番号（SN）。

    SN は 1 ～ 64 文字で、文字、数字、アンダースコア（_）を含めることができます。

    説明 1 回の呼び出しで最大 10,000 個の SN を指定できます。 SN の数が制限を超えると、超過した SN は破棄されます。
    IotInstanceId String No iot-1n8t****

    インスタンスの ID。インスタンスの ID は、IoT Platform コンソールの [概要] タブで取得できます。

    重要
    • インスタンスに ID がある場合は、このパラメーターに ID を指定する必要があります。指定しないと、呼び出しは失敗します。
    • インスタンスに [概要] タブまたは ID が生成されていない場合は、このパラメーターを設定する必要はありません。

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

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

    レスポンスパラメーター

    パラメーター

    タイプ

    例

    詳細
    Code String iot.system.SystemException

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

    呼び出しが成功した場合に返されるデータ。 データには、検証に失敗したデバイスに関する情報が含まれています。
    InvalidDetailList InvalidDetailList の配列

    無効なデバイス。
    DeviceName String light%

    デバイスの DeviceName。
    DeviceSecret String ^67$

    デバイスのシークレット。
    ErrorMsg String The device name is illegal.

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

    デバイスの SN。
    InvalidDeviceNameList List { "InvalidDeviceNameList": [ "APT$", "aw" ] }

    呼び出しが失敗した場合に返される無効な DeviceName。
    InvalidDeviceSecretList List { "InvalidDeviceSecretList": [ "^67$", "1" ] }

    呼び出しが失敗した場合に返される無効な DeviceSecret。
    InvalidSnList List { "InvalidSnList": [ "" ] }

    呼び出しが失敗した場合に返される無効なデバイス SN。
    RepeatedDeviceNameList List { "RepeatedDeviceNameList": [ "abcd", "asdf" ] }

    呼び出しが失敗した場合に返される重複した DeviceName。
    ErrorMessage String A system exception occurred.

    呼び出しが失敗した場合に返されるエラーメッセージ。
    RequestId String E4C0FF92-2A86-41DB-92D3-73B60310D25E

    リクエストの ID。
    Success Boolean true

    呼び出しが成功したかどうかを示します。有効な値：

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

    例

    リクエストの例

    http(s)://iot.cn-shanghai.aliyuncs.com/?Action=BatchCheckImportDevice
&DeviceList.1.DeviceName=device1
&DeviceList.2.DeviceName=device2
&DeviceList.1.DeviceSecret=b4d43f7******10ba5e5
&DeviceList.2.DeviceSecret=912179******700210b4
&ProductKey=a1BwAGV****
&IotInstanceId=iot-1n8t****
&<共通リクエストパラメーター>

    成功レスポンスの例

    XML 形式

    <BatchCheckImportDeviceResponse>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Success>true</Success>
</BatchCheckImportDeviceResponse>

    JSON 形式

    {
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Success": true
}

    エラーコード

    HttpCode

    エラーコード

    エラーメッセージ

    説明
    400 iot.device.TooManyDeviceNamesPerRequest The devices you query exceed the maximum number. リクエストで指定した DeviceName の数が制限を超えています。
    400 iot.device.NoneDeviceNameElement The DeviceName list is empty. DeviceName が指定されていません。
    400 iot.device.InvalidDeviceParams The request parameters are invalid. リクエストパラメーターの値が無効です。

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