Modifies a device shadow.


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 UpdateDeviceShadow

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

DeviceName String Yes device1

The name of the device whose shadow information needs to be modified.

ProductKey String Yes a1T27vz****

The ProductKey of the product to which the device belongs.

ShadowMessage String Yes null

The expected shadow information.

The shadow information includes the following parameters:

  • method: the type of the operation. Data type: string. Set the value to update.
  • state: the status of the device shadow. The desired parameter specifies the expected shadow status.
  • version: the version of the shadow. Data type: long. The specified version must be later than the current version.
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.

DeltaUpdate Boolean No false

Specifies whether to incrementally update the desired parameter of the shadow.

  • true: performs an incremental update.
  • false (default): performs a full update.

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 6754C0E7-A35D-4CC8-A684-45EB1F0008D9

The ID of the request.

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

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

Error codes

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