SetDeviceDesiredProperty

更新时间:

SetDeviceDesiredProperty

调用该接口为指定设备批量设置期望属性值。

使用说明

●只读属性不支持设置期望属性值。 ●一次调用最多可设置10个期望属性值。 ●设备创建后,期望属性值的版本(Version)为0。首次设置期望属性值时,如果指定Version参数,则需指定Version值为0

请求参数

名称

类型

是否必选

示例值

描述

Action

String

SetDeviceDesiredProperty

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

Items

String

{"Temperature":35}

要设置的期望属性值,组成为属性的Key:Value,数据格式为JSON String,例如{"Temperature":35}。最多可输入10个期望属性值。

Key取值为属性的标识符(identifier)。可在控制台中,设备所属产品的功能定义中查看;

Versions

String

{"Temperature":2}

当前期望属性值版本,组成为Key:Value,数据格式为JSON String,例如{"Temperature":2}。

IotInstanceId

String

si********

实例ID。您可在物联网平台控制台的服务实例详情页面,查看当前实例的ID

IotId

String

Q7uOhVRdZRRlDnTLv****00100

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

DeviceName

String

light

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

ProductKey

String

a1BwAGV****

要设置期望属性值的设备所隶属的产品ProductKey。

Expiration

Long

60

生效时间。设置后多久后失效

单位:秒

重要

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

返回数据

名称

类型

示例值

描述

Code

String

iot.system.SystemException

调用失败时,返回的错误码。更多信息,请参见错误码

Data

Struct

调用成功时,返回的数据。详情请参见以下参数。

MessageId

String

300511751

云端下发给设备的设置期望属性值的消息ID。

Versions

String

{\"Temperature\":2}

本次设置期望属性值后,期望属性值的当前版本号。

ErrorMessage

String

系统异常

调用失败时,返回的出错信息。

RequestId

String

E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

该请求生成的唯一标识符。

Success

Boolean

true

是否调用成功。

  • true:调用成功。

  • false:调用失败。

示例

请求示例

curl 'https://si-d6e8d812acb848958054.tuyacloud.com:8686/?Action=SetDeviceDesiredProperty&Versions=%7B%22rain%22%3A3%7D&SignatureNonce=d9d8ec362be94685a5d9162440069971&IotInstanceId=iot-06z00j616bccotp&AccessKeyId=xMr9wgwXQLhv5AUa65o0****&SignatureMethod=HMAC-SHA1&Items=%7B%22rain%22%3A13%7D&Timestamp=2024-11-17T15%3A46%3A48Z&ProductKey=k1ymv1DuLfE&DeviceName=a53b1fa6490e&Signature=wG60ouULKZUq%2Bjcgi%2BCZZyEef3A%3D'

正常返回示例

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