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

IoT Platform:QueryDevicesHotStorageData

最終更新日:Apr 17, 2025

時系列データをクエリします。

使用方法

QueryDevicesHotStorageData 操作は、Standard 版および Exclusive 版の Enterprise Edition インスタンスでのみ使用できます。

制限

  • この操作を呼び出すことによって、Enterprise Edition インスタンスの時系列データストレージから毎秒読み取ることができるデータ量は、インスタンスの購入時に 時系列データストレージ IOPS パラメーターに指定した値によって異なります。 詳細については、「Enterprise Edition インスタンスを購入する」をご参照ください。

  • QueryDevicesHotStorageData 操作を呼び出して、期限切れになっていないデータをクエリできます。

    説明

    フィールドのデータの保持期間は、フィールド値のタイムスタンプの日付から開始されます。

デバッグ

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

リクエストパラメーター

パラメーター

タイプ

必須

説明

Action

String

はい

QueryDevicesHotStorageData

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

Asc

Integer

はい

0

返されるデータレコードをソートする順序。有効な値:

  • 0: 降順。

  • 1: 昇順。

EndTime

Long

はい

1579249499000

クエリする時間範囲の終了。終了時刻は開始時刻よりも後である必要があります。 1970年1月1日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプを指定します。例:1579249499000。

Identifier

String

はい

temperature

時系列データストレージに保存されているフィールドの識別子。識別子は、WriteDevicesHotStorageData 操作を呼び出して時系列データストレージにデータを書き込むときに、Items によって指定されます。

IotInstanceId

String

はい

iot-2w****

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

PageSize

Integer

はい

10

1ページあたりのエントリ数。有効な値:1~100。

フィールドに返されるデータレコードの数は、この値を超えることはできません。

StartTime

Long

はい

1579249499000

クエリする時間範囲の開始。開始時刻は終了時刻よりも前である必要があります。 1970年1月1日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプを指定します。例:1579249499000。

UserTopic

String

はい

user/a***/b***

クエリするデータが属するカスタムトピックの名前。 user レベルの後に、カスタムトピックで必要な他のレベルを指定します。

詳細については、「カスタムトピックを使用する」をご参照ください。

ProductKey

String

いいえ

a1BwAGV****

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

重要

このパラメーターを指定する場合は、DeviceName も指定する必要があります。

DeviceName

String

いいえ

device1

デバイスの DeviceName。

重要

このパラメーターを指定する場合は、ProductKey も指定する必要があります。

NextPageToken

String

いいえ

Bo***x44Qx

次のリクエストで使用して、新しい結果ページを取得するページネーショントークン。 最初のリクエストでは、このパラメーターを指定する必要はありません。 前のクエリから取得したトークンを NextPageToken の値として指定する必要があります。

IotId

String

いいえ

y4u2weAI********HMle1234

デバイス ID。

重要

IotId は、デバイスの GUID を指定します。 IotId の値は、ProductKeyDeviceName の値の組み合わせと同じです。 このパラメーターを指定する場合は、ProductKey または DeviceName を指定する必要はありません。 IotIdProductKey、および DeviceName を指定した場合、IotId の値が優先されます。

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

レスポンスパラメーター

パラメーター

タイプ

説明

Code

String

iot.system.SystemException

リクエストが失敗した場合に返されるエラーコード。 詳細については、このトピックの エラーコード セクションをご参照ください。

Data

Struct

リクエストが成功した場合に返されるデータ。

List

PropertyInfo の配列

クエリされた時系列データ。

PropertyInfo

Time

String

1516541885630

フィールド値のタイムスタンプ。 この値は、1970年1月1日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。

Value

String

2

フィールド値。

NextValid

Boolean

true

次のページが存在するかどうかを示します。有効な値:

  • true

  • false

NextValidtrue が返された場合、レスポンスで返された NextPageToken の値を、次のリクエストの NextPageToken の値として指定できます。 これにより、現在のクエリに含まれていないデータをクエリできます。

nextPageToken

String

Bo***x44Qx

ページネーショントークン。 次のリクエストで使用して、新しい結果ページを取得できます。

ErrorMessage

String

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

リクエストが失敗した場合に返されるエラーメッセージ。

RequestId

String

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

リクエスト ID。

Success

Boolean

true

リクエストが成功したかどうかを示します。有効な値:

  • true

  • false

リクエストの例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryDevicesHotStorageData
&Asc=0
&EndTime=1579249499000
&Identifier=temperature
&IotInstanceId=iot-2w****
&PageSize=10
&StartTime=1579249499000
&UserTopic=user/a***/b***
$ProductKey=a1BwAGV****
$DeviceName=device1
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<QueryDevicesHotStorageDataResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <NextValid>true</NextValid>
        <nextPageToken>Bo***x44Qx</nextPageToken>
        <List>
              <PropertyInfo>
                    <Value>2</Value>
                    <Time>1516541885630</Time>
              </PropertyInfo>
        </List>
  </Data>
  <Success>true</Success>
</QueryDevicesHotStorageDataResponse>

JSON 形式

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "NextValid": true,
        "nextPageToken": "Bo***x44Qx",
        "List": {
            "PropertyInfo": [{
                "Value": 2,
                "Time": 1516541885630
            }]
        }
    },
    "Success": true
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400

iot.device.InvalidTimeBucket

指定された時間範囲が無効です。

指定された時間範囲が無効です。

400

iot.device.NullDeviceName

DeviceName パラメーターは空にできません。

DeviceName が指定されていません。

400

iot.prod.NullProductKey

ProductKey パラメーターは空にできません。

ProductKey が指定されていません。

400

iot.common.InvalidPageParams

指定されたページサイズまたはページパラメーターが無効です。

指定されたページサイズまたはページ番号が無効です。

400

iot.prod.NotExistedProduct

指定されたプロダクトは存在しません。

指定したプロダクトは存在しません。

400

iot.device.PageTokenIsIllegal

ページングトークンが無効です。

NextPageToken の値が無効です。

400

Iot.Device.NotExistedDevice

デバイスは存在しません。

デバイスが存在しないか、アクティブ化されていません。

400

iot.device.InvalidFormattedDeviceName

DeviceName の形式が無効です。

DeviceName の形式が無効です。

400

iot.prod.InvalidFormattedProductkey

ProductKey の形式が無効です。

ProductKey の形式が無効です。

400

iot.system.IllegalRequest

リクエストパラメーターが無効です。

1 つ以上のリクエストパラメーターが無効です。

400

iot.device.InvalidIoTId

指定されたデバイス ID が無効です。

デバイス ID が無効です。

400

iot.storage.HotStorageIopsReadNotEnough

タイムラインストレージの読み取り IOPS が不足しています。

時系列データストレージの読み取り IOPS が不足しています。

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