QueryDevicesHotStorageData - IoT Platform - Centre de documentation Alibaba Cloud

Notes d'utilisation

L'opération QueryDevicesHotStorageData est disponible uniquement pour les instances Enterprise Edition Standard et Exclusive.

Limites

Le débit de lecture de cette opération dépend de la valeur Time-series Data Storage IOPS spécifiée lors de l'achat de l'instance. Pour plus d'informations, consultez Acheter des instances Enterprise Edition.
Vous ne pouvez interroger que les données non expirées.

Remarque

La période de conservation d'un champ débute à la date indiquée par l'horodatage de la valeur du champ.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Par souci de simplicité, nous vous recommandons d'appeler cette opération via OpenAPI Explorer. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	QueryDevicesHotStorageData	Opération à effectuer. Définissez la valeur sur QueryDevicesHotStorageData.
Asc	Integer	Yes	0	Ordre de tri des enregistrements de données renvoyés. Valeurs possibles : 0 : ordre chronologique inverse. 1 : ordre chronologique.
EndTime	Long	Yes	1579249499000	Fin de la plage de temps à interroger. Doit être postérieure à l'heure de début. La valeur est un horodatage UNIX en millisecondes. Exemple : 1579249499000.
Identifier	String	Yes	temperature	Identifiant du champ stocké dans le stockage de données de séries temporelles, tel que spécifié par Items lors de l'appel de l'opération WriteDevicesHotStorageData.
IotInstanceId	String	Yes	iot-2w****	ID de l'instance. Vous pouvez afficher l'ID de l'instance sur la page Overview de la console IoT Platform.
PageSize	Integer	Yes	10	Nombre d'entrées par page. Valeurs possibles : 1 à 100. Le nombre d'enregistrements de données renvoyés pour un champ ne peut pas dépasser cette valeur.
StartTime	Long	Yes	1579249499000	Début de la plage de temps à interroger. Doit être antérieur à l'heure de fin. La valeur est un horodatage UNIX en millisecondes. Exemple : 1579249499000.
UserTopic	String	Yes	user/a/b	Rubrique personnalisée à laquelle appartiennent les données. Spécifiez les niveaux requis après le niveau `user`. Pour plus d'informations, consultez Utiliser des rubriques personnalisées.
ProductKey	String	No	a1BwAGV****	ProductKey du produit auquel appartient l'appareil. Important Si vous spécifiez ce paramètre, vous devez également spécifier DeviceName.
DeviceName	String	No	device1	DeviceName de l'appareil. Important Si vous spécifiez ce paramètre, vous devez également spécifier ProductKey.
NextPageToken	String	No	Bo***x44Qx	Jeton de pagination des résultats. Non requis pour la première requête. Pour les requêtes suivantes, utilisez la valeur NextPageToken de la réponse précédente.
IotId	String	No	y4u2weAI********HMle1234	ID de l'appareil. Important IotId est un identifiant d'appareil globalement unique, équivalent à la combinaison de ProductKey et de DeviceName. Si vous spécifiez ce paramètre, il n'est pas nécessaire de spécifier ProductKey ou DeviceName. Si vous spécifiez les trois paramètres, IotId est prioritaire.

Vous devez également spécifier les paramètres de requête communs lors de l'appel de cette opération. Pour plus d'informations, consultez Paramètres communs.

Paramètres de réponse

Parameter	Type	Example	Description
Code	String	iot.system.SystemException	Code d'erreur renvoyé si la requête a échoué. Pour plus d'informations, consultez la section Error codes de cette rubrique.
Data	Struct		Données renvoyées si la requête a abouti.
List	Array of PropertyInfo		Données de séries temporelles interrogées.
PropertyInfo
Time	String	1516541885630	Horodatage de la valeur du champ, sous forme d'horodatage UNIX en millisecondes.
Value	String	2	Valeur du champ.
NextValid	Boolean	true	Indique s'il existe une page suivante. Valeurs possibles : true false Si la valeur est true, utilisez la valeur NextPageToken de cette réponse dans la requête suivante pour récupérer des données supplémentaires.
nextPageToken	String	Bo***x44Qx	Jeton de pagination. Il peut être utilisé dans la requête suivante pour récupérer une nouvelle page de résultats.
ErrorMessage	String	A system exception occurred.	Message d'erreur renvoyé si la requête a échoué.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	ID de la requête.
Success	Boolean	true	Indique si la requête a abouti. Valeurs possibles : true false

Exemples

Exemple de requête

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>

Exemple de réponse réussie

XML format

<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 format

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

Codes d'erreur

HTTP status code	Error code	Error message	Description
400	iot.device.InvalidTimeBucket	The specified time range is invalid.	La plage de temps spécifiée n'est pas valide.
400	iot.device.NullDeviceName	The DeviceName parameter cannot be empty.	Le paramètre DeviceName n'est pas spécifié.
400	iot.prod.NullProductKey	The ProductKey parameter cannot be empty.	Le paramètre ProductKey n'est pas spécifié.
400	iot.common.InvalidPageParams	The specified pagination size or pagination parameter is invalid.	La taille de page ou le numéro de page spécifié n'est pas valide.
400	iot.prod.NotExistedProduct	The specified product does not exist.	Le produit que vous spécifiez n'existe pas.
400	iot.device.PageTokenIsIllegal	The paging token is invalid.	La valeur de NextPageToken n'est pas valide.
400	Iot.Device.NotExistedDevice	The device does not exist.	L'appareil n'existe pas ou n'est pas activé.
400	iot.device.InvalidFormattedDeviceName	The DeviceName format is invalid.	Le format de DeviceName n'est pas valide.
400	iot.prod.InvalidFormattedProductkey	The ProductKey format is invalid.	Le format de ProductKey n'est pas valide.
400	iot.system.IllegalRequest	The request parameter is invalid.	Un ou plusieurs paramètres de requête ne sont pas valides.
400	iot.device.InvalidIoTId	The specified device ID is invalid.	L'ID de l'appareil n'est pas valide.
400	iot.storage.HotStorageIopsReadNotEnough	The timeline storage read IOPS is not enough.	Les IOPS de lecture du stockage de données de séries temporelles sont insuffisants.

Pour obtenir la liste des codes d'erreur, consultez Codes d'erreur de service.