SetDeviceProperty - IoT Platform - Centre de documentation Alibaba Cloud

Notes d'utilisation

La configuration des propriétés entre IoT Platform et l'appareil est asynchrone. Une réponse positive indique uniquement qu'IoT Platform a envoyé la requête, mais pas que l'appareil l'a reçue ou traitée. Les propriétés de l'appareil sont configurées uniquement après la réponse du SDK de l'appareil à la requête.

Important

Si les données du langage de spécification des objets (Thing Specification Language, TSL) sont de type float ou double, les valeurs de paramètre correspondantes doivent comporter au moins une décimale. Exemples : 10,0 et 11,1.

Limites QPS

Vous pouvez appeler cette opération 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 des exemples de code pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	SetDeviceProperty	Opération à effectuer. Définissez la valeur sur SetDeviceProperty.
Items	String	Yes	{"Switch":1,"Color":"blue"}	Propriétés à configurer, au format JSON. Chaque propriété se compose d'une combinaison d'un identifiant de propriété et d'une valeur de propriété au format clé:valeur. Séparez les différentes propriétés par des virgules (,). Par exemple, configurez les propriétés suivantes pour une lampe intelligente : Une propriété de commutateur dont la clé est Switch et dont le type de données est BOOLEAN. La valeur est 1. La valeur 1 indique que la lumière est allumée. Une propriété de couleur dont la clé est Color et dont le type de données est STRING. La valeur est blue. Le format JSON résultant est : `Items={"Switch":1,"Color":"blue"}` Remarque Si vous configurez des propriétés pour le module personnalisé testFb, spécifiez `Items={"testFb:Switch":1,"testFb:Color":"blue"}`. Le module testFb n'est pas le module par défaut.
IotInstanceId	String	No	iot-v64*****	ID de l'instance. Vous pouvez afficher l'ID 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 ni aucun ID n'a été généré pour votre instance, vous n'avez pas besoin de configurer ce paramètre. Pour plus d'informations, consultez Overview.
ProductKey	String	No	a1BwAGV****	ProductKey du produit auquel appartiennent les appareils. Important Si vous spécifiez une valeur pour ce paramètre, vous devez également configurer le paramètre DeviceName.
DeviceName	String	No	light	DeviceName de l'appareil. Important Si vous configurez ce paramètre, vous devez spécifier une valeur pour le paramètre ProductKey.
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	ID de l'appareil, identifiant unique attribué par IoT Platform à l'appareil. Important Le paramètre IotId spécifie un GUID pour l'appareil. La valeur du paramètre IotId équivaut à la combinaison des valeurs des paramètres ProductKey et DeviceName. Si vous spécifiez une valeur pour le paramètre IotId, il n'est pas nécessaire de spécifier les paramètres ProductKey et DeviceName. Si vous spécifiez les paramètres IotId, ProductKey et DeviceName, la valeur du paramètre IotId est prioritaire.
Qos	Integer	No	1	Niveau QoS du message. Valeurs valides : 0 (par défaut) : Le message est envoyé au plus une fois. 1 : Le message est envoyé au moins une fois. Si aucune réponse PUBACK n'est renvoyée après la publication d'un message QoS 1, le message est renvoyé lorsque l'appareil se reconnecte à IoT Platform.

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 de 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	Code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations, consultez Codes d'erreur.
Data	Struct		Données renvoyées en cas de succès.
MessageId	String	abcabc123	ID du message envoyé par IoT Platform à l'appareil.
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

Exemples de requêtes

https://iot.cn-shanghai.aliyuncs.com/?Action=SetDeviceProperty
&ProductKey=a1BwAGV****
&DeviceName=device1
&Items={"Switch":1,"Color":"blue"}
&<Common request parameters>

Exemples de réponses réussies

XML format

<SetDevicePropertyResponse>
  <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
  <Success>true</Success>
  <Data>
        <MessageId>abcabc123</MessageId>
  </Data>
</SetDevicePropertyResponse>

JSON format

{ 
  "RequestId":"57b144cf-09fc-4916-a272-a62902d5b207", 
  "Success": true, 
  "Data": {
     "MessageId":"abcabc123"
   } 
}

Codes d'erreur

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