Recomendamos encarecidamente que antes de comenzar a usar la API de Cato, revise la Política de Soporte para la API de Cato.

Visión general de accountMetrics

La consulta accountMetrics le ayuda a analizar el estado y la calidad de las conexiones de los sitios y usuarios de SDP a la Nube de Cato. Estos datos son para el tráfico dentro del túnel DTLS entre el sitio y la Nube de Cato.

accountMetrics muestra métricas históricas, estadísticas y analíticas para la cuenta. Devuelve datos similares a la ventana de Conectividad de Sitios en la Aplicación de Gestión de Cato.

Para las cuentas de revendedores, puede crear claves API separadas dentro de cada cuenta de cliente que se conecta a la API de Cato. Para más información sobre el límite de tasa y la consulta API de accountMetrics, consulte Comprender el Límite de Tasa de la API de Cato.

Trabajar con Granularidad de Bucket y Límites de Consultas API 

Hay un límite máximo de 100.000 elementos devueltos por consulta API de accountMetrics. Si una consulta alcanza este límite, entonces la consulta no devuelve datos adicionales y se muestra un mensaje de error.

Cato calcula este límite basándose en multiplicar los siguientes elementos:

• Número total de sitios más usuarios de VPN
• Número de métricas (etiquetas API/telemetría)
• Número de buckets

En otras palabras, la suma de (sitios + usuarios de VPN) * (métricas) * (buckets) debe ser menor de 100.000. Por ejemplo, la siguiente consulta producirá un error:

• 10 sitios
• 140 usuarios de VPN 
• 5 métricas
• 150 buckets

(10 + 140) * 5 * 150 = 112.500 elementos en la consulta. En este ejemplo, puede reducir el número de buckets para ejecutar la consulta con éxito.

Para más información sobre los tipos de etiquetas API, consulte Cato API - AccountMetrics > Series Temporales.

Calculando la Granularidad Mínima para una Consulta

Esta sección explica cómo calcular la granularidad mínima (tamaño del bucket) basada en el marco de tiempo para la consulta.

1. Marco de tiempo - Convierta el marco de tiempo a segundos
2. Límite de bucket - Calcule el límite de bucket basado en 100000 / ((sitios + usuarios de VPN) * (métricas))
3. Granularidad Mínima = (marco de tiempo) / (límite de bucket)

Por ejemplo, la primera fila en la tabla a continuación muestra el límite de consulta para 7 días, 100 sitios y usuarios de VPN, con 5 métricas:

• 7 días = 604.800 segundos
• 200 buckets = 10000 / (100) * (5)
• 3024 segundos de granularidad mínima = 604800 / 200

La siguiente tabla muestra configuraciones de muestra para la consulta accountMetrics con la granularidad mínima de bucket:

Detalles para los Campos de accountMetrics

Estos son los detalles que los campos de accountMetrics pueden devolver para la consulta:

• ID - ID de la cuenta
• de - hora de inicio
• a - hora de finalización
• granularidad - tamaño del bucket
• sitios -datos que se devuelven para cada sitio (matriz con consultas y campos anidados)
• series temporales - marco de tiempo para los datos, y define la relación entre los buckets y los datos (matriz con consultas y campos anidados)

ID de accountMetrics

El campo ID muestra el ID interno único de la cuenta.

Este ID de cuenta no se muestra en la Aplicación de Gestión de Cato, en su lugar es el número en la URL de la Aplicación de Gestión de Cato. Por ejemplo, el ID de cuenta es 26 para la siguiente URL: https://cc2.catonetworks.com/#!/26/topology.

De accountMetrics

El campo De muestra la hora de inicio para los datos de la consulta y se define en el argumento timeFrame.

A accountMetrics

El campo A muestra la hora de finalización para los datos de la consulta y se define en el argumento timeFrame.

Granularidad de accountMetrics

El campo de Granularidad muestra la duración en segundos para un solo bucket de métricas. El número de buckets se define en el argumento series temporales > bucket.

La Granularidad se calcula según la siguiente fórmula: marcoDeTiempo/buckets. Por ejemplo, si la consulta está devolviendo cinco minutos de datos (marcoDeTiempo) con 60 buckets, entonces la Granularidad (tamaño del bucket) es de 5 segundos (300 segundos / 60).

La Granularidad mínima para un bucket es de 5 segundos. Cuando la Granularidad del bucket es menor de 5 segundos, entonces es posible que no se devuelvan datos para ese bucket.

