ClearDeviceDesiredProperty

更新时间:

ClearDeviceDesiredProperty

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

使用说明

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

请求参数

名称

类型

是否必选

示例值

描述

Action

String

ClearDeviceDesiredProperty

系统规定参数。取值:ClearDeviceDesiredProperty。

IotInstanceId

String

si-2w****

实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID

ProductKey

String

a1BwAGV****

要清空期望属性值的设备所属的产品ProductKey

DeviceName

String

light

要清空期望属性值的设备名称。

Identifies.N

RepeatList

temperature

要清空期望属性值的属性标识符列表。属性标识符个数不能超过10个。

IotId

String

Q7uOhVRdZRRlDnTLv****00100

要清空期望属性值的设备ID。物联网平台为该设备颁发的ID,设备的唯一标识符。

重要

‼️ 注意:调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数

返回数据

名称

类型

示例值

描述

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:调用失败。

示例

请求示例

curl 'https://si-d6e8d812acb848958054.tuyacloud.com:8686/?Action=ClearDeviceDesiredProperty&SignatureNonce=abe45b5e072e42a2907c4676c9244dd6&AccessKeyId=xMr9wgwXQLhv5AUa65o03mcD&Identifier.1=rain&SignatureMethod=HMAC-SHA1&Timestamp=2024-11-17T15%3A58%3A08Z&ProductKey=k1ymv1DuLfE&DeviceName=a53b1fa6490e&Signature=2wrlgD3mu6GJdSDPpie0rClWeNk%3D'

正常返回示例

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