すべてのプロダクト
Search
ドキュメントセンター

IoT Platform:QueryDevice

最終更新日:Apr 17, 2025

プロダクトのデバイスをクエリします。

説明

QueryDevice 操作は、操作を呼び出すたびに最大 100 万台のデバイスを返すことができます。

QPS 制限

  • この API 操作は、アカウントごとに 1 秒あたり最大 50 回呼び出すことができます。
    説明 Alibaba Cloud アカウントの RAM ユーザーは、Alibaba Cloud アカウントのクォータを共有します。
  • [CurrentPage] パラメーターの値と [PageSize] パラメーターの値の積が 100,000 以上の場合、この操作のクエリ/秒 (QPS) は減少します。

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

デバッグ

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

リクエストパラメーター

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

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

ProductKeyStringはいa1BwAGV****

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

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

インスタンスの ID。IoT Platform コンソールの [概要] ページでインスタンスの [ID] を表示できます。

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

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

PageSizeIntegerいいえ10

各ページに返すエントリの数。有効な値:1 ~ 50。デフォルト値:10。

CurrentPageIntegerいいえ1

返すページの番号。デフォルト値:1。

NextTokenStringいいえTGlzdFJlc291cm***

クエリ結果の次のページを取得するために使用されるトークン。クエリ操作を初めて実行するときは、このパラメーターを設定する必要はありません。 [NextToken] パラメーターには、前のクエリから取得したトークンを指定する必要があります。

[PageSize] パラメーターの値と [CurrentPage] パラメーターの値の積が 10,000 を超える場合は、[NextToken] パラメーターを設定する必要があります。設定しないと、データは返されません。

重要

[NextToken] パラメーターを設定する場合、[PageSize] パラメーターの値と [CurrentPage] パラメーターの値の積は 1,000,000 未満である必要があります。そうでない場合、データは返されません。

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

レスポンスパラメーター

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

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

DataDeviceInfo の配列

呼び出しが成功した場合に返されるデバイス情報。デバイスの詳細は、[DeviceInfo] パラメーターに含まれています。

説明 返されるデバイス情報は、デバイスが作成された時刻に基づいて、逆時系列順にソートされます。
DeviceInfo
DeviceIdStringdwnS41bhNxjslDAI****

デバイスの ID。

説明 このパラメーターは非推奨です。デバイスの識別にこのパラメーターを使用しないでください。 [IotId] パラメーター、または [ProductKey] パラメーターと [DeviceName] パラメーターの組み合わせを使用して、デバイスを識別できます。
DeviceNameStringlight

デバイスの名前。

DeviceSecretStringsLefbFmN9SYfnWLJTePG893XNuRV****

デバイスの DeviceSecret。

DeviceStatusStringONLINE

デバイスのステータス。有効な値:

  • [ONLINE]: デバイスはオンラインです。
  • [OFFLINE]: デバイスはオフラインです。
  • [UNACTIVE]: デバイスはアクティブ化されていません。
  • [DISABLE]: デバイスは非アクティブ化されています。
DeviceTypeStringLighting

デバイスが属するプロダクトのカテゴリ。

説明 このパラメーターは返されません。
GmtCreateStringWed, 20-Feb-2019 02:16:09 GMT

デバイスが作成された時刻。時刻は GMT 形式です。

GmtModifiedStringWed, 20-Feb-2019 02:16:09 GMT

デバイス情報が最後に更新された時刻。時刻は GMT 形式です。

IotIdStringQ7uOhVRdZRRlDnTLv****00100

デバイスの ID。ID は、IoT Platform がデバイスに発行する一意の識別子です。

NicknameStringSmart light

デバイスのエイリアス。

ProductKeyStringa1BwAGV****

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

UtcCreateString2019-02-20T02:16:09.000Z

デバイスが作成された時刻。時刻は UTC で表示されます。

UtcModifiedString2019-02-20T02:16:09.000Z

デバイス情報が最後に更新された時刻。時刻は UTC で表示されます。

ErrorMessageStringA system exception occurred.

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

NextTokenStringTGlzdFJlc291cm***

クエリ結果の次のページを取得するために使用されるトークン。後続のクエリでこのパラメーターを指定して、次の結果ページを取得できます。

[NextToken] パラメーターが空の場合、後続のページは存在しません。

PageInteger1

返されたページのページ番号。

PageCountInteger1

返されるページの総数。

PageSizeInteger10

1 ページあたりに返されるエントリの数。

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

リクエストの ID。

SuccessBooleantrue

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

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

デバイスの総数。

