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

Consulta los registros de llamadas de servicio de un dispositivo específico.

Notas de uso

Solo puede consultar los registros de llamadas de servicio de los últimos 30 días.

Nota

El periodo de almacenamiento de un registro de llamada de servicio se calcula a partir del día en que se invoca el servicio.

Límites de QPS

Puede llamar a esta operación de API hasta 50 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, le recomendamos llamar a esta operación desde OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	QueryDeviceServiceData	La operación que desea ejecutar. Establezca el valor como QueryDeviceServiceData.
EndTime	Long	Sí	1579249499000	El final del intervalo de tiempo que se va a consultar. El valor es una marca de tiempo Unix. Unidad: milisegundos. Ejemplo: 1579249499000.
StartTime	Long	Sí	1579249499000	El inicio del intervalo de tiempo que se va a consultar. El valor es una marca de tiempo Unix. Unidad: milisegundos. Ejemplo: 1579249499000.
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 ha generado ninguna página Overview o ID para su instancia, no necesita configurar este parámetro. Para obtener más información, consulte Descripción general.
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	El ID del dispositivo. Es un identificador único que IoT Platform asigna al dispositivo. Importante El parámetro IotId especifica un GUID para el dispositivo. El valor del parámetro IotId equivale a una combinación de los valores de los parámetros ProductKey y DeviceName. Si especifica un valor para este parámetro, no necesita configurar los parámetros ProductKey ni DeviceName. Si especifica valores para los parámetros IotId, ProductKey y DeviceName, el valor del parámetro IotId tendrá prioridad.
ProductKey	String	No	a1BwAGV****	El ProductKey del producto al que pertenece el dispositivo. Importante Si especifica un valor para este parámetro, debe configurar el parámetro DeviceName.
DeviceName	String	No	light	El DeviceName del dispositivo. Importante Si especifica un valor para este parámetro, debe configurar el parámetro ProductKey.
Identifier	String	No	Set	El identificador del servicio invocado. Consulte el identificador del servicio en la pestaña Define Feature de la consola de IoT Platform. También puede llamar a la operación QueryThingModel para ver el identificador del servicio. Nota Si un servicio llamado testService pertenece a un módulo personalizado llamado testFb, establezca este parámetro como testFb:testService. El módulo personalizado no es el módulo predeterminado. Si no especifica un valor para este parámetro, el sistema consulta todos los datos de servicio del módulo predeterminado.
Asc	Integer	No.	0	El orden de clasificación de los registros de llamadas de servicio devueltos. Valores válidos: 0: orden cronológico inverso 1: orden cronológico
PageSize	Integer	No	10	El número de entradas que se devolverán en cada página. Valores válidos: de 1 a 50.

Además de los parámetros de solicitud específicos de la operación mencionados anteriormente, configure los parámetros de solicitud comunes al llamar a esta operación. Para obtener más información sobre los parámetros de solicitud comunes, 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 registros de llamadas de servicio devueltos si la llamada se realiza correctamente.
List	Array of ServiceInfo		La matriz de registros de llamadas de servicio. Cada elemento representa un registro de llamada de servicio.
ServiceInfo
Identifier	String	Set	El identificador del servicio.
InputData	String	{\"LightAdjustLevel\":123}	El parámetro de entrada del servicio. El valor es una cadena en formato MAP. Sintaxis: `key:value`.
Name	String	Set_Temperature	El nombre del servicio.
OutputData	String	{\"code\":200,\"data\":{},\"id\":\"100686\",\"message\":\"success\",\"version\":\"1.0\"}	El parámetro de salida del servicio. El valor es una cadena en formato MAP. Sintaxis: `key:value`.
Time	String	1579249499000	La hora en que se invocó el servicio.
NextTime	Long	1579335899000	La hora de inicio de los registros de llamadas de servicio en la siguiente página. Si llama a la operación QueryDeviceServiceData para consultar los registros de llamadas de servicio en la siguiente página, establezca el parámetro StartTime con el valor de este parámetro.
NextValid	Boolean	true	Indica si existe la siguiente página. true false Si el valor devuelto del parámetro NextValid es true, use el valor del parámetro NextTime como valor del parámetro StartTime cuando consulte la siguiente página de resultados.
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. Este ID identifica la solicitud de forma única.
Success	Boolean	true	Indica si la llamada se realizó correctamente. Valores válidos: true: La llamada se realizó correctamente. false: La llamada falló.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceServiceData
&ProductKey=a1BwAGV****
&DeviceName=device1
&Identifier=set
&StartTime=1516538300303
&EndTime=1516541900303
&PageSize=10
&Asc=1
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<QueryDeviceServiceDataResponse>
  <Data>
        <NextValid>true</NextValid>
        <NextTime>1517315865197</NextTime>
        <List>
              <ServiceInfo>
                    <Name>set</Name>
                    <Time>1517315865198</Time>
                    <OutputData>{"code":200,"data":{},"id":"100686","message":"success","version":"1.0"}</OutputData>
                    <InputData>{"LightAdjustLevel":123}</InputData>
                    <Identifier>set</Identifier>
              </ServiceInfo>
        </List>
  </Data>
  <RequestId>A44C818E-FA7F-4765-B1E7-01D14AE01C6A</RequestId>
  <Success>true</Success>
</QueryDeviceServiceDataResponse>

Formato JSON

{
  "Data": {
    "NextValid": true, 
    "NextTime": 1517315865197, 
    "List": {
      "ServiceInfo": [
        {
          "Name": "set", 
          "Time": 1517315865198, 
          "OutputData": "{\"code\":200,\"data\":{},\"id\":\"100686\",\"message\":\"success\",\"version\":\"1.0\"}", 
          "InputData": "{\"LightAdjustLevel\":123}", 
          "Identifier": "set"
        }
      ]
    }
  }, 
  "RequestId": "A44C818E-FA7F-4765-B1E7-01D14AE01C6A", 
  "Success": true
}

Códigos de error

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