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

请求参数

名称 类型 是否必需 描述
Action String 要执行的操作,取值:UpdateDeviceShadow
ProductKey String 要修改影子信息的设备所隶属的产品Key。
DeviceName String 要修改影子信息的设备名称。
ShadowMessage String

修改后的设备影子信息。示例如下:

{
"method": "update",
"state": {
"desired": {
"color": "green"
}
},
  "version": 2
}

详情参见 ShadowMessage

公共请求参数 - 请参见公共参数
表 1. ShadowMessage
名称 类型 是否必需 描述
method String 指定操作类型,取值:update
state String 设备发送给shadow的具体状态。其中,desired部分是期望的影子状态。
version String 设备影子的版本,必须大于当前影子版本。

返回参数

参数 类型 描述
RequestId String 阿里云为该请求生成的唯一标识符。
Success Boolean 表示是否调用成功。true表示调用成功,false表示调用失败。
ErrorMessage String 调用失败时,返回的出错信息。
Code String 调用失败时,返回的错误码。错误码详情,请参见错误码

示例

请求示例

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

返回示例

  • JSON格式

    {
          "RequestId":"BB71E443-4447-4024-A000-EDE09922891E",
          "Success":true,
      }
  • XML格式

    <?xml version='1.0' encoding='UTF-8'?>
      <UpdateDeviceShadowResponse>
          <RequestId>BB71E443-4447-4024-A000-EDE09922891E</RequestId>
          <Success>true</Success>
      </UpdateDeviceShadowResponse>