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

Ejecuta una tarea de consulta relacionada con una operación de API del servicio de datos para obtener información de un origen de datos.

Notas de uso

Esta operación admite hasta cinco llamadas 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 mayor comodidad, se recomienda llamar a 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í	ListAnalyticsData	La operación que desea ejecutar. Establezca el valor en ListAnalyticsData.
ApiPath	String	Sí	/iot-cn-npk1v/system/query/hist_dev_cnt_stat	Ruta de la operación de API. Para obtener el valor del parámetro API Path en la consola de IoT Platform, vaya a la página Data Service API y consulte los detalles de la operación.
Condition.N.FieldName	String	Sí	testCode	Nombre de la columna condicional de la operación de API. Para obtener el valor de la columna condicional en la consola de IoT Platform, vaya a la página Data Service API y consulte los detalles de la operación.
Condition.N.Operate	String	Sí	=	Operador de comparación. Valores válidos: `BETWEEN`, `=`, `!=`, `LIKE`, `IN` y `NIN`. Para consultar los operadores disponibles para la columna condicional en la consola de IoT Platform, vaya a la página Data Service API y revise los detalles de la operación. `BETWEEN`: el valor de la columna condicional se encuentra dentro de un rango específico. `=`: el valor de la columna condicional es igual a un valor específico. `!=`: el valor de la columna condicional es distinto de un valor específico. `LIKE`: el valor de la columna condicional comienza con un valor específico. `IN`: el valor de la columna condicional pertenece a una colección específica. `NIN`: el valor de la columna condicional no pertenece a una colección específica. Por ejemplo, si una colección de datos tiene seis registros y el valor de la columna `time` de cada registro es `abcd`, `abce`, `abcf`, `abcg`, `aabc` y `abbc`, al llamar a la operación ListAnalyticsData, especifique time en el parámetro `Condition.N.FieldName`. Si especifica LIKE en el parámetro `Condition.N.Operate` y abc en el parámetro `Condition.N.Value`, se devuelven los registros cuya columna time tiene los siguientes valores: `abcd`, `abce`, `abcf` y `abcg`. Si especifica IN en el parámetro `Condition.N.Operate` y [abcd,abce,abcf] en el parámetro `Condition.N.Value`, se devuelven los registros cuya columna time tiene los siguientes valores: `abcd`, `abce` y `abcf`. Nota Si especifica `BETWEEN` en el parámetro Condition.N.Operate, debe configurar los parámetros Condition.N.BetweenStart y Condition.N.BetweenEnd. Si no especifica `BETWEEN` en el parámetro Condition.N.Operate, debe configurar el parámetro Condition.N.Value.
IotInstanceId	String	Sí	iot-cn-npk1u	ID de la instancia a la que pertenece la operación de API. Para más información, consulte Obtener el ID de una instancia.
IsoId	String	No	oxs_iso_id	ID del aislamiento lógico. Ignore este parámetro.
PageSize	Integer	No	100	Número de entradas por página. Valores válidos: de 1 a 100. Valor predeterminado: 100. Nota Si habilita la paginación, debe configurar este parámetro.
Condition.N.Value	String	No	4	Valor de la columna condicional. Para obtener el valor de la columna condicional en la consola de IoT Platform, vaya a la página Data Service API y consulte los detalles de la operación. Nota Si no especifica BETWEEN en el parámetro `Condition.N.Operate`, debe configurar el parámetro Condition.N.Value y no es necesario configurar los parámetros Condition.N.BetweenStart y Condition.N.BetweenEnd.
Condition.N.BetweenStart	String	No	1	Inicio del rango de valores. Para obtener el rango de valores de la columna condicional en la consola de IoT Platform, vaya a la página Data Service API y consulte los detalles de la operación. Nota Si especifica BETWEEN en el parámetro `Condition.N.Operate`, debe configurar el parámetro Condition.N.BetweenStart y no es necesario configurar el parámetro Condition.N.Value.
Condition.N.BetweenEnd	String	No	5	Fin del rango de valores. Para obtener el rango de valores de la columna condicional en la consola de IoT Platform, vaya a la página Data Service API y consulte los detalles de la operación. Nota Si especifica BETWEEN en el parámetro `Condition.N.Operate`, debe configurar el parámetro Condition.N.BetweenEnd y no es necesario configurar el parámetro Condition.N.Value.
PageNum	Integer	No	1	Número de página que se devolverá. Valor predeterminado: 1.

