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 sitios y usuarios 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 análisis para la cuenta. Devuelve datos similares a la ventana Conectividad de Sitios en la Aplicación de Gestión de Cato.

Para cuentas de revendedores, puede crear claves de API separadas dentro de cada cuenta de cliente a la que se esté conectando a la API de Cato. Para más información sobre limitación de tasa y la consulta de API de accountMetrics, vea Comprender la Limitación de Tasa de la API de Cato.

Trabajando con la Granularidad de Bucket y los Límites de Consulta de API

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

Cato calcula este límite multiplicando los siguientes elementos:

• Número total de sitios más usuarios de VPN
• Número de métricas (etiquetas de 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 exitosamente la consulta.

Para más información sobre los tipos de etiquetas de API, vea API de Cato - AccountMetrics > Timeseries.

Calculando la Granularidad Mínima para una Consulta

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

1. Marco de tiempo - Convertir el marco de tiempo a segundos
2. Límite de bucket - Calcular 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 ejemplo para la consulta de 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 cuenta
• desde - hora de inicio
• hasta - hora de finalización
• granularidad - tamaño de bucket
• sitios -datos que se devuelven para cada sitio (matriz con consultas y campos anidados)
• timeseries - 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.

Desde accountMetrics

El campo Desde muestra la hora de inicio para los datos de la consulta y se define en el argumento de marco de tiempo.

Hasta accountMetrics

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

Granularidad de accountMetrics

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

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

La Granularidad mínima para un bucket es de 5 segundos. Cuando la Granularidad de 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 Granularidad, vea Trabajando 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 Sitios para accountMetrics, vea API de Cato - AccountMetrics > Sitios.

Timeseries de accountMetrics

Muestra las métricas para la cuenta de acuerdo con el marco de tiempo especificado (buckets) en la consulta, e incluye estadísticas históricas y métricas. 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 timeseries para accountMetrics, vea API de Cato - AccountMetrics > Timeseries.

Argumentos para los accountMetrics

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

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

Argumento accountMetrics accountID

Ingrese el ID de cuenta para los datos que la consulta devuelve. 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 marco de tiempo de accountMetrics

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

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

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

Argumento groupInterfaces de accountMetrics

Cuando el argumento booleano groupInterfaces está establecido en verdadero, entonces los datos para todas las interfaces se agregan a una sola interfaz.

Argumento groupDevices de accountMetrics

Cuando el argumento booleano groupDevices está establecido en verdadero, entonces el análisis para todos los Sockets (generalmente dos en alta disponibilidad) se agrega como un solo resultado. Para obtener los mejores resultados para Sockets agregados, recomendamos que haya nombres y funcionalidades consistentes (por ejemplo, Destino) para los enlaces en ambos Sockets.