すべてのプロダクト
Search

このプロダクト

    IoT Platform:UpdateDeviceShadow

    ドキュメントセンター

    IoT Platform:UpdateDeviceShadow

    最終更新日:Apr 17, 2025

    デバイスシャドウを変更します。

    QPS 制限

    この API 操作は、アカウントごとに 1 秒あたり最大 500 回呼び出すことができます。

    説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

    デバッグ

    OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

    リクエストパラメーター

    パラメーター タイプ 必須 例 説明
    Action String Yes UpdateDeviceShadow

    実行する操作。値を UpdateDeviceShadow に設定します。
    DeviceName String Yes device1

    シャドウ情報を変更するデバイスの名前。
    ProductKey String Yes a1T27vz****

    デバイスが属するプロダクトの ProductKey。
    ShadowMessage String Yes {"method":"update","state":{"desired":{"color":"green"}},"version":2}

    デバイスシャドウに指定する情報。

    情報には、次のパラメーターが含まれます。

    • method: 操作のタイプ。データ型: 文字列。update に設定します。
    • state: デバイスシャドウのステータス。データ型: 文字列。desired パラメーターは、期待されるシャドウステータスを指定します。
    • version: デバイスシャドウのバージョン。データ型: long。
      • バージョン管理が不要な場合は、このパラメーターを 0 に設定します。
      • バージョン管理が必要な場合は、現在のバージョンよりも後のバージョンを指定します。
    重要 バージョン管理が必要な場合は、IoT Platform コンソールでデバイスシャドウのバージョンをクエリしないでください。多数の更新操作とクエリ操作が同時に行われると、複数の更新操作が同じバージョンを返す可能性があります。この場合、最新の更新操作が最初に完了する可能性があります。その結果、現在のシャドウ情報は最新のシャドウ情報ではありません。オンプレミスデバイスでデバイスシャドウのバージョンを維持することをお勧めします。この操作を呼び出すときは、オンプレミスアプリケーションを使用してデバイスシャドウの最新バージョンを取得します。
    IotInstanceId String No iot_instc_pu****_c*-v64********

    エラスティックコンテナーインスタンスの ID です。 IoT Platform コンソール の [概要] ページでインスタンスの ID を確認できます。

    重要
    • インスタンスに ID がある場合は、このパラメーターに ID を指定する必要があります。指定しないと、呼び出しは失敗します。
    • インスタンスに 概要 ページまたは ID が生成されていない場合は、このパラメーターを設定する必要はありません。

    詳細については、「概要」をご参照ください。
    DeltaUpdate Boolean No false

    desired パラメーターで増分更新を実行するかどうかを指定します。有効な値：

    • true: 増分更新を実行します。
    • false: フルアップデートを実行します。これはデフォルト値です。

    上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは、共通のリクエストパラメーターを設定する必要があります。共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

    レスポンスパラメーター

    パラメーター タイプ 例 説明
    Code String iot.system.SystemException

    呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
    ErrorMessage String A system exception occurred.

    呼び出しが失敗した場合に返されるエラーメッセージ。
    RequestId String 6754C0E7-A35D-4CC8-A684-45EB1F0008D9

    リクエストの ID。
    Success Boolean true

    呼び出しが成功したかどうかを示します。有効な値：

    • true: 呼び出しは成功しました。
    • false: 呼び出しは失敗しました。

    例

    リクエストの例

    https://iot.cn-shanghai.aliyuncs.com/?Action=UpdateDeviceShadow
&ProductKey=a1T27vz****
&DeviceName=device1
&ShadowMessage={"method":"update","state":{"desired":{"color":"green"}},"version":1}
&<共通リクエストパラメーター>

    成功レスポンスの例

    XML 形式

    <UpdateDeviceShadowResponse>
        <RequestId>BB71E443-4447-4024-A000-EDE09922891E</RequestId>
        <Success>true</Success>
  </UpdateDeviceShadowResponse>

    JSON 形式

    {
	"RequestId": "6754C0E7-A35D-4CC8-A684-45EB1F0008D9",
	"Success": true
}

    エラーコード

    エラーコードの一覧については、「サービスエラーコード」をご参照ください。