QueryDeviceDetail - IoT Platform - Centre de documentation Alibaba Cloud

Limites de QPS

Chaque compte Alibaba Cloud peut exécuter jusqu'à 50 requêtes par seconde (QPS).

Remarque

Les utilisateurs RAM d'un compte Alibaba Cloud partagent le quota du compte.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	QueryDeviceDetail	L'opération à effectuer. Définissez la valeur sur QueryDeviceDetail.
IotInstanceId	String	No	iot-v64***	L'ID de l'instance. Vous pouvez consulter l'ID de l'instance sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez spécifier cet ID pour ce paramètre. Sinon, l'appel échoue. Si aucune page Overview ou aucun ID n'est généré pour votre instance, vous n'avez pas besoin de configurer ce paramètre. Pour plus d'informations, consultez Overview.
ProductKey	String	No	a1BwAGV****	Le ProductKey du produit auquel l'appareil appartient. Remarque Si vous spécifiez une valeur pour ce paramètre, vous devez également spécifier une valeur pour le paramètre DeviceName.
DeviceName	String	No	light	Le DeviceName de l'appareil. Remarque Si vous spécifiez une valeur pour ce paramètre, vous devez également spécifier une valeur pour le paramètre ProductKey.
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	L'ID de l'appareil. Remarque Si vous spécifiez une valeur pour ce paramètre, il est inutile de spécifier les paramètres ProductKey ou DeviceName. Le paramètre IotId correspond à un identifiant global unique (GUID) de l'appareil. La valeur du paramètre IotId résulte de la combinaison des valeurs des paramètres ProductKey et DeviceName. Si vous spécifiez à la fois le paramètre IotId et les paramètres ProductKey et DeviceName, la valeur du paramètre IotId est prioritaire.

Outre les paramètres de requête spécifiques à l'opération présentés ci-dessus, vous devez spécifier des paramètres de requête communs lors de l'appel de cette opération. Pour plus d'informations, consultez Paramètres de requête communs.

Paramètres de réponse

Parameter	Type	Example	Description
Code	String	iot.system.SystemException	Le code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations, consultez Codes d'erreur.
Data	Struct		Les détails de l'appareil renvoyés si l'appel réussit.
DeviceName	String	light	Le DeviceName de l'appareil.
DeviceSecret	String	mz2Canp4GB7qRVf1OYPNtRqB2anu****	Le DeviceSecret de l'appareil.
FirmwareVersion	String	V1.0.0.0	Le numéro de version du module OTA par défaut de l'appareil. Pour interroger les informations de version d'autres modules OTA, appelez l'opération ListOTAModuleVersionsByDevice. Les informations de version sont soumises par l'appareil.
GmtActive	String	2018-08-06 10:48:41	La date et l'heure d'activation de l'appareil, au format GMT.
GmtCreate	String	2018-08-06 10:47:50	La date et l'heure de création de l'appareil, au format GMT.
GmtOnline	String	2018-08-06 13:43:12	La date et l'heure de la dernière connexion de l'appareil, au format GMT.
IotId	String	Q7uOhVRdZRRlDnTLv****00100	L'ID de l'appareil. Il s'agit de l'identifiant unique attribué par IoT Platform à l'appareil.
IpAddress	String	10.0.0.1	L'adresse IP de l'appareil.
Nickname	String	detectors_in_beijing	L'alias de l'appareil.
NodeType	Integer	0	Le type de nœud. Valeurs possibles : 0 : appareil. Les sous-appareils ne peuvent pas être attachés à un appareil. Un appareil peut se connecter directement à IoT Platform ou en tant que sous-appareil d'une passerelle. 1 : passerelle. Les sous-appareils peuvent être attachés à une passerelle. Une passerelle peut gérer les sous-appareils, maintenir les relations topologiques avec ces derniers et synchroniser les relations topologiques vers IoT Platform.
Owner	Boolean	true	Indique si l'opération est appelée par le propriétaire de l'appareil.
ProductKey	String	a1rYuVF****	Le ProductKey du produit auquel l'appareil appartient.
ProductName	String	test	Le nom du produit auquel l'appareil appartient.
Region	String	cn-shanghai	L'ID de la région où réside l'appareil. Cette région correspond à celle d'IoT Platform. Vous pouvez consulter la région dans la console IoT Platform.
Status	String	ONLINE	L'état de l'appareil. Valeurs possibles : ONLINE : L'appareil est en ligne. OFFLINE : L'appareil est hors ligne. UNACTIVE : L'appareil n'est pas activé. DISABLE : L'appareil est désactivé.
UtcActive	String	2018-08-06T02:48:41.000Z	La date et l'heure d'activation de l'appareil, au format UTC.
UtcCreate	String	2018-08-06T02:47:50.000Z	La date et l'heure de création de l'appareil, au format UTC.
UtcOnline	String	2018-08-06T05:43:12.000Z	La date et l'heure de la dernière connexion de l'appareil, au format UTC.
ErrorMessage	String	A system exception occurred.	Le message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	L'ID de la requête.
Success	Boolean	true	Indique si l'appel a réussi. true : L'appel a réussi. false : L'appel a échoué.

