配置设备影子预期数据

功能介绍

应用服务器可调用此接口配置设备影子的预期属性（desired区），当设备上线或者设备上报属性时把属性下发给设备。

设备影子介绍：

设备影子是一个用于存储和检索设备当前状态信息的JSON文档。

• 每个设备有且只有一个设备影子，由设备ID唯一标识

• 设备影子用于存储设备上报的(状态)属性和应用程序期望的设备(状态)属性

• 无论该设备是否在线，都可以通过该影子获取和设置设备的属性

• 设备上线或者设备上报属性时，如果desired区和reported区存在差异，则将差异部分下发给设备，配置的预期属性需在产品模型中定义且method具有可写属性“W”才可下发

• 该接口仅支持配置单个设备的设备影子的预期数据，如需多个设备的设备影子配置，请参见 创建批量任务。

限制：

设备影子JSON文档中的key不允许特殊字符：点(.)、dollar符号($)、空char(十六进制的ASCII码为00)。如果包含了以上特殊字符则无法正常刷新影子文档。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

PUT /v5/iot/{project_id}/devices/{device_id}/shadow

请求参数

响应参数

状态码： 200

请求示例

• 配置设备影子预期数据，temperature的期望值为60。

  PUT https://{endpoint}/v5/iot/{project_id}/devices/{device_id}/shadow
  
  {
    "shadow" : [ {
      "service_id" : "WaterMeter",
      "desired" : {
        "temperature" : "60"
      },
      "version" : 1
    } ]
  }

• 删除设备影子预期数据，将设备影子中属性temperature的期望值删除。

  PUT https://{endpoint}/v5/iot/{project_id}/devices/{device_id}/shadow
  
  {
    "shadow" : [ {
      "service_id" : "WaterMeter",
      "desired" : {
        "temperature" : null
      },
      "version" : 2
    } ]
  }

响应示例

状态码： 200

OK

{
  "device_id" : "40fe3542-f4cc-4b6a-98c3-61a49ba1acd4",
  "shadow" : [ {
    "service_id" : "WaterMeter",
    "desired" : {
      "properties" : {
        "temperature" : "60"
      },
      "event_time" : "20151212T121212Z"
    },
    "reported" : {
      "properties" : {
        "temperature" : "60"
      },
      "event_time" : "20151212T121212Z"
    },
    "version" : 2
  } ]
}

状态码

错误码

请参见错误码。