Para más información sobre el campo de Granularidad, consulte Trabajar con accountMetrics > Granularidad.

Sitios de accountMetrics

El campo Sitios contiene datos relacionados con uno o más sitios en la cuenta. También puede especificar datos para usuarios de VPN con sus IDs de usuario.

Para más información sobre el campo de Sitios para accountMetrics, consulte Cato API - AccountMetrics > Sitios.

Series temporales de accountMetrics

Muestra las métricas para la cuenta según el marco de tiempo especificado (buckets) en la consulta, e incluye estadísticas y métricas históricas. Estos datos son similares al campo ventana de Conectividad de Sitios en la Aplicación de Gestión de Cato para cada sitio.

Para más información sobre el campo de series temporales para accountMetrics, consulte Cato API - AccountMetrics > Series Temporales.

Argumentos para accountMetrics

Estos son los argumentos que puede pasar y definir los datos que devuelve la consulta:

• accountID - ID de la cuenta
• ID - ID de la cuenta (argumento heredado)
• timeFrame - hora de inicio y finalización de la consulta
• groupInterfaces - Combine análisis para los enlaces en un solo enlace (para el valor booleano true)
• groupDevices - Para múltiples sitios, y un solo sitio con múltiples Sockets, combine los análisis en un solo Socket (para el valor booleano true)

Argumento accountID de accountMetrics

Ingrese el ID de cuenta para los datos que devuelve la consulta. Este argumento es obligatorio.

Este ID de cuenta no se muestra en la Aplicación de Gestión de Cato, en su lugar es el número en la URL de la Aplicación de Gestión de Cato. Por ejemplo, el ID de cuenta es 26 para la siguiente URL: https://cc2.catonetworks.com/#!/26/topology.

Argumento timeFrame de accountMetrics

Ingrese el marco de tiempo para los datos que devuelve la consulta. El argumento está en el formato <type>.<time value>. Este argumento es obligatorio.

Estas son las opciones soportadas para definir el marco de tiempo:

• último.<duración del tiempo> - El valor <duración del tiempo> para el tipo último está de acuerdo con ISO-8601 y devuelve datos para los tiempos específicos anteriores. Por ejemplo:
  • timeFrame = último.PT5M muestra los 5 minutos anteriores
  • timeFrame = último.PT2H muestra las 2 horas anteriores
  • timeFrame = último.P1D muestra el anterior 1 día
  • timeFrame = último.P3M muestra los 3 meses anteriores
  • timeFrame = último.P1Y muestra el anterior 1 año
• utc.<especificación de tiempo corto> - El marco de tiempo combina una fecha y hora de inicio y fin en el formato AA-MM-DD/hh:mm:ss según la zona horaria especificada. Debe ingresar todos los valores de fecha y hora para el argumento. Por ejemplo:
  • timeFrame = utc.2020-02-{11/04:50:00--21/04:50:00} muestra 10 días de datos analíticos desde el 11 de febrero de 2020 a las 4:50:00 am hasta el 21 de febrero de 2020 a las 4:50:00 am
  • timeFrame = utc.2020-02-11/{04:50:15--16:50:15} muestra 12 horas de datos analíticos el 11 de febrero de 2020, de 4:50:15 am a 16:50:15 pm
  • timeFrame = utc.2020-{02-11/04:50:00--04-11/04:50:00} muestra 2 meses de datos analíticos desde el 11 de febrero de 2020 a las 4:50:00 am hasta el 11 de abril a las 4:50:00 am
  • timeFrame = utc.{2019-10-01/04:50:00--2020-02-01/04:50:00} muestra 4 meses de datos analíticos desde el 1 de octubre de 2019 a las 4:50:00 am hasta el 11 de febrero de 2020 a las 4:50:00 am

    Este formato le permite configurar un marco de tiempo que incluye más de un año calendario

Para más información sobre el argumento timeFrame y el campo de Granularidad, consulte Trabajar con accountMetrics > Granularidad.

Argumento groupInterfaces de accountMetrics

Cuando el argumento booleano groupInterfaces se establece en true, los datos de todas las interfaces se agregan a una sola interfaz.

Argumento groupDevices de accountMetrics

Cuando el argumento booleano groupDevices se establece en true, los análisis para todos los Sockets (usualmente dos en alta disponibilidad) se agregan como un resultado. Para obtener los mejores resultados para los Sockets agregados, recomendamos que haya nombres y funcionalidades consistentes (por ejemplo, Destino) para los enlaces en ambos Sockets.