Consulta datos de series temporales del almacenamiento en caliente de una instancia de IoT Platform.
Notas de uso
La operación QueryDevicesHotStorageData solo está disponible para instancias de las ediciones Standard y Exclusive Enterprise.
Límites
El throughput de lectura de esta operación depende del valor de Time-series Data Storage IOPS especificado al adquirir la instancia. Para obtener más información, consulte Purchase Enterprise Edition instances.
-
Solo puede consultar datos no caducados.
NotaEl periodo de retención de un campo comienza a partir del día indicado por la marca de tiempo del valor del campo.
Depuración
Parámetros de solicitud
|
Parámetro |
Tipo |
Obligatorio |
Ejemplo |
Descripción |
|
Action |
String |
Sí |
QueryDevicesHotStorageData |
La operación que se va a ejecutar. Establezca el valor en QueryDevicesHotStorageData. |
|
Asc |
Integer |
Sí |
0 |
El orden de clasificación de los registros de datos devueltos. Valores válidos:
|
|
EndTime |
Long |
Sí |
1579249499000 |
El final del intervalo de tiempo a consultar. Debe ser posterior a la hora de inicio. El valor es una marca de tiempo UNIX en milisegundos. Ejemplo: 1579249499000. |
|
Identifier |
String |
Sí |
temperature |
El identificador del campo almacenado en el almacenamiento de datos de series temporales, especificado mediante Items al llamar a la operación WriteDevicesHotStorageData. |
|
IotInstanceId |
String |
Sí |
iot-2w**** |
El ID de la instancia. Consulte el ID de la instancia en la página Overview de la consola de IoT Platform. |
|
PageSize |
Integer |
Sí |
10 |
El número de entradas por página. Valores válidos: de 1 a 100. El número de registros de datos devueltos para un campo no puede superar este valor. |
|
StartTime |
Long |
Sí |
1579249499000 |
El inicio del intervalo de tiempo a consultar. Debe ser anterior a la hora de finalización. El valor es una marca de tiempo UNIX en milisegundos. Ejemplo: 1579249499000. |
|
UserTopic |
String |
Sí |
user/a/b |
El tema personalizado al que pertenecen los datos. Especifique los niveles necesarios después del nivel Para obtener más información, consulte Use custom topics. |
|
ProductKey |
String |
No |
a1BwAGV**** |
La clave ProductKey del producto al que pertenece el dispositivo. Importante
Si especifica este parámetro, también debe especificar DeviceName. |
|
DeviceName |
String |
No |
device1 |
El nombre del dispositivo (DeviceName). Importante
Si especifica este parámetro, también debe especificar ProductKey. |
|
NextPageToken |
String |
No |
Bo***x44Qx |
El token para paginar resultados. No es obligatorio en la primera solicitud. Para solicitudes posteriores, utilice el valor NextPageToken de la respuesta anterior. |
|
IotId |
String |
No |
y4u2weAI****HMle1234 |
El ID del dispositivo. Importante
IotId es un identificador de dispositivo único global, equivalente a la combinación de ProductKey y DeviceName. Si especifica este parámetro, no necesita especificar ProductKey ni DeviceName. Si especifica los tres, IotId tiene prioridad. |
También debe especificar los parámetros de solicitud comunes al llamar a esta operación. Para obtener más información, consulte Common parameters.
Parámetros de respuesta
|
Parámetro |
Tipo |
Ejemplo |
Descripción |
|
Code |
String |
iot.system.SystemException |
El código de error devuelto si la solicitud falló. Para obtener más información, consulte la sección Códigos de error de este tema. |
|
Data |
Struct |
Los datos devueltos si la solicitud se realizó correctamente. |
|
|
List |
Array of PropertyInfo |
Los datos de series temporales consultados. |
|
|
PropertyInfo |
|||
|
Time |
String |
1516541885630 |
La marca de tiempo del valor del campo, como marca de tiempo UNIX en milisegundos. |
|
Value |
String |
2 |
El valor del campo. |
|
NextValid |
Boolean |
true |
Indica si existe una página siguiente. Valores válidos:
Si es true, utilice el valor NextPageToken de esta respuesta en la siguiente solicitud para recuperar datos adicionales. |
|
nextPageToken |
String |
Bo***x44Qx |
Un token de paginación. Puede utilizarlo en la siguiente solicitud para recuperar una nueva página de resultados. |
|
ErrorMessage |
String |
A system exception occurred. |
El mensaje de error devuelto si la solicitud falló. |
|
RequestId |
String |
E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 |
El ID de la solicitud. |
|
Success |
Boolean |
true |
Indica si la solicitud se realizó correctamente. Valores válidos:
|
Ejemplos
Solicitudes de ejemplo
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
&<Common request parameters>
Respuestas exitosas de ejemplo
Formato 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>
Formato JSON
{
"RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
"Data": {
"NextValid": true,
"nextPageToken": "Bo***x44Qx",
"List": {
"PropertyInfo": [{
"Value": 2,
"Time": 1516541885630
}]
}
},
"Success": true
}
Códigos de error
|
Código de estado HTTP |
Código de error |
Mensaje de error |
Descripción |
|
400 |
iot.device.InvalidTimeBucket |
The specified time range is invalid. |
El intervalo de tiempo especificado no es válido. |
|
400 |
iot.device.NullDeviceName |
The DeviceName parameter cannot be empty. |
No se especificó DeviceName. |
|
400 |
iot.prod.NullProductKey |
The ProductKey parameter cannot be empty. |
No se especificó ProductKey. |
|
400 |
iot.common.InvalidPageParams |
The specified pagination size or pagination parameter is invalid. |
El tamaño de página o el número de página especificado no es válido. |
|
400 |
iot.prod.NotExistedProduct |
The specified product does not exist. |
El producto especificado no existe. |
|
400 |
iot.device.PageTokenIsIllegal |
The paging token is invalid. |
El valor de NextPageToken no es válido. |
|
400 |
Iot.Device.NotExistedDevice |
The device does not exist. |
El dispositivo no existe o no está activado. |
|
400 |
iot.device.InvalidFormattedDeviceName |
The DeviceName format is invalid. |
El formato de DeviceName no es válido. |
|
400 |
iot.prod.InvalidFormattedProductkey |
The ProductKey format is invalid. |
El formato de ProductKey no es válido. |
|
400 |
iot.system.IllegalRequest |
The request parameter is invalid. |
Uno o más parámetros de la solicitud no son válidos. |
|
400 |
iot.device.InvalidIoTId |
The specified device ID is invalid. |
El ID del dispositivo no es válido. |
|
400 |
iot.storage.HotStorageIopsReadNotEnough |
The timeline storage read IOPS is not enough. |
Las IOPS de lectura del almacenamiento de datos de series temporales son insuficientes. |
Para obtener una lista de códigos de error, consulte Service error codes.