ClearDeviceDesiredProperty - IoT Platform - Centre de documentation Alibaba Cloud

Notes d'utilisation

Le paramètre Identifies est obligatoire. Sans ce paramètre, l'appel échoue.
Chaque appel prend en charge jusqu'à 10 identifiants de propriété dans le paramètre Identifies.
Une fois les valeurs de propriété souhaitées effacées, l'opération QueryDeviceDesiredProperty renvoie le paramètre Identifier mais pas le paramètre Value pour les propriétés concernées.

Limites QPS

Chaque compte Alibaba Cloud peut appeler cette opération jusqu'à 50 fois par seconde.

Remarque

Les utilisateurs RAM d'un compte Alibaba Cloud partagent le quota du 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	ClearDeviceDesiredProperty	L'opération à effectuer. Définissez la valeur sur ClearDeviceDesiredProperty.
IotInstanceId	String	No	iot-2w****	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 spécifier ce paramètre. Sinon, l'appel échoue. Si aucune page Overview ou aucun ID n'est généré pour votre instance, inutile de spécifier ce paramètre. Pour plus d'informations, consultez Overview.
ProductKey	String	No	a1BwAGV****	ProductKey du produit auquel appartient l'appareil. Remarque Si vous spécifiez une valeur pour ce paramètre, vous devez également configurer le paramètre DeviceName.
DeviceName	String	No	light	Nom de l'appareil (DeviceName). Remarque Si vous spécifiez une valeur pour ce paramètre, vous devez également configurer le paramètre ProductKey.
Identifies.N	RepeatList	No	temperature	Identifiants des propriétés dont vous souhaitez supprimer les valeurs souhaitées. Vous pouvez spécifier jusqu'à 10 identifiants de propriété.
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	ID de l'appareil, identifiant unique attribué par IoT Platform. Remarque Le paramètre IotId correspond à l'identifiant global unique (GUID) de l'appareil. Sa valeur équivaut à la combinaison des paramètres ProductKey et DeviceName. Si vous spécifiez IotId, il n'est pas nécessaire de configurer ProductKey ni DeviceName. Si vous spécifiez les trois paramètres (IotId, ProductKey et DeviceName), la valeur de IotId est prioritaire.

Outre les paramètres spécifiques à l'opération ci-dessus, vous devez spécifier les paramètres de requête communs. 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 la section « Error codes » de cette rubrique.
Data	Struct		Données renvoyées en cas de succès de l'appel.
Versions	String	{\"temperature\":0}	Numéros de version les plus récents des valeurs de propriété souhaitées après suppression des valeurs spécifié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

Exemple de requête

https://iot.cn-shanghai.aliyuncs.com/?Action=ClearDeviceDesiredProperty
&ProductKey=a1BwAGV****
&DeviceName=device1
&Identifies.1=temperature
&<Common request parameters>

Exemple de réponse réussie

Format XML

<ClearDeviceDesiredPropertyResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <Versions>{"temperature":0}</Versions>
  </Data>
  <Code></Code>
  <Success>true</Success>
</ClearDeviceDesiredPropertyResponse>

Format JSON

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "Versions": "{\"temperature\":0}"
    },
    "Code": "",
    "Success": true
}

Codes d'erreur

HttpCode	Error code	Error message	Description
400	iot.device.InvalidFormattedDeviceName	The DeviceName format is invalid.	Format du paramètre DeviceName non valide.
400	iot.device.NotSupportExemptionValidateType	The feature does not support the specified verification type.	La fonctionnalité ne prend pas en charge le modèle TSL de type sans vérification.
400	iot.prod.NotExistedProduct	The specified product does not exist.	Le produit spécifié n'existe pas.
400	iot.prod.QueryProductPropertyFailed	An error occurred while querying the product property.	Échec de la requête sur la propriété du produit.
400	iot.check.InvalidFormattedParameter	The parameter format is invalid.	Format de la valeur du paramètre non valide.
400	Iot.digitaltwin.DTInstanceInvalidThingType	The digital twin operation is not supported.	Cette opération ne prend pas en charge les données de type jumeau numérique.
400	iot.check.NullParameter	Specify parameter is null.	Aucune valeur n'est spécifiée pour le paramètre.
400	iot.device.CanNotSetReadOnlyProperty	Cannot set read only property.	Impossible d'interroger les valeurs souhaitées des propriétés en lecture seule.
400	iot.device.DeviceIsDisable	The specified device has been disabled.	L'appareil est désactivé.
400	iot.device.InvalidIoTId	The specified device ID is invalid.	ID de l'appareil non valide.
400	iot.device.NullDeviceName	The DeviceName parameter cannot be empty.	Le paramètre DeviceName est vide.
400	iot.prod.NullProductKey	The ProductKey parameter cannot be empty.	Le paramètre ProductKey est vide.
400	iot.prod.InvalidFormattedProductkey	The ProductKey format is invalid.	Format de la valeur du paramètre ProductKey non valide.
400	iot.common.InvalidTenant	The Invalid tenant.	Locataire non valide ou échec de création.
400	iot.prod.QueryPropertyNotFound	Query property not found.	Les propriétés interrogées n'existent pas.
400	iot.device.ClearPropertyDesiredFailed	Failed to clear desired value of property.	Échec de la suppression des valeurs de propriété souhaitées.
400	iot.prod.QueryProductAbilitiesNotFound	query product abilities not found.	La fonctionnalité du produit interrogée n'existe pas.
400	iot.Device.NotExistedDevice	This device does not exist.	L'appareil n'existe pas ou n'est pas activé.
400	iot.prod.NullAbilityIdentifier	You must specify a feature identifier.	Aucun identifiant n'est spécifié pour la fonctionnalité.
400	iot.system.IllegalRequest	The request parameter is invalid.	Valeur du paramètre de requête non valide.

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