Queries the shadow information of a specified device.
Limits
Each Alibaba Cloud account can run a maximum of 500 queries per second (QPS).
Debugging
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 name of the device. |
ProductKey | String | Yes | a1T27vz**** |
The key of the product to which the device belongs. |
IotInstanceId | String | No | iot_instc_pu****_c*-v64******** |
The ID of the instance. This parameter is not required for public instances. However, the parameter is required for the instances that you have purchased. |
In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this API operation. For more information about common request parameters, 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 globally unique identifier that Alibaba Cloud generated for the request. |
ShadowMessage | String | {"method":"update","state":{"desired":{"color":"green"}},"version":1} |
The shadow information returned if the call is successful. Note The structure of the shadow information varies based on the status of the device.
For more information, see Configure device shadows.
|
Success | Boolean | true |
Indicates whether the call was successful.
|
Examples
Sample requests
https://iot.cn-shanghai.aliyuncs.com/?Action=GetDeviceShadow
&ProductKey=a1T27vz****
&DeviceName=device1
&<Common request parameters>
Sample success responses
XML
format
<GetDeviceShadowResponse>
<RequestId>BB71E443-4447-4024-A000-EDE09922891E</RequestId>
<Success>true</Success>
<ShadowMessage>{"method":"update","state":{"desired":{"color":"green"},"reported":"\"},"version":1}</ShadowMessage>
</GetDeviceShadowResponse>
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.