調用該接口查詢時序數據存儲的快照數據。
使用說明
僅標準型和尊享型企業版實例下,支持調用該接口查詢時序數據。
時序數據存儲詳細說明,請參見配置時序數據存儲。
使用限制
調用該接口的每秒請求寫入數據數,由您購買實例下的時序數據存儲IOPS規格決定。詳細內容,請參見購買企業版實例和查看時序數據存儲IOPS。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | QueryDevicesHotStorageDataStatus | 系統規定參數。取值:QueryDevicesHotStorageDataStatus。 |
Asc | Integer | 是 | 0 | 返回結果中數據記錄的排序方式,取值:
|
IotInstanceId | String | 是 | iot-2w**** | 實例ID。您可在物聯網平臺控制臺的實例概覽頁面,查看當前實例的ID。 |
PageSize | Integer | 是 | 10 | 返回結果中每頁顯示的記錄數,最多不可超過50條。 |
UserTopic | String | 是 | user/a***/b*** | 要查詢數據所屬自定義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 PropertyStatusDataInfo | 快照數據集合。 |
|
PropertyStatusDataInfo | |||
Identifier | String | Temperture | 字段標識符。 |
Time | Long | 1517553572362 | 字段值對應時間戳,單位為毫秒。 |
Value | String | 22 | 字段值。 |
NextPageToken | String | Bo***x44Qx | 下一頁標識。 |
NextValid | Boolean | true | 是否有下一頁屬性記錄。
返回NextValid為true時,可以將NextPageToken的值作為下次查詢的NextPageToken,繼續查詢本次查詢不顯示的數據。 |
ErrorMessage | String | 系統異常 | 調用失敗時,返回的出錯信息。 |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | 阿里云為該請求生成的唯一標識符。 |
Success | Boolean | true | 是否調用成功。
|
示例
請求示例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryDevicesHotStorageDataStatus
&Asc=0
&IotInstanceId=iot-2w****
&PageSize=10
&UserTopic=user/a***/b***
$ProductKey=a1BwAGV****
$DeviceName=device1
&<公共請求參數>
正常返回示例
XML
格式
<QueryDevicesHotStorageDataStatusResponse>
<RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
<Data>
<NextValid>true</NextValid>
<NextPageToken>Bo***x44Qx</NextPageToken>
<List>
<PropertyStatusDataInfo>
<Identifier>Temperture</Identifier>
<Value>22</Value>
<Time>1517553572362</Time>
</PropertyStatusDataInfo>
</List>
</Data>
<Success>true</Success>
</QueryDevicesHotStorageDataStatusResponse>
JSON
格式
{
"RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
"Data": {
"NextValid": true,
"NextPageToken": "Bo***x44Qx",
"List": {
"PropertyStatusDataInfo": [{
"Identifier": "Temperture",
"Value": 22,
"Time": 1517553572362
}]
}
},
"Success": true
}