QueryDeviceInfo - IoT Platform - Centre de documentation Alibaba Cloud

Consulte les informations de base d’un appareil spécifié, notamment son ID, son certificat et son alias.

Limites

Chaque compte Alibaba Cloud peut exécuter au maximum 500 requêtes par seconde (QPS).

Remarque

Les utilisateurs RAM d’un compte Alibaba Cloud partagent le quota de ce compte.

Débogage

Alibaba Cloud met à votre disposition OpenAPI Explorer pour simplifier l’utilisation des API. Cet outil calcule automatiquement la valeur de signature. Nous vous recommandons d’appeler cette opération via OpenAPI Explorer, qui génère également des exemples de code adaptés aux différents SDK.

Paramètres de la requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	QueryDeviceInfo	Opération à exécuter. Définissez la valeur sur QueryDeviceInfo.
IotInstanceId	String	Non	iot_instc_pu***_c-v64********	ID de l’instance. Consultez l’ID de l’instance sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez configurer ce paramètre. À défaut, l’appel échouera. Si votre instance ne dispose pas de page Overview ou d’ID, il n’est pas nécessaire de définir ce paramètre. Pour plus d’informations, consultez la rubrique Overview.
ProductKey	String	Non	a1BwAGV****	ProductKey du produit auquel l’appareil est associé. Important Si vous spécifiez ce paramètre, vous devez également indiquer le paramètre DeviceName.
DeviceName	String	Non	light	DeviceName de l’appareil. Important Si vous spécifiez ce paramètre, vous devez également indiquer le paramètre ProductKey.
IotId	String	Non	Q7uOhVRdZRRlDnTLv****00100	ID de l’appareil. Important Si vous spécifiez ce paramètre, il n’est pas nécessaire d’indiquer les paramètres ProductKey ou DeviceName. Le paramètre IotId correspond à l’identifiant global unique (GUID) de l’appareil, associé à la combinaison des paramètres ProductKey et DeviceName. Si vous indiquez à la fois le paramètre IotId et la combinaison des paramètres ProductKey et DeviceName, le paramètre IotId est prioritaire.

Outre les paramètres spécifiques à cette opération, vous devez inclure les paramètres de requête communs lors de l’appel. Pour plus d’informations, consultez la rubrique Paramètres de requête communs.

Paramètres de la réponse

Paramètre	Type	Exemple	Description
Code	String	iot.system.SystemException	Code d’erreur renvoyé en cas d’échec de l’appel. Pour plus d’informations, consultez la rubrique Codes d’erreur.
Data	Struct		Informations relatives à l’appareil renvoyées en cas de succès de l’appel.
DeviceName	String	light	DeviceName de l’appareil.
DeviceSecret	String	mz2Canp4GB7qRVf1OYPNtRqB2anu****	DeviceSecret de l’appareil.
IotId	String	Q7uOhVRdZRRlDnTLv****00100	ID de l’appareil. Il s’agit de l’identifiant unique attribué par IoT Platform à l’appareil.
Nickname	String	detectors_in_beijing	Alias de l’appareil.
ProductKey	String	a1rYuVF****	ProductKey du produit auquel l’appareil est associé.
ErrorMessage	String	A system exception occurred.	Message d’erreur renvoyé en cas d’échec de l’appel.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	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

Exemple de requête

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceInfo
&ProductKey=a1rYuVF****
&DeviceName=light
&<Common request parameters>

Exemple de réponse en cas de succès

Format XML

<QueryDeviceInfoResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <IotId>Q7uOhVRdZRRlDnTLv****00100</IotId>
        <DeviceSecret>mz2Canp4GB7qRVf1OYPNtRqB2anu****</DeviceSecret>
        <ProductKey>a1rYuVF****</ProductKey>
        <Nickname>detectors_in_beijing</Nickname>
        <DeviceName>light</DeviceName>
  </Data>
  <Success>true</Success>
</QueryDeviceInfoResponse>

Format JSON

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "IotId": "Q7uOhVRdZRRlDnTLv****00100",
        "DeviceSecret": "mz2Canp4GB7qRVf1OYPNtRqB2anu****",
        "ProductKey": "a1rYuVF****",
        "Nickname": "detectors_in_beijing",
        "DeviceName": "light"
    },
    "Success": true
}

Codes d’erreur

HttpCode	Code d’erreur	Message d’erreur	Description
200	Iot.common.QueryDeviceActionError	An error occurred while querying the device.	Message d’erreur indiquant que le système n’a pas pu récupérer les informations de l’appareil.

Pour obtenir la liste des codes d’erreur, consultez le Centre d’erreurs de l’API.