指定された期間内に、デバイスまたはデジタルツインノードのプロパティのデータをクエリします。
使用上の注意
デバイスまたはデジタルツインノードに複数のプロパティがある場合、この操作を複数回呼び出して、プロパティのデータをクエリできます。Identifier パラメーターの値は、操作を呼び出すたびに指定する必要があります。QueryDevicePropertiesData 操作を呼び出し、Identifier パラメーターに複数の値を指定して、プロパティのデータをクエリすることもできます。
制限
過去 30 日以内に生成されたプロパティデータのみをクエリできます。
QPS 制限
各 Alibaba Cloud アカウントは、毎秒最大 50 クエリ/秒 (QPS) を実行できます。
デバッグ
リクエストパラメーター
| パラメーター | タイプ | 必須 | 例 | 説明 |
| Action | String | Yes | QueryDevicePropertyData | 実行する操作。値を QueryDevicePropertyData に設定します。 |
| EndTime | Long | Yes | 1579249499000 | クエリ対象の期間の終了時刻。EndTime パラメーターの値は、StartTime パラメーターの値よりも大きい必要があります。値はミリ秒単位のタイムスタンプです (例: 1579249499000)。 |
| Asc | Integer | Yes | 0 | 返されるプロパティレコードをソートする順序。有効な値:
|
| Identifier | String | Yes | temperature | クエリするプロパティの識別子。 プロパティの identifier は、IoT Platform コンソールの [プロダクトの詳細] ページの [機能定義] タブで確認できます。また、QueryThingModel 操作を呼び出して、返された TSL データでプロパティ識別子を確認することもできます。 説明 temperature という名前のプロパティが testFb という名前のカスタムモジュールに属している場合、このパラメーターを testFb:temperature に設定します。カスタムモジュールはデフォルトモジュールではありません。 |
| PageSize | Integer | Yes | 10 | 各ページに返すエントリの数。有効値: 1 ~ 50。 |
| StartTime | Long | Yes | 1579249499000 | クエリ対象の期間の開始時刻。StartTime パラメーターの値は、EndTime パラメーターの値よりも小さい必要があります。値はミリ秒単位のタイムスタンプです (例: 1579249499000)。 |
| IotInstanceId | String | No | iot-cn-0pp1n8t**** | インスタンスの ID。インスタンス ID は、IoT Platform コンソールの 概要 ページで確認できます。 重要
詳細については、「概要」をご参照ください。 |
| IotId | String | No | Q7uOhVRdZRRlDnTLv****00100 | プロパティが属するデバイスの ID。: QueryDeviceInfo 操作を呼び出して、デバイスの ID をクエリできます。 重要 このパラメーターに値を指定する場合、ProductKey パラメーターまたは DeviceName パラメーターに値を指定する必要はありません。IotId パラメーターは、デバイスのグローバル一意識別子 (GUID) を指定します。IotId パラメーターの値は、ProductKey パラメーターと DeviceName パラメーターの値の組み合わせに対応します。IotId パラメーターに値を指定し、ProductKey パラメーターと DeviceName パラメーターにも値を指定した場合、IotId パラメーターの値が優先されます。 |
| ProductKey | String | No | a1BwAGV**** | デバイスが属するプロダクトの ProductKey。 重要 このパラメーターに値を指定する場合は、DeviceName パラメーターにも値を指定する必要があります。 |
| DeviceName | String | No | airconditioning | デバイスの名前。 重要 このパラメーターに値を指定する場合は、ProductKey パラメーターにも値を指定する必要があります。 |
上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは、共通のリクエストパラメーターを指定する必要があります。詳細については、「共通リクエストパラメーター」をご参照ください。
レスポンスパラメーター
| パラメーター | タイプ | 例 | 説明 |
| Code | String | iot.system.SystemException | 呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。 |
| Data | Struct | 呼び出しが成功した場合に返されるプロパティデータ。 |
|
| List | PropertyInfo の配列 | プロパティレコードのリスト。 |
|
| PropertyInfo | |||
| Time | String | 1516541885630 | プロパティが変更された時刻。 |
| Value | String | 2 | プロパティの値。 |
| NextTime | Long | 1579249499000 | 次のページのプロパティレコードの開始時刻。
|
| NextValid | Boolean | true | 次のページが存在するかどうかを示します。
|
| ErrorMessage | String | A system exception occurred. | 呼び出しが失敗した場合に返されるエラーメッセージ。 |
| RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | リクエストの ID。 |
| Success | Boolean | true | 呼び出しが成功したかどうかを示します。
|
例
リクエストの例
https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDevicePropertyData
&ProductKey=a1BwAGV****
&DeviceName=device1
&Identifier=lightLevel
&StartTime=1516538300303
&EndTime=1516541900303
&PageSize=10
&Asc=1
&<Common request parameters>
レスポンスの例
XML 形式
<QueryDevicePropertyDataResponse>
<Data>
<NextValid>false</NextValid>
<NextTime>1579249151177</NextTime>
<List>
<PropertyInfo>
<Value>32.46</Value>
<Time>1579249151178</Time>
</PropertyInfo>
</List>
</Data>
<RequestId>45391E10-446B-4986-863E-1BA8CC44748F</RequestId>
<Success>true</Success>
</QueryDevicePropertyDataResponse>
JSON 形式
{
"Data": {
"NextValid": false,
"NextTime": 1579249151177,
"List": {
"PropertyInfo": [
{
"Value": "32.46",
"Time": 1579249151178
}
]
}
},
"RequestId": "45391E10-446B-4986-863E-1BA8CC44748F",
"Success": true
}
エラーコード
エラーコードのリストについては、「API エラーセンター」をご参照ください。