調用該接口查詢指定設備的影子信息。

QPS限制

單個阿里云賬號調用該接口的每秒請求數（QPS）最大限制為500。

說明 RAM用戶共享阿里云賬號配額。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 GetDeviceShadow

系統規定參數。取值：GetDeviceShadow。
DeviceName String 是 device1

要查詢的設備名稱。
ProductKey String 是 a1T27vz****

要查詢的設備所屬的產品ProductKey。

IotInstanceId String 否 iot_instc_pu****_c*-v64********

實例ID。您可在物聯網平臺控制臺的實例概覽頁面，查看當前實例的ID。

重要
  • 若有ID值，必須傳入該ID值，否則調用會失敗。
  • 若無實例概覽頁面或ID值，則無需傳入。

實例的更多信息，請參見實例概述。

調用API時，除了本文介紹的該API的特有請求參數，還需傳入公共請求參數。公共請求參數說明，請參見公共參數文檔。

返回數據

名稱 類型 示例值 描述
Code String iot.system.SystemException

調用失敗時，返回的錯誤碼。更多信息，請參見錯誤碼。

ErrorMessage String 系統異常

調用失敗時，返回的出錯信息。
RequestId String A56E345A-0978-4993-ACBA-3EF444ED187F

阿里云為該請求生成的唯一標識符。
ShadowMessage String {"method":"update","state":{"desired":{"color":"green"}},"version":1}

調用成功時，返回的設備影子信息。

說明 根據影子設備的不同狀態，查詢到的影子信息結構有所差別，詳情請參見設備影子開發。
Success Boolean true

是否調用成功。

  • true：調用成功。
  • false：調用失敗。

示例

請求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=GetDeviceShadow
&ProductKey=a1T27vz****
&DeviceName=device1
&<公共請求參數>

正常返回示例

XML格式 

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

JSON格式 

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。