Además de los parámetros de solicitud específicos de la operación mencionados anteriormente, debe configurar los parámetros de solicitud comunes al llamar a esta operación. Para 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	Success	Código de respuesta. Valores válidos: Success: La llamada se realizó correctamente. Otros valores: La llamada falló. Para más información, consulte Códigos de error.
Data	Struct		Datos devueltos si la llamada es exitosa.
Count	Long	3	Número total de entradas devueltas.
HasNext	Boolean	false	Indica si existe la siguiente página. Valores válidos: true: Existe la siguiente página. false: No existe la siguiente página.
PageNum	Integer	1	Número de página.
PageSize	Integer	100	Número de entradas por página.
ResultJson	String	[{\"testCode\":\"TBB186\",\"testLevel\":5,\"testWorkYears\":3,\"testName\":\"Jack\"},{\"testCode\":\"TBB1314\",\"testLevel\":2,\"testWorkYears\":4,\"testName\":\"Tom\"},{\"testCode\":\"TBB8888\",\"testLevel\":2,\"testWorkYears\":5,\"testName\":\"Eric\"}]"	Detalles de los datos devueltos.
ErrorMessage	String	insufficient auth: no access permissions	Mensaje de error devuelto si la llamada falla.
RequestId	String	7EC5B624-AF1B-4C4D-BA82-A02BA1	ID de la solicitud.
Success	Boolean	false	Indica si la llamada se realizó correctamente. Valores válidos: true: La llamada se realizó correctamente. false: La llamada falló.

Ejemplos

Solicitudes de ejemplo

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListAnalyticsData
&ApiPath=/iot-cn-npk1v******/system/query/hist_dev_cnt_stat
&Condition.1.FieldName=testCode
&Condition.1.Operate==
&IotInstanceId=iot-cn-npk1u******
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<ListAnalyticsDataResponse>
  <RequestId> 7EC5B624-AF1B-4C4D-BA82-A02BA1******</RequestId>
  <Data>
        <ResultJson>[{\"testCode\":\"TBB186\",\"testLevel\":5,\"testWorkYears\":3,\"testName\":\"Jack\"},{\"testCode\":\"TBB1314\",\"testLevel\":2,\"testWorkYears\":4,\"testName\":\"Tom\"},{\"testCode\":\"TBB8888\",\"testLevel\":2,\"testWorkYears\":5,\"testName\":\"Eric\"}]"</ResultJson>
        <PageSize>100</PageSize>
        <PageNum>1</PageNum>
        <Count>3</Count>
        <HasNext>false</HasNext>
  </Data>
  <Code>Success</Code>
  <Success>true</Success>
</ListAnalyticsDataResponse>

Formato JSON

{
    "RequestId": "7EC5B624-AF1B-4C4D-BA82-A02BA1******",
    "Data": {
        "ResultJson": "[{\"testCode\":\"TBB186\",\"testLevel\":5,\"testWorkYears\":3,\"testName\":\"Jack\"},{\"testCode\":\"TBB1314\",\"testLevel\":2,\"testWorkYears\":4,\"testName\":\"Tom\"},{\"testCode\":\"TBB8888\",\"testLevel\":2,\"testWorkYears\":5,\"testName\":\"Eric\"}]",
        "PageSize": 100,
        "PageNum": 1,
        "Count": 3,
        "HasNext": false
    },
    "Code": "Success",
    "Success": true
}

Códigos de error

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