GetDeviceShadow

调用该接口查询指定设备的影子信息。

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	GetDeviceShadow	系统规定参数。取值：GetDeviceShadow。
IotInstanceId	String	是	6912917943269****	实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。
ProductKey	String	是	aldfeSe****	要查询影子信息的设备所属产品的ProductKey。
DeviceName	String	是	device1	要查询影子信息的设备名称。

返回数据

名称	类型	示例值	描述
Code	String	iot.system.SystemException	调用失败时，返回的错误码。
ErrorMessage	String	系统异常	调用失败时，返回的出错信息。
ShadowMessage	String	{"metadata":{"reported":{"color":{"timestamp":1768531159}},"desired":{"temperature":{"timestamp":1768531159}}},"state":{"reported":{"color":"333"},"desired":{"temperature":"4"}},"timestamp":1768531159,"version":1}	调用成功时，返回的设备影子信息。
RequestId	String	a78f4267e8114646880d4edd4849c6f0	为该请求生成的唯一标识符。
Success	Boolean	true	是否调用成功。 true：调用成功。 false：调用失败。

示例

请求示例

http://open.${区域}.fenydata.com/fenydata-java-open/?Action=GetDeviceShadow
&ProductKey=aldfeSe****
&DeviceName=device1
&IotInstanceId=6912917943269****
&<公共请求参数>

正常返回示例

XML格式

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xml>
  <RequestId>a78f4267e8114646880d4edd4849c6f0</RequestId>
  <Success>true</Success>
  <ShadowMessage>
    {"metadata":{"reported":{"color":{"timestamp":1768531159}},"desired":{"temperature":{"timestamp":1768531159}}},"state":{"reported":{"color":"333"},"desired":{"temperature":"4"}},"timestamp":1768531159,"version":1}
  </ShadowMessage>
</xml>

JSON格式

{
  "ShadowMessage": "{\"metadata\":{\"reported\":{\"color\":{\"timestamp\":1768531159}},\"desired\":{\"temperature\":{\"timestamp\":1768531159}}},\"state\":{\"reported\":{\"color\":\"333\"},\"desired\":{\"temperature\":\"4\"}},\"timestamp\":1768531159,\"version\":1}",
  "RequestId": "a78f4267e8114646880d4edd4849c6f0",
  "Success": true
}