指定されたデバイスのシャドウ情報を照会します。
QPS 制限
この API 操作は、アカウントごとに 1 秒あたり最大 500 回呼び出すことができます。
説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。
デバッグ
リクエストパラメーター
| パラメーター | タイプ | 必須 | 例 | 説明 |
| Action | String | いいえ | GetDeviceShadow | 実行する操作。 値を GetDeviceShadow に設定します。 |
| DeviceName | String | いいえ | device1 | デバイスの DeviceName。 |
| ProductKey | String | いいえ | a1T27vz**** | デバイスが属するプロダクトの ProductKey。 |
| IotInstanceId | String | いいえ | iot_instc_pu****_c*-v64******** | インスタンスの ID。 インスタンスの ID は、IoT Platform コンソールの 概要 ページで確認できます。 重要
詳細については、「概要」をご参照ください。 |
上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは、共通のリクエストパラメーターを指定する必要があります。 共通のリクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。
レスポンスパラメーター
| パラメーター | タイプ | 例 | 説明 |
| Code | String | iot.system.SystemException | 呼び出しが失敗した場合に返されるエラーコード。 エラーコードの詳細については、「エラーコード」をご参照ください。 |
| ErrorMessage | String | システム例外が発生しました。 | 呼び出しが失敗した場合に返されるエラーメッセージ。 |
| RequestId | String | A56E345A-0978-4993-ACBA-3EF444ED187F | リクエストの ID。 |
| ShadowMessage | String | {"method":"update","state":{"desired":{"color":"green"}},"version":1} | 呼び出しが成功した場合に返されるシャドウ情報。 説明 シャドウ情報の構造は、デバイスのステータスによって異なります。 詳細については、デバイスシャドウの 概要 トピックをご参照ください。 |
| Success | Boolean | true | 呼び出しが成功したかどうかを示します。有効な値：
|
例
リクエストの例
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
}エラーコード
エラーコードのリストについては、「サービスエラーコード」をご参照ください。