QueryDevicesHotStorageDataStatus - IoT Platform - Centre de documentation Alibaba Cloud

Notes d'utilisation

Cette opération est disponible uniquement pour les instances Enterprise Edition Standard et Exclusive.

Limites

Le débit de lecture par seconde du stockage de séries temporelles dépend de la valeur Time-series Data Storage IOPS spécifiée lors de l'achat de l'instance Enterprise Edition. Pour en savoir plus, reportez-vous aux rubriques Acheter des instances Enterprise Edition.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'appeler cette opération via OpenAPI Explorer pour plus de commodité.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	QueryDevicesHotStorageDataStatus	Opération à effectuer. Définissez la valeur sur QueryDevicesHotStorageDataStatus.
Asc	Integer	Oui	0	Ordre de tri des enregistrements de données renvoyés. Valeurs valides : 0 : ordre chronologique inverse. 1 : ordre chronologique.
IotInstanceId	String	Oui	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	Oui	10	Nombre d'entrées par page. Valeurs valides : 1 à 50.
UserTopic	String	Oui	user/a*/b*	Nom du topic personnalisé auquel appartiennent les données à interroger. Spécifiez les autres niveaux requis par le topic personnalisé après le niveau `user`. Pour plus d'informations, consultez la rubrique Utiliser des topics personnalisés.
ProductKey	String	Non	a1BwAGV****	ProductKey du produit auquel appartient l'appareil. Important Si vous spécifiez ce paramètre, vous devez également spécifier DeviceName.
DeviceName	String	Non	device1	DeviceName de l'appareil. Important Si vous spécifiez ce paramètre, vous devez également spécifier ProductKey.
NextPageToken	String	Non	Bo***x44Qx	Jeton pour la page de résultats suivante. Inutile de spécifier ce paramètre pour la première requête. Pour les requêtes suivantes, définissez ce paramètre sur la valeur NextPageToken renvoyée dans la réponse précédente.
IotId	String	Non	y4u2weAI********HMle1234	ID de l'appareil. Important IotId spécifie un GUID pour l'appareil. La valeur de IotId équivaut à la combinaison des valeurs de ProductKey et de DeviceName. Si vous spécifiez ce paramètre, inutile de spécifier ProductKey ni DeviceName. Si vous spécifiez IotId, ProductKey et DeviceName, la valeur de IotId est prioritaire.

En plus des paramètres de requête spécifiques à l'opération mentionnés ci-dessus, vous devez spécifier les paramètres de requête communs lorsque vous appelez cette opération. Pour plus d'informations, consultez la rubrique Paramètres communs.

Paramètres de réponse

Paramètre	Type	Exemple	Description
Code	String	iot.system.SystemException	Code d'erreur renvoyé en cas d'échec de la requête. Pour plus d'informations, consultez la section Codes d'erreur de cette rubrique.
Data	Struct		Données renvoyées en cas de succès de la requête.
List	Array of PropertyStatusDataInfo		Snapshots interrogés.
PropertyStatusDataInfo
Identifier	String	Temperture	Identifiant du champ.
Time	Long	1517553572362	Horodatage de la valeur du champ. La valeur est un horodatage UNIX en millisecondes.
Value	String	22	Valeur du champ.
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.
NextValid	Boolean	true	Indique si la page suivante existe. Valeurs valides : true false Si true est renvoyé, utilisez la valeur NextPageToken renvoyée dans la requête suivante pour récupérer les résultats restants.
ErrorMessage	String	A system exception occurred.	Message d'erreur renvoyé en cas d'échec de la requête.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	ID de la requête.
Success	Boolean	true	Indique si la requête a réussi. Valeurs valides : true false

Exemples

Exemples de requêtes

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryDevicesHotStorageDataStatus
&Asc=0
&IotInstanceId=iot-2w****
&PageSize=10
&UserTopic=user/a***/b***
$ProductKey=a1BwAGV****
$DeviceName=device1
&<Common request parameters>

Exemples de réponses réussies

XML format

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

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "NextValid": true,
        "NextPageToken": "Bo***x44Qx",
        "List": {
            "PropertyStatusDataInfo": [{
                "Identifier": "Temperture",
                "Value": 22,
                "Time": 1517553572362
            }]
        }
    },
    "Success": true
}

Codes d'erreur

Code d'état HTTP	Code d'erreur	Message d'erreur	Description
400	iot.device.PageTokenIsIllegal	The paging token is invalid.	La valeur de NextPageToken n'est pas valide.
400	iot.prod.NotExistedProduct	The specified product does not exist.	Le produit que vous avez spécifié n'existe pas.
400	iot.device.InvalidTimeBucket	The specified time range is invalid.	La plage de temps spécifiée n'est pas valide.
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.NullProductKey	The ProductKey parameter cannot be empty.	ProductKey n'est pas spécifié.
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.device.NullDeviceName	The DeviceName parameter cannot be empty.	DeviceName n'est pas spécifié.
400	iot.storage.HotStorageIopsReadNotEnough	The timeline storage read IOPS is not enough.	Les IOPS de lecture du stockage de séries temporelles sont insuffisants.

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