API de consulta de Azure Time Series Insights Gen2

  • Artículo

Información general

Las API de consulta están formadas por tres API REST, una API cada una para eventos, series y agregados.

Las API de consulta devuelven el esquema de eventos y los recuentos de eventos durante un intervalo de tiempo especificado a través de solicitudes HTTP GET con paginación opcional. La información de series y series agregadas también se expone a través de operaciones GET con paginación opcional.

API Descripción
Get Events API Devuelve una lista de eventos sin procesar que coinciden con el intervalo de búsqueda y el predicado.
Get Series API Habilita la consulta y recuperación de datos de Time Series Insights de eventos capturados mediante datos registrados en la conexión a través de las variables definidas en el modelo o en línea proporcionadas.
Aggregate Series API Permite la consulta y recuperación de datos de Time Series Insights de eventos capturados mediante la agregación de datos grabados mediante las funciones de agregado o de ejemplo.

Las API también admiten una variedad de operaciones personalizadas especificadas a través del cuerpo JSON de la solicitud HTTP. Las definiciones de consulta se pueden usar para las operaciones comunes.

Importante

Respuestas de errores

Si se produce un error en la ejecución de la consulta, la carga de respuesta JSON contendrá una respuesta de error que se ajusta a la siguiente estructura:

{
    "error" : {
        "code" : "...",
        "message" : "...",
        "innerError" : {  
            "code" : "...",
            "message" : "...",
        }
    }
}

Aquí, innerError es opcional. Además de los errores básicos, como la solicitud con formato incorrecto, se devuelven los siguientes errores:

Código de estado HTTP Código de error Mensaje de error de ejemplo Posibles códigos innerError
400 InvalidApiVersion No se admite la versión de API '2016'. Las versiones admitidas son "2016-12-12", "2018-11-01-preview". -
400 InvalidUrl No se pudo analizar la dirección URL de solicitud '/a/b'. -
400 InvalidInput La consulta especificada 'aggregate' no es válida. Las consultas admitidas son "getEvents", "getSeries", "aggregateSeries". InvalidQueryType
400 InvalidInput La expresión de serie temporal '$event.temperature.Double > 0' en 'projectedVariables.temperature.value' no es una expresión de referencia de propiedad válida. InvalidPropertyReferenceExpression
400 InvalidInput La expresión de serie temporal "$event.temperature.Double" de "projectedVariables.temperature.filter" no es válida. Solo puede ser una expresión de predicado que devuelve un valor booleano. InvalidPredicateExpression
400 InvalidInput La expresión de serie temporal "$event.temperature.Double" en "projectedVariables.temperature.aggregation" no es válida. No contenía una expresión de agregado. InvalidAggregateExpression
400 InvalidInput La expresión de serie temporal '$event.temperature.Double > 0' en 'projectedVariables.temperature.value' no es una expresión de valor válida del tipo 'numeric'. InvalidValueExpression
400 InvalidInput La expresión de serie temporal value de 'projectedVariables.temperature.value' no debe especificarse o debe ser null para la variable de tipo 'aggregate'. ValueExpressionShouldNotBeSpecified
400 InvalidInput La expresión de serie temporal value de 'projectedVariables.temperature.value' debe especificarse para el tipo de variable 'numeric'. ValueExpressionShouldBeSpecified
400 InvalidInput El tipo de variable 'aggregate' no es válido para la expresión 'min($value)' en 'projectedVariables.temperature.aggregation'. InvalidVariableKind
400 InvalidInput El intervalo de tiempo '00.00:01' en 'interval' no es un formato de intervalo de tiempo ISO8601 válido. InvalidTimeSpanFormat
400 InvalidInput No se encuentra la instancia con timeSeriesId '["ABC123"]' . InstanceNotFound
400 InvalidInput No se encuentra la instancia con el nombre "timeSeriesName". InstanceNotFound
400 InvalidInput No se puede eliminar la instancia con timeSeriesId '["ABC321"]' . Ya hay eventos ingeridos asociados a este identificador de serie temporal. CannotDeleteInstance
400 InvalidInput El entorno con el identificador '5e19f688-83fb-4aee-8321-5c123ed016b7' no admite api de consulta de series temporales. TimeSeriesQueryNotSupported
400 InvalidInput No se encontró la variable proyectada con el nombre 'temperature' en las definiciones de tipo o variable insertada. ProjectedVariableNotFound
400 InvalidInput No se puede upsert type con el identificador '7e19g688-83fb-4aee-8321-5c123ed016b7' y el nombre 'ABC123'. Este nombre ya se usa por tipo con el identificador '6e19g688-83fb-4aee-8321-5c123ed016b7'. NameAlreadyExists
400 InvalidInput No se puede actualizar la jerarquía con el identificador "4e19g688-83fb-4aee-8321-7c123ed016b7" y el nombre "XYZ123". La jerarquía ya usa este nombre con el identificador "8e39g688-83fb-4aee-8321-5c123ed016b7". HierarchyNotDefined
400 InvalidInput El número de instancias superó el límite de "1000 000". NumberOfInstancesExceededLimit
400 InvalidInput El número de tipos superó el límite de "1000". NumberOfTypesExceededLimit
400 InvalidInput El número de jerarquías superó el límite de "32". NumberOfHierarchiesExceededLimit
400 InvalidInput El tamaño de la entidad es mayor que el tamaño máximo permitido "16 384". ObjectSizeExceededLimit
400 InvalidInput El nombre de objeto 'ABC123' con longitud '6' supera el límite máximo de caracteres permitido de '5'. NameExceededLimit
408 RequestTimeout Se agota el tiempo de espera de la solicitud después de "30" segundos. BatchRequestSizeExceededLimit
503 TooManyRequests Se superó el número de solicitudes simultáneas de "30" para el entorno "95880732-01b9-44ea-8d2d-4d764dfe1904". EnvRequestLimitExceeded

Consulte también

  • Para más información sobre el registro de aplicaciones y el modelo de programación de Azure Active Directory, consulte Azure Active Directory para desarrolladores.

  • Para obtener información sobre los parámetros de solicitud y autenticación, lea Autenticación y autorización.

  • Entre las herramientas que ayudan a probar las solicitudes y respuestas HTTP se incluyen las siguientes:

  • Fiddler. Este proxy de depuración web gratuito puede interceptar las solicitudes REST, por lo que puede diagnosticar los mensajes de solicitud y respuesta HTTP.

  • JWT.io. Puede usar esta herramienta para volcar rápidamente las notificaciones en el token de portador y, a continuación, validar su contenido.

  • Postman. Se trata de una herramienta gratuita de prueba de solicitudes y respuestas HTTP para depurar las API REST.

  • Para obtener más información sobre Azure Time Series Insights Gen2, revise la documentación de Gen2.