调用该接口修改指定设备的影子信息。

QPS限制

单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为500。

说明 RAM用户共享阿里云账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 UpdateDeviceShadow

系统规定参数。取值：UpdateDeviceShadow。
DeviceName String 是 device1

要修改影子信息的设备名称。
ProductKey String 是 a1T27vz****

要修改影子信息的设备所隶属的产品ProductKey。
ShadowMessage String 是 {"method":"update","state":{"desired":{"color":"green"}},"version":2}

修改后的设备影子信息。

影子信息参数中包含：

  • method：String，指定操作类型，取值：update。
  • state：String，发送给影子的具体状态，由desired参数表示期望的影子状态。
  • version：Long，设备影子的版本。
    • 若无需版本控制，该值设置为0。
    • 若需要版本控制，该值必须大于当前影子版本。
重要 需要版本控制时，不能直接从物联网平台查询当前影子版本。因为更新和查询操作并发量高时，可能导致多个更新操作查询到同一个影子版本。基于此情况，最后一次发起的更新操作可能先完成，进而导致最终更新的影子信息不是最新的影子信息。所以，建议您本地维护影子版本，调用本接口时，从本地应用获取最新影子版本。
IotInstanceId String 否 iot_instc_pu****_c*-v64********

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

重要
  • 若有ID值，必须传入该ID值，否则调用会失败。
  • 若无实例概览页面或ID值，则无需传入。

实例的更多信息，请参见实例概述。
DeltaUpdate Boolean 否 false

是否增量更新设备影子desired参数。

  • true：增量更新。
  • false（默认）：全量更新。

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

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

调用失败时，返回的错误码。更多信息，请参见错误码。
ErrorMessage String 系统异常

调用失败时，返回的出错信息。
RequestId String 6754C0E7-A35D-4CC8-A684-45EB1F0008D9

阿里云为该请求生成的唯一标识符。
Success Boolean true

是否调用成功。

  • true：调用成功。
  • false：调用失败。

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=UpdateDeviceShadow
&ProductKey=a1T27vz****
&DeviceName=device1
&ShadowMessage={"method":"update","state":{"desired":{"color":"green"}},"version":1}
&<公共请求参数>

正常返回示例

XML格式

<UpdateDeviceShadowResponse>
        <RequestId>BB71E443-4447-4024-A000-EDE09922891E</RequestId>
        <Success>true</Success>
  </UpdateDeviceShadowResponse>

JSON格式

{
	"RequestId": "6754C0E7-A35D-4CC8-A684-45EB1F0008D9",
	"Success": true
}

错误码

访问错误中心查看更多错误码。