GetDeviceStatus - IoT Platform - Centre de documentation Alibaba Cloud

Interroge le statut d'un appareil.

Limites

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

Remarque

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

Débogage

Alibaba Cloud met à votre disposition OpenAPI Explorer pour simplifier l'utilisation des API. 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 la requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	GetDeviceStatus	L'opération que vous souhaitez effectuer. Définissez la valeur sur GetDeviceStatus.
IotInstanceId	String	Non	iot_instc_pu***_c-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 configurer ce paramètre. Si vous ne définissez pas ce paramètre, l'appel échouera. Si votre instance ne possède pas de page Overview ou d'ID, il n'est pas nécessaire de définir ce paramètre. Pour plus d'informations, consultez Overview.
ProductKey	String	Non	a1BwAGV****	La ProductKey du produit auquel l'appareil appartient. Remarque Si vous spécifiez ce paramètre, vous devez également spécifier le paramètre DeviceName.
DeviceName	String	Non	light	Le DeviceName de l'appareil. Remarque Si vous spécifiez ce paramètre, vous devez également spécifier le paramètre ProductKey.
IotId	String	Non	Q7uOhVRdZRRlDnTLv****00100	L'ID de l'appareil. L'ID est un identifiant unique émis par IoT Platform pour l'appareil. Remarque Si vous spécifiez ce paramètre, vous n'avez pas besoin de spécifier les paramètres ProductKey ou DeviceName. Le paramètre IotId spécifie un identifiant global unique (GUID) de l'appareil, qui correspond à une combinaison des paramètres ProductKey et DeviceName. Si vous spécifiez à la fois le paramètre IotId et la combinaison des paramètres ProductKey et DeviceName, le paramètre IotId est prioritaire.

En plus des paramètres de requête spécifiques à l'opération précédents, vous devez spécifier les paramètres de requête communs lors de l'appel de cette opération. Pour plus d'informations, consultez <a class="xref" data-link-href-cangjie="~~30561~~" href="/help/fr/iot/developer-reference/common-parameters" id="xref_j1p_h6d_lsl" rel="noopener noreferrer" target="_blank">Paramètres de requête communs</a>.

Paramètres de la réponse

Paramètre	Type	Exemple	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		Le statut de l'appareil renvoyé si l'appel aboutit.
Status	String	ONLINE	Le statut de l'appareil. Valeurs valides : 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é.
Timestamp	Long	1557062301656	L'heure à laquelle le statut de l'appareil a changé.
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 abouti. true : l'appel a abouti. false : l'appel a échoué.

Exemples

Exemple de requête

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

Exemple de réponse en cas de succès

Format XML

<GetDeviceStatusResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <Status>ONLINE</Status>
        <Timestamp>1557062301656</Timestamp>
  </Data>
  <Success>true</Success>
</GetDeviceStatusResponse>

Format JSON

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "Status": "ONLINE",
        "Timestamp": 1557062301656
    },
    "Success": true
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez le <a class="xref" data-link-href-cangjie="https://error-center.alibabacloud.com/status/product/Iot" href="https://error-center.alibabacloud.com/status/product/Iot" id="xref_3nk_2rz_luc" rel="noopener noreferrer" target="_blank">Centre d'erreurs de l'API</a>.