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

Consulta los valores deseados de las propiedades de un dispositivo.

Notas de uso

No es posible consultar los valores deseados de propiedades de solo lectura.
Puede consultar los valores deseados de hasta 10 propiedades en una sola llamada.

Límites de QPS

Esta operación de API admite hasta 50 llamadas 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 ejecutar esta operación en OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo correspondiente a distintos SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	QueryDeviceDesiredProperty	La operación que se va a ejecutar. Establezca el valor en QueryDeviceDesiredProperty.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	El ID de la instancia. Consulte el ID de la instancia en la página Overview 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 no se generó una página Overview ni un ID para su instancia, no es necesario configurar este parámetro. Para obtener más información, consulte Descripción general.
ProductKey	String	No	a1BwAGV****	La ProductKey del producto al que pertenece el dispositivo. Nota Si especifica un valor para este parámetro, también debe configurar el parámetro DeviceName.
DeviceName	String	No	light	El DeviceName del dispositivo. Nota Si especifica un valor para este parámetro, también debe configurar el parámetro ProductKey.
Identifier.N	RepeatList	No	Temperature	Los identificadores de las propiedades que desea consultar. Para ver los identificadores de propiedades, vaya a la pestaña Define Feature de la página Product Details en la consola de IoT Platform. Puede especificar hasta 10 identificadores de propiedad en una sola llamada. Cada identificador de propiedad debe ser único. Si no configura este parámetro, se devolverán los valores deseados de todas las propiedades.
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	El ID del dispositivo. Es un identificador único que IoT Platform asigna al dispositivo. Nota Si especifica un valor para este parámetro, no necesita configurar los parámetros ProductKey ni DeviceName. El parámetro IotId define un GUID para el dispositivo y equivale a la combinación de los valores de ProductKey y DeviceName. Si se proporcionan valores para IotId, ProductKey y DeviceName, el valor de IotId tendrá prioridad.
FunctionBlockId	String	No	BatteryModule	El identificador del módulo TSL personalizado. Cada identificador es único dentro de un producto. Si no configura este parámetro, el sistema consultará los datos del módulo predeterminado.

Además de los parámetros de solicitud específicos de esta operación, debe configurar los parámetros de solicitud comunes al realizar la llamada. Para obtener más información sobre estos parámetros, 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 el parámetro List cuando la llamada es exitosa.
List	Array of DesiredPropertyInfo		La información de las propiedades deseadas devuelta en el parámetro DesiredPropertyInfo.
DesiredPropertyInfo
DataType	String	int	El tipo de dato de la propiedad.
Identifier	String	Temperature	El identificador de la propiedad.
Name	String	airconditioning	El nombre de la propiedad.
Time	String	1579335899000	La hora de la última modificación del valor deseado de la propiedad. Unidad: milisegundos.
Unit	String	°C	La unidad de medida de la propiedad.
Value	String	34	El valor deseado de la propiedad. Nota Si ejecuta la operación ClearDeviceDesiredProperty para eliminar el valor deseado de la propiedad, no se devolverá el parámetro Value.
Version	Long	1	La versión del valor deseado.
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=QueryDeviceDesiredProperty
&IotId=SR8FiTu1R9tlUR2****0010300
&Identifier.1=Weight
&Identifier.2=Circle
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<QueryDeviceDesiredPropertyResponse>
  <Data>
        <List>
              <DesiredPropertyInfo>
                    <Name>Temperature</Name>
                    <Value>35</Value>
                    <Time>1581778567154</Time>
                    <DataType>float</DataType>
                    <Version>1</Version>
                    <Identifier>Temperature</Identifier>
                    <Unit>°C</Unit>
              </DesiredPropertyInfo>
        </List>
  </Data>
  <RequestId>F0B1F7C8-A799-44C3-BDF8-1B8F9E91E675</RequestId>
  <Success>true</Success>
</QueryDeviceDesiredPropertyResponse>

Formato JSON

{
  "Data": {
    "List": {
      "DesiredPropertyInfo": [
        {
          "Name": "Temperature", 
          "Value": "35", 
          "Time": "1581778567154", 
          "DataType": "float", 
          "Version": 1, 
          "Identifier": "Temperature", 
          "Unit": "°C"
        }
      ]
    }
  }, 
  "RequestId": "F0B1F7C8-A799-44C3-BDF8-1B8F9E91E675", 
  "Success": true
}

Códigos de error

Para obtener una lista de códigos de error, consulte los códigos de error del Servicio.