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

Establece los valores de las propiedades de un dispositivo específico.

Notas de uso

La configuración de propiedades entre IoT Platform y el dispositivo es asíncrona. Una respuesta exitosa solo indica que IoT Platform envió la solicitud, no que el dispositivo la haya recibido o procesado. Las propiedades del dispositivo se configuran únicamente después de que el SDK del dispositivo responda a la solicitud.

Importante

Si los datos del Thing Specification Language (TSL) son de tipo float o double, los valores de parámetro correspondientes deben contener como mínimo un decimal. Por ejemplo: 10.0 y 11.1.

Límites de QPS

Esta operación se puede invocar hasta 500 veces por segundo por cuenta.

Nota

Los usuarios 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 mayor comodidad, se recomienda invocar esta operación desde OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	SetDeviceProperty	La operación que desea ejecutar. Establezca el valor en SetDeviceProperty.
Items	String	Sí	{"Switch":1,"Color":"blue"}	Las propiedades por configurar, en formato JSON. Cada propiedad consiste en una combinación de identificador y valor en formato clave:valor. Separe varias propiedades con comas (,). Por ejemplo, configure las siguientes propiedades para una lámpara inteligente: Una propiedad de interruptor cuya clave es Switch y cuyo tipo de dato es BOOLEAN. El valor es 1. Este valor indica que la luz está encendida. Una propiedad de color cuya clave es Color y cuyo tipo de dato es STRING. El valor es blue. El formato JSON resultante es: `Items={"Switch":1,"Color":"blue"}` Nota Si configura propiedades para el módulo personalizado testFb, especifique `Items={"testFb:Switch":1,"testFb:Color":"blue"}`. El módulo testFb no es el predeterminado.
IotInstanceId	String	No	iot-v64*****	El ID de la instancia. Consulte el ID 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 llamada fallará. Si su instancia no tiene una página Descripción general ni un ID generado, omita este parámetro. Para obtener más información, consulte Descripción general.
ProductKey	String	No	a1BwAGV****	La ProductKey del producto al que pertenecen los dispositivos. Importante Si especifica un valor para este parámetro, también debe configurar el parámetro DeviceName.
DeviceName	String	No	light	El DeviceName del dispositivo. Importante Si configura este parámetro, debe especificar un valor para el parámetro ProductKey.
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	El ID del dispositivo; es decir, un identificador único que IoT Platform asigna al dispositivo. Importante El parámetro IotId especifica un GUID para el dispositivo. Su valor equivale a la combinación de los parámetros ProductKey y DeviceName. Si especifica IotId, no necesita proporcionar ProductKey ni DeviceName. Si especifica valores para IotId, ProductKey y DeviceName, el parámetro IotId tiene prioridad.
Qos	Integer	No	1	El nivel de QoS del mensaje. Valores válidos: 0 (predeterminado): El mensaje se envía como máximo una vez. 1: El mensaje se envía como mínimo una vez. Si no se recibe una respuesta PUBACK tras publicar un mensaje con QoS 1, el mensaje se reenvía cuando el dispositivo se reconecta a IoT Platform.

Además de los parámetros específicos de la operación, debe configurar los parámetros de solicitud comunes al invocar esta API. 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 llamada falla. Para obtener más información, consulte Códigos de error.
Data	Struct		Los datos devueltos en caso de éxito.
MessageId	String	abcabc123	El ID del mensaje que IoT Platform envía al dispositivo.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la llamada falla.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. true: La llamada fue exitosa. false: La llamada falló.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=SetDeviceProperty
&ProductKey=a1BwAGV****
&DeviceName=device1
&Items={"Switch":1,"Color":"blue"}
&<Common request parameters>

Respuestas exitosas de ejemplo

XML formato

<SetDevicePropertyResponse>
  <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
  <Success>true</Success>
  <Data>
        <MessageId>abcabc123</MessageId>
  </Data>
</SetDevicePropertyResponse>

JSON formato

{ 
  "RequestId":"57b144cf-09fc-4916-a272-a62902d5b207", 
  "Success": true, 
  "Data": {
     "MessageId":"abcabc123"
   } 
}

Códigos de error

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