IoT Platform における QueryPageByApplyId を使用して登録デバイス情報をクエリ - IoT

登録した複数のデバイスの情報をクエリします。

制限

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

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

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	QueryPageByApplyId	実行する操作。値を QueryPageByApplyId に設定します。
ApplyId	Long	はい	1295006	アプリケーションの ID。BatchRegisterDeviceWithApplyId または BatchRegisterDevice 操作のレスポンスでアプリケーション ID を確認できます。
IotInstanceId	String	いいえ	iot_instc_pu***_c-v64********	インスタンスの ID。 IoT Platform コンソールの [概要] ページでインスタンスの [ID] を確認できます。重要インスタンスに ID がある場合は、このパラメーターを設定する必要があります。このパラメーターを設定しないと、呼び出しは失敗します。インスタンスに概要ページまたは ID がない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。
PageSize	Integer	いいえ	10	各ページに返すエントリの数。最大値：50。デフォルト値：10。
CurrentPage	Integer	いいえ	1	返すページの番号。デフォルト値：1。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
ApplyDeviceList	ApplyDeviceInfo の配列		呼び出しが成功した場合に返される登録済みデバイスリスト情報。ApplyDeviceInfo パラメーターには、登録済みデバイスの詳細が含まれています。
ApplyDeviceInfo
DeviceId	String	gQG2GJ2y10m6hIk8****	デバイスの ID（期限切れ）。説明このパラメーターは使用されなくなりました。デバイスを識別するためにこのパラメーターを使用しないでください。IotId パラメーター、またはプロダクトキーパラメーターと DeviceName パラメーターの組み合わせを使用して、デバイスを識別できます。
DeviceName	String	light	デバイスの DeviceName。
DeviceSecret	String	SkfeXXKrTgp1DbDxYr74mfJ5cnui****	デバイスの DeviceSecret。
IotId	String	vWxNur6BUApsqjv9****000100	デバイスの ID。ID は、IoT Platform がデバイスに発行する一意の識別子です。
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
Page	Integer	1	返されたページのページ番号。
PageCount	Integer	1	ページの総数。
PageSize	Integer	10	1 ページあたりに返されるエントリの数。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。
Total	Integer	2	デバイスの総数。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryPageByApplyId
&ApplyId=1234567
&PageSize=10
&CurrentPage=1
&<共通リクエストパラメーター>

成功レスポンスの例

XML フォーマット

<QueryPageByApplyIdResponse>
  <PageCount>1</PageCount>
  <ApplyDeviceList>
        <ApplyDeviceInfo>
              <DeviceId>vWxNur6BUApsqjv9****</DeviceId>
              <DeviceName>APItest</DeviceName>
              <DeviceSecret>tXXEtily4XuV7WS1fosJoDkhRIIU****</DeviceSecret>
              <IotId>vWxNur6BUApsqjv****4000100</IotId>
        </ApplyDeviceInfo>
        <ApplyDeviceInfo>
              <DeviceId>hoiwszKPYmHk074H****</DeviceId>
              <DeviceName>awfg</DeviceName>
              <DeviceSecret>BYpg1b2nmuq21BO7fxOogYQQZd9z****</DeviceSecret>
              <IotId>hoiwszKPYmHk074HA****000100</IotId>
        </ApplyDeviceInfo>
  </ApplyDeviceList>
  <Page>1</Page>
  <PageSize>10</PageSize>
  <RequestId>762F7AAD-8B87-4C65-BBF3-4575B002B384</RequestId>
  <Success>true</Success>
  <Total>2</Total>
</QueryPageByApplyIdResponse>

JSON 形式

{
    "PageCount": 1,
    "ApplyDeviceList": {
        "ApplyDeviceInfo": [
            {
                "DeviceId": "vWxNur6BUApsqjv9****",
                "DeviceName": "APItest",
                "DeviceSecret": "tXXEtily4XuV7WS1fosJoDkhRIIU****",
                "IotId": "vWxNur6BUApsqjv****4000100"
            },
            {
                "DeviceId": "hoiwszKPYmHk074H****",
                "DeviceName": "awfg",
                "DeviceSecret": "BYpg1b2nmuq21BO7fxOogYQQZd9z****",
                "IotId": "hoiwszKPYmHk074HA****000100"
            }
        ]
    },
    "Page": 1,
    "PageSize": 10,
    "RequestId": "762F7AAD-8B87-4C65-BBF3-4575B002B384",
    "Success": true,
    "Total": 2
}

エラーコード

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