SetDeviceDesiredProperty - IoT Platform - Centre de documentation Alibaba Cloud

Spécifiez les valeurs souhaitées pour plusieurs propriétés d'un appareil en une seule fois.

Notes d'utilisation

Il est impossible d'interroger les valeurs souhaitées des propriétés en lecture seule.
Spécifiez jusqu'à 10 valeurs de propriété souhaitées par appel.
Après la création d'un appareil, la valeur du paramètre Version est définie sur 0. Pour configurer le paramètre Version lors de la première spécification d'une valeur de propriété souhaitée, définissez-le sur 0.

Important

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

Limites QPS

Chaque compte Alibaba Cloud peut exécuter jusqu'à 50 requêtes par seconde (QPS).

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. 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	SetDeviceDesiredProperty	Opération à effectuer. Définissez la valeur sur SetDeviceDesiredProperty.
Items	String	Oui	{"Temperature":35}	Valeur de propriété à spécifier. Ce paramètre accepte une chaîne JSON au format Clé:Valeur. Exemple : {"Temperature":35}. Spécifiez jusqu'à 10 valeurs de propriété souhaitées. Clé spécifie l'identifiant de la propriété. Consultez l'identifiant de la propriété dans l'onglet Define Feature de la page Détails du produit dans la console IoT Platform. Vous pouvez également appeler l'opération QueryThingModel et consulter l'identifiant de la propriété dans les données TSL renvoyées. Si la propriété de température appartient à un module personnalisé nommé testFb, définissez ce paramètre sur {"testFb:temperature":35}. Remarque La propriété spécifiée doit autoriser l'accès en lecture/écriture. La configuration échoue si vous spécifiez une propriété en lecture seule. L'identifiant de la propriété doit être unique. Valeur spécifie la valeur souhaitée de la propriété. Elle doit correspondre au type de données et à la plage de valeurs définis pour la propriété. Remarque Si vous définissez Valeur sur null, la valeur souhaitée de la propriété est effacée.
Versions	String	Oui	{"Temperature":2}	Numéro de version de la valeur de propriété souhaitée. Ce paramètre accepte une chaîne JSON au format Clé:Valeur. Exemple : {"Temperature":2}. Clé spécifie l'identifiant de la propriété. Consultez l'identifiant de la propriété dans l'onglet Define Feature de la page Détails du produit dans la console IoT Platform. Remarque L'identifiant de la propriété doit être unique. Valeur spécifie le numéro de version de la valeur de propriété souhaitée. Lors de la première spécification d'une valeur de propriété souhaitée, définissez le paramètre Valeur sur 0. Après avoir défini la valeur de la propriété, le numéro de version passe à 1. Chaque spécification d'une valeur de propriété souhaitée incrémente automatiquement le numéro de version de 1. Lors de la deuxième spécification, le numéro de version passe à 2. Lors de la troisième spécification, définissez le numéro de version sur 2. Après cette spécification, le numéro de version passe à 3. Remarque Si le numéro de version spécifié ne correspond pas au numéro de version actuel, le serveur rejette la requête. Si vous ignorez le numéro de version actuel, omettez ce paramètre mais saisissez un objet JSON valide {}.
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 le spécifier pour ce paramètre. Sinon, l'appel échoue. Si aucune page Overview ni aucun ID n'est généré pour votre instance, ne configurez pas ce paramètre. Pour plus d'informations, consultez Overview.
IotId	String	Non	Q7uOhVRdZRRlDnTLv****00100	ID de l'appareil. Il s'agit d'un identifiant unique émis par IoT Platform pour l'appareil. Important Le paramètre IotId spécifie un identifiant global unique (GUID) pour l'appareil. La valeur du paramètre IotId correspond à une combinaison des valeurs des paramètres ProductKey et DeviceName. Si vous spécifiez une valeur pour ce paramètre, inutile de spécifier les paramètres ProductKey ou DeviceName. Si vous spécifiez des valeurs pour les paramètres IotId, ProductKey et DeviceName, la valeur du paramètre IotId est prioritaire.
DeviceName	String	Non	light	Nom de l'appareil. Important Si vous spécifiez une valeur pour ce paramètre, vous devez également spécifier une valeur pour le paramètre ProductKey.
ProductKey	String	Non	a1BwAGV****	ProductKey du produit auquel l'appareil appartient. Important Si vous configurez ce paramètre, vous devez également spécifier une valeur pour le paramètre DeviceName.

En plus des paramètres de requête spécifiques à l'opération mentionnés ci-dessus, configurez les paramètres de requête communs lors de l'appel de cette opération. Pour plus d'informations sur les paramètres de requête communs, consultez Paramètres communs.

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.
Data	Struct		Données renvoyées en cas de réussite de l'appel. Pour plus d'informations, consultez les paramètres suivants.
MessageId	String	300511751	ID du message que IoT Platform envoie à l'appareil pour spécifier les valeurs de propriété souhaitées.
Versions	String	{\"Temperature\":2}	Numéros de version actuels des valeurs de propriété souhaitées.
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. 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=SetDeviceDesiredProperty
&ProductKey=a1BwAGV****
&DeviceName=device1
&Items=%7B%22LightAdjustLevel%22%3A1%7D
&Versions=%7B%22LightAdjustLevel%22%3A10%7D
&<Common request parameters>

Exemples de réponses réussies

XML format

<SetDeviceDesiredPropertyResponse>
  <Data>
        <MessageId>300511751</MessageId>
        <Versions>{"LightAdjustLevel":2}</Versions>
  </Data>
  <RequestId>AADE79D2-B328-4FC6-A3E0-34BB23BCA440</RequestId>
  <Success>true</Success>
</SetDeviceDesiredPropertyResponse>

JSON format

{
    "Data": {
        "MessageId": "300511751",
        "Versions": "{\"LightAdjustLeve\":2}"
    },
    "RequestId": "AADE79D2-B328-4FC6-A3E0-34BB23BCA440",
    "Success": true
}

Codes d'erreur

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