Queries the shadow information of a specified device.


Each Alibaba Cloud account can run a maximum of 500 queries per second (QPS).

Note RAM users of an Alibaba Cloud account share the quota of the account.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetDeviceShadow

The operation that you want to perform. Set the value to GetDeviceShadow.

DeviceName String Yes device1

The DeviceName of the device.

ProductKey String Yes a1T27vz****

The ProductKey of the product to which the device belongs.

IotInstanceId String No iot_instc_pu****_c*-v64********

The ID of the instance. You can view the instance ID on the Overview page in the IoT Platform console.

  • If your instance has an ID, you must configure this parameter. If you do not set this parameter, the call fails.
  • If your instance has no Overview page or ID, you do not need to set this parameter.

For more information, see Overview.

In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this operation. For more information, see Common request parameters.

Response parameters

Parameter Type Example Description
Code String iot.system.SystemException

The error code returned if the call fails. For more information, see Error codes.

ErrorMessage String A system exception occurred.

The error message returned if the call fails.

RequestId String A56E345A-0978-4993-ACBA-3EF444ED187F

The ID of the request.

ShadowMessage String null

The shadow information returned if 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.
Success Boolean true

Indicates whether the call was successful.

  • true: The call was successful.
  • false: The call failed.


Sample requests

&<Common request parameters>

Sample success responses

XML format


JSON format

    "ShadowMessage": {"method":"update","state":{"desired":{"color":"green"}},"version":1},
    "RequestId": "A56E345A-0978-4993-ACBA-3EF444ED187F",
    "Success": true

Error codes

For a list of error codes, visit the API Error Center.