リクエストの例

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

成功レスポンスの例

XML 形式

<QueryDeviceResponse>
  <PageCount>1</PageCount>
  <NextToken>TGlzdFJlc291cm***</NextToken>
  <Data>
        <DeviceInfo>
              <DeviceId>Av8NGHGtwPrH9BYG****</DeviceId>
              <DeviceName>Av8NGHGtwPrH9BYGLMBi</DeviceName>
              <ProductKey>a1dafDE****</ProductKey>
              <DeviceSecret>d7GYhf5hfcPHDe1bXSd3n9MjO1G3****</DeviceSecret>
              <UtcModified>2019-02-20T02:16:09.000Z</UtcModified>
              <GmtCreate>Wed, 20-Feb-2019 02:16:09 GMT</GmtCreate>
              <UtcCreate>2019-02-20T02:16:09.000Z</UtcCreate>
              <GmtModified>Wed, 20-Feb-2019 02:16:09 GMT</GmtModified>
              <IotId>Av8NGHGtwPrH9BYGLMBi00****</IotId>
              <DeviceStatus>UNACTIVE</DeviceStatus>
              <Nickname>SensorInShanghai</Nickname>
        </DeviceInfo>
        <DeviceInfo>
              <DeviceId>zNIcSmWQ9BPJlmkj****</DeviceId>
              <DeviceName>zNIcSmWQ9BPJlmkjn3H1</DeviceName>
              <ProductKey>a1dafDE****</ProductKey>
              <DeviceSecret>C27XXmC18yLIEDXvUj6FSlvgO7ag****</DeviceSecret>
              <UtcModified>2019-02-20T02:16:09.000Z</UtcModified>
              <GmtCreate>Wed, 20-Feb-2019 02:16:09 GMT</GmtCreate>
              <UtcCreate>2019-02-20T02:16:09.000Z</UtcCreate>
              <GmtModified>Wed, 20-Feb-2019 02:16:09 GMT</GmtModified>
              <IotId>zNIcSmWQ9BPJlmkjn3H100****</IotId>
              <DeviceStatus>UNACTIVE</DeviceStatus>
              <Nickname>DriverInShanghai</Nickname>
        </DeviceInfo>
  </Data>
  <Page>1</Page>
  <PageSize>10</PageSize>
  <RequestId>CD9E5F99-A095-4A05-9256-D924EA3075E8</RequestId>
  <Success>true</Success>
  <Total>2</Total>
</QueryDeviceResponse>

JSON 形式

{
  "PageCount": 1,
  "NextToken":"TGlzdFJlc291cm***", 
  "Data": {
    "DeviceInfo": [
      {
        "DeviceId": "Av8NGHGtwPrH9BYG****", 
        "DeviceName": "Av8NGHGtwPrH9BYGLMBi", 
        "ProductKey": "a1dafDE****", 
        "DeviceSecret": "d7GYhf5hfcPHDe1bXSd3n9MjO1G3****", 
        "UtcModified": "2019-02-20T02:16:09.000Z", 
        "GmtCreate": "Wed, 20-Feb-2019 02:16:09 GMT", 
        "UtcCreate": "2019-02-20T02:16:09.000Z", 
        "GmtModified": "Wed, 20-Feb-2019 02:16:09 GMT", 
        "IotId": "Av8NGHGtwPrH9BYGLMBi00****", 
        "DeviceStatus": "UNACTIVE", 
        "Nickname": "SensorInShanghai"
      }, 
      {
        "DeviceId": "zNIcSmWQ9BPJlmkj****", 
        "DeviceName": "zNIcSmWQ9BPJlmkjn3H1", 
        "ProductKey": "a1dafDE****", 
        "DeviceSecret": "C27XXmC18yLIEDXvUj6FSlvgO7ag****", 
        "UtcModified": "2019-02-20T02:16:09.000Z", 
        "GmtCreate": "Wed, 20-Feb-2019 02:16:09 GMT", 
        "UtcCreate": "2019-02-20T02:16:09.000Z", 
        "GmtModified": "Wed, 20-Feb-2019 02:16:09 GMT", 
        "IotId": "zNIcSmWQ9BPJlmkjn3H100****", 
        "DeviceStatus": "UNACTIVE", 
        "Nickname": "DriverInShanghai"
      }
    ]
  }, 
  "Page": 1, 
  "PageSize": 10, 
  "RequestId": "CD9E5F99-A095-4A05-9256-D924EA3075E8", 
  "Success": true, 
  "Total": 2
}

エラーコード

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