ClearDeviceDesiredProperty

更新时间：2024-09-14 06:46:15下载pdf

调用该接口清空设备已设置的期望属性值。

使用说明

调用本接口时，必须传入要清空的属性标识符（Identifies）。如果不传入Identifies，调用会失败。
单次调用本接口，Identifies最多可传入10个属性标识符。
调用本接口清空期望属性值成功后，调用[QueryDeviceDesiredProperty]接口查询期望属性值时，会返回对应参数Identifier（属性标识符），不会返回对应参数Value了。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	ClearDeviceDesiredProperty	系统规定参数。取值：ClearDeviceDesiredProperty。
IotInstanceId	String	否	iot-2w****	实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的 ID。重要 + 若有ID值，必须传入该 ID值，否则调用会失败。 + 若无实例概览页面或 ID值，则无需传入。实例的更多信息，请参见实例概述。
ProductKey	String	否	a1BwAGV****	要清空期望属性值的设备所属的产品ProductKey。说明如果传入该参数，需同时传入DeviceName。
DeviceName	String	否	light	要清空期望属性值的设备名称。说明如果传入该参数，需同时传入ProductKey。
Identifies.N	RepeatList	否	temperature	要清空期望属性值的属性标识符列表。属性标识符个数不能超过10个。
IotId	String	否	Q7uOhVRdZRRlDnTLv****00100	要清空期望属性值的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。说明 IotId作为设备唯一标识符，和 ProductKey与 DeviceName组合是一一对应的关系。如果传入该参数，则无需传入 ProductKey和 DeviceName。如果您同时传入 IotId和 ProductKey与 DeviceName组合，则以 IotId为准。

返回数据

名称	类型	示例值	描述
Code	String	iot.system.SystemException	调用失败时，返回错误码。详细信息，请参见下文错误码。
Data	Struct		调用成功时，返回的数据。
Versions	String	{“temperature”:0}	本次清空期望属性值后，对应属性的期望属性值的最新版本号。
ErrorMessage	String	系统异常	调用失败时，返回的出错信息。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	涂鸦云为该请求生成的唯一标识符。
Success	Boolean	true	是否调用成功。 + true：调用成功。 + false：调用失败。

示例

请求示例

https://iot.****.tuya.com/?Action=ClearDeviceDesiredProperty
&ProductKey=a1BwAGV****
&DeviceName=device1
&Identifies.1=temperature
&<公共请求参数>

正常返回示例

JSON格式

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

上一篇QueryDevicePropertyStatus

下一篇错误码