QueryDevicesHotStorageData - IoT Platform

使用說明

僅標準型和尊享型企業版執行個體下，支援調用該介面查詢時序資料。

時序資料存放區詳細說明，請參見配置時序資料存放區。

使用限制

調用該介面的每秒請求寫入資料數，由您購買執行個體下的時序資料存放區IOPS規格決定。詳細內容，請參見購買企業版執行個體和查看時序資料存放區IOPS。
僅可查詢儲存時效內的資料。資料存放區時效，請參見儲存配置。

說明

資料存放區時間從儲存欄位的時間戳記表示的時間當日開始計算。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	QueryDevicesHotStorageData	系統規定參數。取值：QueryDevicesHotStorageData。
Asc	Integer	是	0	返回結果中資料記錄的排序方式，取值： 0：倒序。 1：正序。
EndTime	Long	是	1579249499000	要查詢的資料記錄的結束時間，必須大於起始時間StartTime。取值為毫秒值時間戳記，例如：1579249499000。
Identifier	String	是	temperature	已儲存時序資料中的欄位標識符。即調用WriteDevicesHotStorageData介面寫入時序資料中請求參數Items中的欄位標識符。
IotInstanceId	String	是	iot-2w****	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。
PageSize	Integer	是	10	單個欄位標識符可返回的資料記錄數量，最大值為100。任意一個欄位返回的資料記錄數量均不超過該值。
StartTime	Long	是	1579249499000	要查詢的資料記錄的開始時間，必須小於結束時間EndTime。取值為毫秒值時間戳記，例如：1579249499000。
UserTopic	String	是	user/a*/b*	要查詢資料所屬自訂Topic。從`user`類目開始，輸入自訂Topic的後續所有類目。自訂Topic詳細說明，請參見自訂Topic。
ProductKey	String	否	a1BwAGV****	裝置所屬的產品ProductKey。重要如果傳入該參數，需同時傳入DeviceName。
DeviceName	String	否	device1	裝置的名稱。重要如果傳入該參數，需同時傳入ProductKey。
NextPageToken	String	否	Bo***x44Qx	下一頁標識。如果存在下一頁，服務會返回此Token，下次請求帶上即可。
IotId	String	否	y4u2weAI********HMle1234	裝置ID。重要 IotId作為裝置唯一識別碼，和ProductKey與DeviceName組合是一一對應的關係。如果傳入該參數，則無需傳入ProductKey和DeviceName。如果您同時傳入IotId和ProductKey與DeviceName組合，則以IotId為準。

調用API時，除了本文介紹的該API的特有請求參數，還需傳入公用請求參數。公用請求參數說明，請參見公用參數文檔。

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回錯誤碼。詳細資料，請參見下文錯誤碼。
Data	Struct		調用成功後，返回的資料。
List	Array of PropertyInfo		時序資料集合。
PropertyInfo
Time	String	1516541885630	欄位值對應時間戳記，單位為毫秒。
Value	String	2	欄位值。
NextValid	Boolean	true	是否有下一頁屬性記錄。 true：有。 false：沒有。返回NextValid為true時，可以將NextPageToken的值作為下次查詢的NextPageToken，繼續查詢本次查詢不顯示的資料。
nextPageToken	String	Bo***x44Qx	下一頁標識。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	阿里雲為該請求產生的唯一識別碼。
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
}

錯誤碼

HttpCode	錯誤碼	錯誤資訊	描述
400	iot.device.InvalidTimeBucket	The specified time range is invalid.	指定的時間區間不合法。
400	iot.device.NullDeviceName	The DeviceName parameter cannot be empty.	裝置名稱不可為空。
400	iot.prod.NullProductKey	The ProductKey parameter cannot be empty.	入參產品ProductKey不可為空。
400	iot.common.InvalidPageParams	The specified pagination size or pagination parameter is invalid.	分頁大小或者分頁頁號不合法。
400	iot.prod.NotExistedProduct	The specified product does not exist.	指定的產品不存在。
400	iot.device.PageTokenIsIllegal	The paging token is invalid.	分頁token非法。
400	Iot.Device.NotExistedDevice	The device does not exist.	裝置不存在或未啟用。
400	iot.device.InvalidFormattedDeviceName	The DeviceName format is invalid.	裝置名稱格式錯誤。
400	iot.prod.InvalidFormattedProductkey	The ProductKey format is invalid.	入參產品ProductKey格式錯誤。
400	iot.system.IllegalRequest	The request parameter is invalid.	非法的請求參數。
400	iot.device.InvalidIoTId	The specified device ID is invalid.	裝置ID錯誤。
400	iot.storage.HotStorageIopsReadNotEnough	The timeline storage read IOPS is not enough.	時序儲存讀IOPS不足。

訪問錯誤中心查看更多錯誤碼。