GetDeviceShadow - IoT Platform - Centre de documentation Alibaba Cloud

Limites de QPS

Vous pouvez appeler cette opération jusqu’à 500 fois par seconde et par compte.

Remarque

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

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d’utiliser OpenAPI Explorer pour appeler cette opération. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	No	GetDeviceShadow	L’opération à effectuer. Définissez la valeur sur GetDeviceShadow.
DeviceName	String	No	device1	Le nom de l’appareil (DeviceName).
ProductKey	String	No	a1T27vz****	La ProductKey du produit auquel l’appareil est associé.
IotInstanceId	String	No	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 l’instance possède un ID, vous devez spécifier le paramètre IotInstanceId. À défaut, l’appel échouera. Si l’instance ne possède pas d’ID ou si la page Overview n’est pas affichée, il n’est pas nécessaire de spécifier ce paramètre. Pour plus d’informations, consultez la rubrique Vue d’ensemble.

Outre les paramètres de requête spécifiques à l’opération, vous devez inclure les paramètres de requête communs lors de l’appel. Pour plus d’informations, consultez la section Paramètres 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 la section Codes d’erreur.
ErrorMessage	String	A system exception occurred.	Le message d’erreur renvoyé en cas d’échec de l’appel.
RequestId	String	A56E345A-0978-4993-ACBA-3EF444ED187F	L’ID de la requête.
ShadowMessage	String	{"method":"update","state":{"desired":{"color":"green"}},"version":1}	Les informations de shadow renvoyées en cas de succès de l’appel. Remarque La structure des informations de shadow varie selon l’état de l’appareil. Pour plus d’informations, consultez la rubrique Vue d’ensemble des shadows d’appareil.
Success	Boolean	true	Indique si l’appel a réussi. Valeurs possibles : true : L’appel a réussi. false : L’appel a échoué.

Exemples

Exemple de requête

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

Exemple de réponse réussie

Format XML

<GetDeviceShadowResponse>
  <RequestId>A56E345A-0978-4993-ACBA-3EF444ED187F</RequestId>
  <ShadowMessage>{"method":"update","state":{"desired":{"color":"green"}},"version":1}</ShadowMessage>
  <Success>true</Success>
</GetDeviceShadowResponse>

Format JSON

{
    "RequestId": "A56E345A-0978-4993-ACBA-3EF444ED187F",
    "ShadowMessage": "{\"method\":\"update\",\"state\":{\"desired\":{\"color\":\"green\"}},\"version\":1}",
    "Success": true
}

Codes d’erreur

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