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

Descripción general de auditFeed

La consulta auditFeed le ayuda a analizar las acciones realizadas por los administradores en la Aplicación de Gestión de Cato. Los datos devueltos por esta consulta son similares a la ventana Sistema> Rastro de Auditoría 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 que esté conectando a la Cato API. Para más información sobre la limitación de tasa y la consulta de API auditFeed, consulte Comprendiendo la Limitación de Tasa en Cato API.

Comprendiendo los Datos Obtenidos

La llamada a la API auditFeed está diseñada para soportar la obtención de más de 2 millones de elementos de datos de auditoría por hora. Para ayudar a paginar los datos devueltos, cuando hay más de 1000 elementos de auditoría durante la duración del marco de tiempo, entonces la consulta itera la obtención hasta que devuelve todos los datos de auditoría.

Estos campos están relacionados con la paginación de los datos de auditoría: marcador, cantidadObtenida y quedanMás. Consulte a continuación para obtener explicaciones de estos campos.

Detalles de los Campos de auditFeed

Estos son los detalles que los campos de auditFeed pueden mostrar para la consulta:

• desde - hora de inicio
• hasta - hora de finalización
• marcador - El campo marcador es un identificador único para el último elemento de datos de auditoría que devolvió la consulta de API
• cantidadObtenida - número de elementos obtenidos (máximo 1000 elementos por obtención)
• quedanMás - cuando es verdadero, indica que hay más elementos por obtener en la consulta
• cuentas (auditFeedAccountRecords) - Para revendedores que gestionan múltiples cuentas, este campo especifica la cuenta que fue cambiada e incluye todos los registros y datos de auditoría (array con consultas y campos anidados)

auditFeed Desde

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

auditFeed Hasta

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

auditFeed Marcador

Cuando hay más de 1000 elementos de datos de auditoría durante la duración de la consulta, el campo Marcador muestra un identificador que indica el inicio de una nueva iteración para obtener los elementos. Por ejemplo, si la consulta devuelve 2500 elementos, entonces estos son los resultados en las iteraciones de obtención:

• primera iteración - cantidadObtenida = 1000 (elementos), marcador = 1234abc, quedanMás = verdadero
• segunda iteración - cantidadObtenida = 1000 (elementos), marcador = 4567def, quedanMás = verdadero
• tercera iteración - cantidadObtenida = 500 (elementos), marcador = 8901xyz, quedanMás = falso

  Puede ignorar el valor del marcador en la iteración final

auditFeed cantidadObtenida

Los campos cantidadObtenida muestran el número total de elementos en la acción de obtención actual. El valor máximo para este campo es 1000.

auditFeed quedanMás

Cuando el valor para el campo quedanMás es verdadero, entonces hay otra iteración de obtención de elementos después de esta.

auditFeed Cuentas

Los campos Cuentas (auditFeedAccountRecords) muestran los IDs de administrador y datos de auditoría para esta consulta. Use el argumento auditFeedAccountsRecords > AuditRecord > AuditFieldName para filtrar los datos de eventos que se muestran para la consulta. Para más información sobre los campos AuditRecords, consulte a continuación auditFeed > fieldName > AuditFieldName.

Argumentos para el auditFeed

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

• IDsDeCuenta - IDs de cuenta (para múltiples cuentas, ingrese los IDs como un array)
• ids - ID de cuenta (argumento heredado)
• marcoTiempo - hora de inicio y finalización de la consulta
• filtros (AuditFieldFilterInput) - filtrar los datos del registro de auditoría consultados (array con consultas anidadas)
• marcador - mostrar solo elementos para una iteración específica de obtención según el valor del marcador

auditFeed IDsDeCuenta Argumento

Ingrese uno o más IDs 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.

auditFeed marcoTiempo Argumento

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 admitidas para definir el marco de tiempo:

• último.<duración de tiempo> - El valor de <duración de tiempo> para el tipo último es de acuerdo con ISO-8601 y devuelve datos para los tiempos específicos anteriores. Por ejemplo:
  • marcoTiempo = último.PT5M muestra los últimos 5 minutos
  • marcoTiempo = último.PT2H muestra las últimas 2 horas
  • marcoTiempo = último.P1D muestra el último 1 día
  • marcoTiempo = último.P3M muestra los últimos 3 meses
  • marcoTiempo = último.P1A muestra el último 1 año
• <zonaHoraria>.<especificación-corta-marco-tiempo> - El marco de tiempo combina una fecha de inicio y fin en el formato AA-MM-DD/hh:mm:ss según la zona horaria especificada. Por ejemplo, marcoTiempo = utc.2020-02-{11/04:50:00--21/04:50:00} muestra datos analíticos desde el 11 de febrero de 2020 4:50:00 am hasta el 21 de febrero de 2020 4:50:00 am.

auditFeed filtros Argumento

El argumento filtros (AuditFieldFilterInput) le permite definir los elementos específicos que se incluyen en la consulta de rastro de auditoría. Estos son los argumentos que puede definir:

• nombreCampo > AuditFieldName - definir los elementos del Rastro de Auditoría
• operador - definir cómo activar los valores para filtrar los datos de auditoría
• valores - definir el valor del filtro que se usa con el operador

auditFeed > nombreCampo > AuditFieldName

Estos son los nombres de campo para los diferentes tipos de configuraciones de la Aplicación de Gestión de Cato monitoreados en Sistema > Rastro de Auditoría.

• admin - el administrador cuya acción generó el registro
• nombre_modelo - el nombre del objeto que fue afectado, por ejemplo Mi Sitio
• id_admin - el ID del administrador cuya acción generó el registro
• módulo - módulo del sistema que fue cambiado, por ejemplo Configuración de MFA o Inspección de TLS
• fecha_inserción - hora en que se realizó o guardó el cambio
• tipo_cambio - describe el cambio que el administrador realizó, los valores son: CREADO, ELIMINADO, MODIFICADO, HABILITADO, DESHABILITADO, OMITIDO
• fecha_creación - hora en que se inició el cambio
• cambio - una cuenta detallada del cambio en formato JSON
• tipo_modelo - el tipo de objeto que fue cambiado, por ejemplo Sitio, Socket, InterfazSocket

auditFeed marcador Argumento

El argumento marcador le permite limitar la consulta a los eventos para una iteración específica de obtención. Para mostrar los valores del marcador, ejecute la consulta con el argumento marcador con un valor vacío. La consulta devuelve los valores del marcador para el argumento definido marcoTiempo.

Por ejemplo, si la consulta devuelve 2500 eventos, entonces estos son los resultados en las primeras tres iteraciones de obtención:

• primera iteración - cantidadObtenida = 1000 (eventos), marcador = 1234abc, quedanMás = verdadero
• segunda iteración - cantidadObtenida = 1000 (eventos), marcador = 4567def, quedanMás = verdadero
• tercera iteración - cantidadObtenida = 1000 (eventos), marcador = 8901xyz, quedanMás = verdadero

Para mostrar solo los eventos en la segunda iteración, establezca el argumento marcador en 4567def.