Call this operation to query the shadow information of a specified device.

Request parameters

Parameter Type Required Description
Action String Yes The operation that you want to perform. Set the value to GetDeviceShadow.
ProductKey String Yes The product key of the device whose shadow information you want to query.
DeviceName String Yes The name of the device whose shadow information you want to query.
Common request parameters - Yes See Common parameters.

Response parameters

Parameter Type Description
RequestId String The globally unique ID generated by Alibaba Cloud for the request.
Success Boolean Indicates whether the call is successful. A value of true indicates that the call is successful. A value of false indicates that the call has failed.
ErrorMessage String The error message returned when the call fails.
Code String The error code returned when the call fails. For more information about error codes, see Error codes.
ShadowMessage String

The shadow information returned when the call is successful.

Note The structure of the shadow information varies depending on the status of the device. For more information, see Configure device shadows.

Examples

Request example

https://iot.cn-shanghai.aliyuncs.com/?Action=GetDeviceShadow
&ProductKey=al*********
&DeviceName=device1
&Common request parameters

Response example

  • JSON format

    {
      "RequestId":"BB71E443-4447-4024-A000-EDE09922891E",
      "Success":true,
      "ShadowMessage":{"method":"update","state":{"desired":{"color":"green"},"reported":"\"},"version":1}
  }

  • XML format

    <? xml version='1.0' encoding='UTF-8'? >
  <GetDeviceShadowResponse>
      <RequestId>BB71E443-4447-4024-A000-EDE09922891E</RequestId>
      <Success>true</Success>
      <ShadowMessage>{"method":"update","state":{"desired":{"color":"green"},"reported":"\"},"version":1}</ShadowMessage>
  </GetDeviceShadowResponse>