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

複数のデバイスのデバイス登録の処理ステータスと結果をクエリします。

QPS 制限

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

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

デバッグ

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

リクエストパラメーター

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

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。説明 X.509 証明書は、中国 (上海) リージョンのデバイスでのみ使用できます。デバイスが中国 (上海) リージョンにない場合、デバイスの X.509 証明書を生成できず、iot.device.RegionNotSupportX509 エラーコードが返されます。
Data	Struct		呼び出しが成功した場合に返されるステータス情報。
InvalidDetailList	invalidDetailList の配列		Status パラメーターの戻り値が CHECK_FAILED または CREATE_FAILED の場合、一部のデバイスの作成に失敗しました。作成に失敗したデバイスの詳細は、InvalidDetailList パラメーターによって返されます。 Status パラメーターの戻り値が CHECK_SUCCESS または CREATE_SUCCESS の場合、すべてのデバイスが作成されます。この場合、失敗したデバイスの詳細は返される必要はなく、InvalidDetailList パラメーターの戻り値は空の配列になります。
invalidDetailList
DeviceName	String	light	デバイスの DeviceName。
ErrorMsg	String	ニックネームが無効です。	一部のデバイスの作成に失敗した場合に返されるエラーメッセージ。説明複数のエラーメッセージは縦棒 (\|) で区切られます。
NickName	String	キャンパスライト 1	デバイスのエイリアス。
InvalidList	List	{ "Name": ["Elec_instrument"] }	Status状態CHECK_FAILED作成失敗またはの場合、一部のデバイスの作成に失敗しました。作成に失敗したデバイスの DeviceName は、InvalidList パラメーターによって返されます。 Status パラメーターの戻り値が CHECK_SUCCESS または CREATE_SUCCESS の場合、すべてのデバイスが作成されます。この場合、DeviceName は返される必要はなく、InvalidList パラメーターの戻り値は空の配列になります。
Status	String	CREATE_SUCCESS	処理ステータスと結果。有効な値： CHECK: システムはデバイス名を確認しています。 CHECK_SUCCESS: アプリケーションフォームのすべてのデバイスが確認されました。 CHECK_FAILED: アプリケーションフォームのすべてのデバイスの確認に失敗しました。 CREATE: システムはデバイスを作成しています。 CREATE_SUCCESS: アプリケーションフォームのすべてのデバイスが作成されました。説明デバイスが属するプロダクトの認証タイプが X.509 の場合、すべてのデバイスと関連する X.509 証明書が作成されます。 CREATE_FAILED: アプリケーションフォームの一部のデバイスの作成に失敗しました。説明認証タイプが X.509 の場合、現在のバッチでデバイスまたは X.509 証明書の作成に失敗すると、すべてのデバイスの作成に失敗します。
ValidList	List	{ "Name": ["light3"] }	Status状態パラメーターの値が CHECK_FAILED またはの場合、一部のデバイスの作成に失敗しました。作成されたデバイスの DeviceName は、ValidList パラメーターによって返されます。 Status パラメーターの値が CHECK_SUCCESSCHECK_SUCCESS またはの場合、すべてのデバイスが作成されます。この場合、DeviceName は返される必要はなく、ValidList パラメーターの戻り値は空の配列になります。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。有効な値： true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

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

成功レスポンスの例

XML 形式

<QueryBatchCheckDeviceNamesStatusResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <Status>CREATE_SUCCESS</Status>
        <InvalidDetailList>
              <invalidDetailList>
                    <ErrorMsg>ニックネームが無効です。 | ニックネームが無効です。</ErrorMsg>
                    <NickName>キャンパスライト 1</NickName>
                    <DeviceName>Elec_instrument</DeviceName>
              </invalidDetailList>
        </InvalidDetailList>
        <ValidList>
              <Name>light3</Name>
        </ValidList>
        <InvalidList>
              <Name>Elec_instrument</Name>
        </InvalidList>
  </Data>
  <Code></Code>
  <Success>true</Success>
</QueryBatchCheckDeviceNamesStatusResponse>

JSON 形式

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "Status": "CREATE_SUCCESS",
        "InvalidDetailList": {
            "invalidDetailList": [{
                "ErrorMsg": "ニックネームが無効です。 | ニックネームが無効です。",
                "NickName": "キャンパスライト 1",
                "DeviceName": "Elec_instrument"
            }]
        },
        "ValidList": {
            "Name": ["light3"]
        },
        "InvalidList": {
            "Name": ["Elec_instrument"]
        }
    },
    "Code": "",
    "Success": true
}

エラーコード

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