Exemples

Exemples de requêtes

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceDetail
&ProductKey=a1rYuVF****
&DeviceName=device1
&<Common request parameters>

Exemples de réponses réussies

XML format

<QueryDeviceDetailResponse>
  <Data>
        <Owner>true</Owner>
        <GmtActive>2020-01-16 13:33:37</GmtActive>
        <DeviceName>Humidity</DeviceName>
        <ProductKey>a1ttsqu****</ProductKey>
        <DeviceSecret>sLefbFmN9SYfnWLJTePG893XNuRV****</DeviceSecret>
        <IpAddress>42.120.75.144</IpAddress>
        <GmtCreate>2020-01-08 14:47:08</GmtCreate>
        <UtcCreate>2020-01-08T06:47:08.000Z</UtcCreate>
        <IotId>dwnS41bhNxjslDAIF****00100</IotId>
        <Status>OFFLINE</Status>
        <UtcOnline>2020-01-17T08:19:11.091Z</UtcOnline>
        <Region>cn-shanghai</Region>
        <UtcActive>2020-01-16T05:33:37.830Z</UtcActive>
        <Nickname>Temperature and humidity</Nickname>
        <NodeType>0</NodeType>
        <GmtOnline>2020-01-17 16:19:11</GmtOnline>
        <ProductName>Light, temperature, and humidity sensor
  </Data>
  <RequestId>D2D2DE90-DD0F-44EA-9F56-63F07A59F65B</RequestId>
  <Success>true</Success>
</QueryDeviceDetailResponse>

JSON format

{
	"Data": {
		"Owner": true,
		"GmtActive": "2020-01-16 13:33:37",
		"DeviceName": "Humidity",
		"ProductKey": "a1ttsqu****",
		"DeviceSecret": "sLefbFmN9SYfnWLJTePG893XNuRV****",
		"IpAddress": "42.120.75.144",
		"GmtCreate": "2020-01-08 14:47:08",
		"UtcCreate": "2020-01-08T06:47:08.000Z",
		"IotId": "dwnS41bhNxjslDAIF****00100",
		"Status": "OFFLINE",
		"UtcOnline": "2020-01-17T08:19:11.091Z",
		"Region": "cn-shanghai",
		"UtcActive": "2020-01-16T05:33:37.830Z",
		"NickName": "Temperature and humidity",
		"NodeType": 0,
		"GmtOnline": "2020-01-17 16:19:11",
		"ProductName": "Light, temperature, and humidity sensor"
	},
	"RequestId": "D2D2DE90-DD0F-44EA-9F56-63F07A59F65B",
	"Success": true
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs API.