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

IoT Platform:QueryDevicePropertiesData

最終更新日:Apr 17, 2025

指定された期間内にデバイスから送信された複数のプロパティをクエリします。

制限

  • 一度に最大 10 個のプロパティをクエリできます。各プロパティについて、最大 100 レコードをクエリできます。
  • 過去 30 日以内に生成されたプロパティデータをクエリできます。
    説明 プロパティレコードの保存期間は、プロパティレコードが生成された日から計算されます。
  • 各 Alibaba Cloud アカウントは、最大 10 クエリ/秒(QPS)を実行できます。
    説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

使用上の注意

この操作を呼び出して指定された期間内のプロパティレコードをクエリする場合、ある時点でのプロパティのレコード数が制限に達する可能性があります。制限は、PageSize パラメータで指定されます。この場合、クエリは停止します。他のプロパティの一部のレコードが返されない場合があります。 NextValid レスポンスパラメータに基づいて、プロパティのすべてのレコードが返されたかどうかを確認できます。

  • NextValid パラメータの値が true の場合、 パラメータと パラメータで示される期間に、取得されていないレコードが存在します。次回 および 終了時刻 パラメーター。

    使用できます 次回レスポンスパラメータを StartTime リクエストパラメータの値として使用し、この操作を再度呼び出して残りのレコードをクエリします。 この操作は、NextValidは false です。
    説明 指定された期間内のすべてのプロパティレコードを取得するには、 パラメータを最大値に設定します。そして、 パラメータの値が false になるまで、この操作を複数回呼び出します。ページサイズ パラメーターを最大値に設定します。次に、この操作を、 の値が NextValidは false です。
  • NextValid パラメータの値が false の場合、すべてのプロパティレコードが返されます。

デバッグ

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

リクエストパラメータ

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

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

AscIntegerはい0

返されるプロパティレコードのソート順。有効値:

  • 0: 降順。この場合、 パラメータで指定された時間は、 パラメータで指定された時間よりも後である必要があります。開始時刻パラメーターは、指定された時間よりも後である必要があります。終了時刻 パラメーター。
  • 1: 昇順。この場合、 パラメータで指定された時間は、 パラメータで指定された時間よりも前である必要があります。開始時刻`parameter` パラメーターは、`time` で指定された時間よりも前でなければなりません。終了時刻 パラメーター。
DeviceNameStringはいairconditioning

デバイスの DeviceName。

EndTimeLongはい1579249499000

クエリする時間範囲の終了時刻。値はミリ秒単位の 13 桁のタイムスタンプです(例:1579249499000)。

Identifier.NRepeatListはいtemperature

プロパティの識別子。

プロパティ識別子は一意である必要があります。

IoT Platform コンソールでプロパティ ID を表示できます。 [製品詳細] ページの [機能の定義] タブに移動します。 また、QueryThingModel 操作を呼び出して、返された TSL データのプロパティ ID を表示することもできます。

説明 temperature という名前のプロパティが testFb という名前のカスタムモジュールに属している場合、このパラメータを に設定します。カスタムモジュールはデフォルトモジュールではありません。testFb:温度カスタムモジュールは、デフォルトモジュールではありません。
PageSizeIntegerはい10

各プロパティについて返されるレコードの最大数。最大値:100。

任意のプロパティについて返されるレコード数は、制限を超えることはできません。

ProductKeyStringはいa1BwAGV****

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

StartTimeLongはい1579249499000

クエリする時間範囲の開始時刻。値はミリ秒単位の 13 桁のタイムスタンプです(例:1579249499000)。

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

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

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

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

IotIdStringいいえQ7uOhVRdZRRlDnTLv****00100

デバイスの ID。デバイス ID は IoT Platform によって発行されます。

説明 IotId パラメータはグローバル一意識別子(GUID)であり、 パラメータと パラメータの組み合わせに対応します。 パラメータと パラメータと パラメータの組み合わせを同時に指定した場合、 パラメータが使用されます。プロダクトキー および DeviceName パラメーター。指定した場合、IoT IDパラメーターと、プロダクトキー および DeviceName複数のパラメーターを同時に IotId パラメーターが使用されます。

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

レスポンスパラメータ

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

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

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

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

NextTimeLong1579249499000

次のページでクエリする開始時刻。

パラメータの値は、次のページの結果をクエリするときに パラメータの値として使用できます。次回パラメーターを値として開始時刻パラメーターを使用して、結果の次のページをクエリします。

NextValidBooleantrue

次のページが存在するかどうかを示します。

  • true: 次のページが存在します。
  • false: 次のページは存在しません。

戻り値がNextValidパラメーターは true次回パラメーターを値として開始時刻 パラメーターを指定して、結果の次のページをクエリします。

PropertyDataInfosPropertyDataInfo の配列

呼び出しが成功した場合に返されるプロパティレコードのリストです。詳細については、「PropertyDataInfo」をご参照ください。

PropertyDataInfo
IdentifierStringtemperature

プロパティの識別子。

ListPropertyInfo の配列

プロパティレコードのリスト。

PropertyInfo
TimeLong1579249499000

プロパティが送信された時刻。値はミリ秒単位のタイムスタンプです(例:1579249499000)。

ValueString21.3

プロパティの値。

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

リクエストの ID。

SuccessBooleantrue

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

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

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDevicePropertiesData
&Asc=0
&DeviceName=water
&EndTime=1540115948152
&Identifier.1=Temperature
&Identifier.2=Humidity
&PageSize=100
&ProductKey=a1bd***
&StartTime=1540116010723
&<共通リクエストパラメータ>

成功レスポンスの例

XML 形式

<QueryDevicePropertiesData>
  <NextValid>false</NextValid>
  <RequestId>CC4CAC00-ED4C-4004-9E8D-E8B4A78552FA</RequestId>
  <PropertyDataInfos>
        <PropertyDataInfo>
              <List>
                    <PropertyInfo>
                          <Value>32.46</Value>
                          <Time>1579249151178</Time>
                    </PropertyInfo>
              </List>
              <Identifier>Temperature</Identifier>
        </PropertyDataInfo>
        <PropertyDataInfo>
              <List>
                    <PropertyInfo>
                          <Value>48</Value>
                          <Time>1579249151178</Time>
                    </PropertyInfo>
              </List>
              <Identifier>Humidity</Identifier>
        </PropertyDataInfo>
  </PropertyDataInfos>
  <Success>true</Success>
</QueryDevicePropertiesData>

JSON 形式

{
  "NextValid": false, 
  "RequestId": "CC4CAC00-ED4C-4004-9E8D-E8B4A78552FA", 
  "PropertyDataInfos": {
    "PropertyDataInfo": [
      {
        "List": {
          "PropertyInfo": [
            {
              "Value": "32.46", 
              "Time": 1579249151178
            }
          ]
        }, 
        "Identifier": "Temperature"
      }, 
      {
        "List": {
          "PropertyInfo": [
            {
              "Value": "48", 
              "Time": 1579249151178
            }
          ]
        }, 
        "Identifier": "Humidity"
      }
    ]
  }, 
  "Success": true
}

エラーコード

エラーコードの一覧については、API エラーセンター をご参照ください。