UpdateDeviceShadow - IoT Platform - Centre de documentation Alibaba Cloud

Limites QPS

Vous pouvez appeler cette opération API jusqu'à 500 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 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

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	UpdateDeviceShadow	Opération à effectuer. Définissez la valeur sur UpdateDeviceShadow.
DeviceName	String	Oui	device1	Nom de l'appareil dont vous souhaitez modifier le shadow.
ProductKey	String	Oui	a1T27vz****	Clé ProductKey du produit auquel appartient l'appareil.
ShadowMessage	String	Oui	{"method":"update","state":{"desired":{"color":"green"}},"version":2}	Informations de shadow de l'appareil à mettre à jour. Ce paramètre comprend les champs suivants : method : type d'opération. Type de données : string. Définissez la valeur sur update. state : statut du shadow de l'appareil. Type de données : string. Le paramètre desired spécifie le statut attendu du shadow. version : version du shadow de l'appareil. Type de données : long. Si la gestion des versions n'est pas nécessaire, définissez ce paramètre sur 0. Si la gestion des versions est requise, spécifiez une version ultérieure à la version actuelle. Important Si la gestion des versions est requise, ne consultez pas la version d'un shadow d'appareil dans la console IoT Platform. Lorsqu'un grand nombre d'opérations de mise à jour et de requête sont effectuées simultanément, plusieurs opérations de mise à jour peuvent renvoyer la même version et la mise à jour la plus récente peut se terminer en premier. Cela peut rendre les informations de shadow actuelles obsolètes. Nous vous recommandons de maintenir les versions de shadow de l'appareil localement et d'utiliser une application locale pour obtenir la dernière version lors de l'appel de cette opération.
IotInstanceId	String	Non	iot_instc_pu***_c-v64********	ID de l'instance de conteneur élastique. Vous pouvez afficher l'ID d'instance sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez le spécifier 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 définir ce paramètre. Pour plus d'informations, consultez Présentation.
DeltaUpdate	Boolean	Non	false	Indique s'il faut effectuer une mise à jour incrémentielle sur le paramètre desired. Valeurs possibles : true : effectue une mise à jour incrémentielle. false (par défaut) : effectue une mise à jour complète.

Outre les paramètres de requête 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_g8c_txi_r9w" rel="noopener noreferrer" target="_blank">Paramètres communs</a>.

Paramètres de 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 Codes d'erreur.
ErrorMessage	String	A system exception occurred.	Message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	6754C0E7-A35D-4CC8-A684-45EB1F0008D9	ID de la requête.
Success	Boolean	true	Indique si l'appel a réussi. Valeurs possibles : true : L'appel a réussi. false : L'appel a échoué.

Exemples

Exemples de requêtes

https://iot.cn-shanghai.aliyuncs.com/?Action=UpdateDeviceShadow
&ProductKey=a1T27vz****
&DeviceName=device1
&ShadowMessage={"method":"update","state":{"desired":{"color":"green"}},"version":1}
&<Common request parameters>

Exemples de réponses réussies

XML format

<UpdateDeviceShadowResponse>
        <RequestId>BB71E443-4447-4024-A000-EDE09922891E</RequestId>
        <Success>true</Success>
  </UpdateDeviceShadowResponse>

JSON format

{
	"RequestId": "6754C0E7-A35D-4CC8-A684-45EB1F0008D9",
	"Success": true
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez <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_uvf_83e_rn2" rel="noopener noreferrer" target="_blank">Codes d'erreur de service</a>.