方舟物联网使用手册

# SetDeviceProperty

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

# 接口说明

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

# 请求参数

# 请求方式1

名称 类型 是否必选 示例值 描述
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"}说明当前只存在默认模块
IotInstanceId String 是 6912917943269**** 实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。
ProductKey String 是 a1BwAGV**** 设备所属的产品ProductKey。
DeviceName String 是 light 设备名称。
Qos Integer 否 1 指定调用本接口时，消息的发送方式。取值：0（默认）：最多发送一次。1：最少发送一次。

# 请求方式2

名称 类型 是否必选 示例值 描述
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"}说明当前只存在默认模块
IotInstanceId String 是 6912917943269**** 实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。
IotId String 是 Q7uOhVRdZRRlDnTLv****00100 设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。
Qos Integer 否 1 指定调用本接口时，消息的发送方式。取值：0（默认）：最多发送一次。1：最少发送一次。

# 返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException 调用失败时，返回的错误码。
Data Struct 调用成功时，返回的数据。
MessageId String 2983119386 云端给设备下发属性设置的消息ID。
ErrorMessage String 系统异常 调用失败时，返回的出错信息。
RequestId String cAMeAT6qyGYTD76DkJZHWj8ba0pWZWam 平台为该请求生成的唯一标识符。
Success Boolean true 是否调用成功。true：调用成功。false：调用失败。

# 示例

请求示例

http://open.${区域}.fenydata.com/fenydata-java-open/?Action=SetDeviceProperty
&ProductKey=a1rYuVF****
&IotInstanceId=70255861902711****
&DeviceName=light
&Items=%7B%22Switch%22%3A1%2C%22Color%22%3A%22blue%22%7D
&<公共请求参数>

正常返回示例

XML格式

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xml>
    <RequestId>AmlS9XiJLrRrC7YtPNDWNODrb1t6xinc</RequestId>
    <Success>true</Success>
    <Data>
        <MessageId>2983119386</MessageId>
    </Data>
</xml>

JSON格式

{
  "RequestId": "AmlS9XiJLrRrC7YtPNDWNODrb1t6xinc",
  "Success": true,
  "Data": {
    "MessageId": "2983119386"
  }
}

← 批量设置设备属性值 →