BatchQueryDeviceDetail - IoT Platform - Centre de documentation Alibaba Cloud

Remarques sur l'utilisation

Vous pouvez interroger jusqu'à 100 appareils en un seul appel.
Seuls les appareils appartenant au compte Alibaba Cloud actuel peuvent être interrogés. Si vous spécifiez un appareil qui n'appartient pas au compte actuel, un message d'erreur est renvoyé.
Si vous spécifiez des appareils inexistants, seuls les détails des appareils existants sont renvoyés.

Limites QPS

Vous pouvez appeler cette opération API jusqu'à cinq fois par seconde par compte.

Remarque

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

Débogage

OpenAPI Explorer calcule automatiquement la valeur de la 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	BatchQueryDeviceDetail	L'opération que vous souhaitez effectuer. Définissez la valeur sur BatchQueryDeviceDetail.
DeviceName.N	RepeatList	Yes	light	Les DeviceNames des appareils. Vous pouvez spécifier jusqu'à 100 DeviceNames. Remarque Les appareils doivent appartenir au même produit.
ProductKey	String	Yes	a1BwAGV****	Le ProductKey du produit auquel appartiennent les appareils dont les DeviceNames sont spécifiés par le paramètre DeviceName.N.
IotInstanceId	String	No	iot-v64***	L'ID de l'instance. Vous pouvez afficher 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 Présentation des instances.

En plus des paramètres de requête spécifiques à l'opération, vous devez configurer les paramètres de requête communs lors de l'appel à 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	Le code d'erreur renvoyé si l'appel échoue. Pour plus d'informations, consultez Codes d'erreur.
Data	Array of Data		Les détails de l'appareil renvoyés si l'appel réussit.
Data
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	2019-06-21 20:33:00	L'heure d'activation de l'appareil. L'heure est au format GMT.
GmtCreate	String	2019-06-21 20:31:42	L'heure de création de l'appareil. L'heure est au format GMT.
IotId	String	Q7uOhVRdZRRlDnTLv****00100	L'ID de l'appareil. Cet identifiant unique est émis par IoT Platform pour l'appareil.
Nickname	String	Smart street light	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 les sous-appareils et synchroniser les relations topologiques avec IoT Platform.
ProductKey	String	a1BwAGV****	Le ProductKey du produit auquel appartient l'appareil.
ProductName	String	Street light	Le nom du produit auquel appartient l'appareil.
Region	String	cn-shanghai	L'ID de région de l'appareil. Il s'agit de la même région que celle d'IoT Platform. Vous pouvez afficher 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	2019-06-21T12:31:42.000Z	L'heure d'activation de l'appareil. L'heure est au format UTC.
UtcCreate	String	2019-06-21T12:31:42.000Z	L'heure de création de l'appareil. L'heure est au format UTC.
ErrorMessage	String	A system exception occurred.	Le message d'erreur renvoyé si l'appel échoue.
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=BatchQueryDeviceDetail
&ProductKey=a1fce6J****
&DeviceName.1=firstDeviceName
&DeviceName.2=secondDeviceName
&<Common request parameters>

Exemples de réponses réussies

XML format

<BatchQueryDeviceDetailResponse>
  <Data>
        <Data>
              <DeviceName>Humidity</DeviceName>
              <GmtActive>2020-01-16 13:33:37</GmtActive>
              <ProductKey>a1ttsqu****</ProductKey>
              <DeviceSecret>sLefbFmN9SYfnWLJTePG893XNuRV****</DeviceSecret>
              <GmtCreate>2020-01-08 14:47:08</GmtCreate>
              <UtcCreate>2020-01-08T06:47:08.000Z</UtcCreate>
              <IotId>dwnS41bhNxjslDAIF****00100</IotId>
              <Status>OFFLINE</Status>
              <UtcActive>2020-01-08T06:47:08.000Z</UtcActive>
              <Region>cn-shanghai</Region>
              <NickName>Temperature and humidity</NickName>
              <NodeType>0</NodeType>
              <ProductName>Light, temperature, and humidity sensor</ProductName>
        </Data>
        <Data>
              <Status>OFFLINE</Status>
              <GmtActive>2020-01-17 16:23:15</GmtActive>
              <DeviceName>TH_sensor</DeviceName>
              <Region>cn-shanghai</Region>
              <UtcActive>2020-01-17T03:39:14.000Z</UtcActive>
              <ProductKey>a1ttsqu****</ProductKey>
              <NodeType>0</NodeType>
              <DeviceSecret>dCYdTU3gw5Z77bsHjPk6lPHPVnBT****</DeviceSecret>
              <ProductName>Light, temperature, and humidity sensor</ProductName>
              <GmtCreate>2020-01-17 11:39:14</GmtCreate>
              <UtcCreate>2020-01-17T03:39:14.000Z</UtcCreate>
              <IotId>RKYkCRstfGBh5SZXL****00100</IotId>
        </Data>
  </Data>
  <RequestId>D4C12DD8-4390-4877-B1DC-4049CF4868BC</RequestId>
  <Success>true</Success>
</BatchQueryDeviceDetailResponse>

JSON format

{
	"Data": {
		"Data": [
			{
				"DeviceName": "Humidity",
				"GmtActive": "2020-01-16 13:33:37",
				"ProductKey": "a1ttsqu****",
				"DeviceSecret": "sLefbFmN9SYfnWLJTePG893XNuRV****",
				"GmtCreate": "2020-01-08 14:47:08",
				"UtcCreate": "2020-01-08T06:47:08.000Z",
				"IotId": "dwnS41bhNxjslDAIF****00100",
				"Status": "OFFLINE",
				"UtcActive": "2020-01-08T06:47:08.000Z",
				"Region": "cn-shanghai",
				"NickName": "Temperature and humidity",
				"NodeType": 0,
				"ProductName": "Light, temperature, and humidity sensor"
			},
			{
				"Status": "OFFLINE",
				"GmtActive": "2020-01-17 16:23:15",
				"DeviceName": "TH_sensor",
				"Region": "cn-shanghai",
				"UtcActive": "2020-01-17T03:39:14.000Z",
				"ProductKey": "a1ttsqu****",
				"NodeType": 0,
				"DeviceSecret": "dCYdTU3gw5Z77bsHjPk6lPHPVnBT****",
				"ProductName": "Light, temperature, and humidity sensor",
				"GmtCreate": "2020-01-17 11:39:14",
				"UtcCreate": "2020-01-17T03:39:14.000Z",
				"IotId": "RKYkCRstfGBh5SZXL****00100"
			}
		]
	},
	"RequestId": "D4C12DD8-4390-4877-B1DC-4049CF4868BC",
	"Success": true
}

Codes d'erreur

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