通过SetDeviceProperty为指定设备设置属性值_云市场(Marketplace)-阿里云帮助中心

SetDeviceProperty

调用该接口为指定设备设置属性值。

使用说明

因为云端下发属性设置命令和设备收到并执行该命令是异步的，所以调用该接口时，返回的成功结果只表示云端下发属性设置的请求成功，不能保证设备端收到并执行了该请求。即需设备端SDK成功响应云端设置设备属性值的请求，设备属性值才能真正设置成功。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	SetDeviceProperty	系统规定参数。取值：SetDeviceProperty。
Items	String	是	{"Switch":1,"Color":"blue"}	要设置的属性信息，数据格式为JSON。每个属性信息由标识符与属性值（key:value）构成，多个属性用英文逗号隔开。例如，设置智能灯的如下两个属性：标识符为Switch的开关属性，数据类型为Bool，设置值为1（开）。标识符为Color的灯颜色属性，数据类型为String，设置值为blue。那么要设置的属性信息，JSON格式如下： `Items={"Switch":1,"Color":"blue"}`
ProductKey	String	否	a1BwAGV****	设备所属的产品ProductKey。
DeviceName	String	否	light	设备名称。
IotId	String	否	Q7uOhVRdZRRlDnTLv****00100	设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。

重要

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

返回数据

名称	类型	示例值	描述
Code	String	iot.system.SystemException	调用失败时，返回的错误码。更多信息，请参见错误码。
Data	Struct		调用成功时，返回的数据。
MessageId	String	abcabc123	云端给设备下发属性设置的消息ID。
ErrorMessage	String	系统异常	调用失败时，返回的出错信息。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	为该请求生成的唯一标识符。
Success	Boolean	true	表示是否调用成功。 true：调用成功。 false：调用失败。

示例

请求示例

curl 'https://si-d6e8d812acb848958054.tuyacloud.com:8686/?Action=SetDeviceProperty&SignatureNonce=105918e0402545458ed4cf0fa3be3537&AccessKeyId=xMr9wgwXQLhv5AUa65o03mcD&SignatureMethod=HMAC-SHA1&Items=%7B%22rain%22%3A3%7D&Timestamp=2024-11-19T10%3A16%3A17Z&ProductKey=k1ymv1DuLfE&DeviceName=myTestDevice&Signature=2XbIvrEvlDzkI26xL%2BG7qtLTIkA%3D'

正常返回示例

{ 
  "RequestId":"57b144cf-09fc-4916-a272-a62902d5b207", 
  "Success": true, 
  "Data": {
     "MessageId":"abcabc123"
   } 
}