UpdateDeviceShadow - IoT Platform - Centro de documentación de Alibaba Cloud

Modifica la información de sombra de un dispositivo especificado.

Límites de QPS

Puede invocar esta operación de API hasta 500 veces por segundo por cuenta.

Nota

Los usuarios de RAM de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, se recomienda invocar esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDKs.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	UpdateDeviceShadow	La operación que desea ejecutar. Establezca el valor en UpdateDeviceShadow.
DeviceName	String	Sí	device1	El nombre del dispositivo cuya sombra desea modificar.
ProductKey	String	Sí	a1T27vz****	La ProductKey del producto al que pertenece el dispositivo.
ShadowMessage	String	Sí	{"method":"update","state":{"desired":{"color":"green"}},"version":2}	La información de sombra del dispositivo que se va a actualizar. Este parámetro incluye los siguientes campos: method: el tipo de operación. Tipo de dato: string. Establezca el valor en update. state: el estado de la sombra del dispositivo. Tipo de dato: string. El parámetro desired especifica el estado esperado de la sombra. version: la versión de la sombra del dispositivo. Tipo de dato: long. Si no se requiere control de versiones, establezca este parámetro en 0. Si se requiere control de versiones, especifique una versión posterior a la actual. Importante Si se requiere control de versiones, no consulte la versión de la sombra de un dispositivo en la consola de IoT Platform. Cuando se ejecutan simultáneamente muchas operaciones de actualización y consulta, varias actualizaciones pueden devolver la misma versión y la más reciente podría completarse primero. Esto puede provocar que la información actual de la sombra quede obsoleta. Se recomienda mantener las versiones de la sombra del dispositivo en sus instalaciones y utilizar una aplicación local para obtener la versión más reciente al invocar esta operación.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	El ID de la instancia de contenedor elástico. Consulte el ID de la instancia en la página Descripción general de la consola de IoT Platform. Importante Si su instancia tiene un ID, debe especificarlo en este parámetro. De lo contrario, la invocación fallará. Si no se ha generado ninguna página de Descripción general o ID para su instancia, no es necesario establecer este parámetro. Para obtener más información, consulte Descripción general.
DeltaUpdate	Boolean	No	false	Especifica si se debe aplicar una actualización incremental al parámetro desired. Valores válidos: true: aplica una actualización incremental. false (predeterminado): aplica una actualización completa.

Además de los parámetros de solicitud anteriores, debe especificar los parámetros de solicitud comunes al invocar esta operación. Para obtener más información, consulte Parámetros comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	El código de error devuelto si la invocación falla. Para obtener más información, consulte Códigos de error.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la invocación falla.
RequestId	String	6754C0E7-A35D-4CC8-A684-45EB1F0008D9	El ID de la solicitud.
Success	Boolean	true	Indica si la invocación se realizó correctamente. Valores válidos: true: La invocación se realizó correctamente. false: La invocación falló.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=UpdateDeviceShadow
&ProductKey=a1T27vz****
&DeviceName=device1
&ShadowMessage={"method":"update","state":{"desired":{"color":"green"}},"version":1}
&<Common request parameters>

Respuestas correctas de ejemplo

Formato XML

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

Formato JSON

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

Códigos de error

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.