Recomendamos fortemente que, antes de começar a usar o Cato API, revise a Política de Suporte para o Cato API.

Visão geral do auditFeed

A consulta auditFeed ajuda você a analisar as ações realizadas por administradores no Aplicativo de Gerenciamento Cato. Os dados que esta consulta retorna são semelhantes à janela Sistema> Trilha de Auditoria no Aplicativo de Gerenciamento Cato.

Para contas de revendedor, você pode criar chaves API separadas dentro de cada conta de cliente que está conectando ao Cato API. Para mais informações sobre limitação de taxa e a consulta de API do auditFeed, veja Compreendendo a Limitação de Taxas da Cato API.

Entendendo os Dados Obtidos

The auditFeed API call is designed to support pulling over 2M items of audit data per hour. Para ajudar a paginar os dados retornados, quando houver mais de 1000 itens de auditoria durante a duração do Período de Tempo, a consulta itera o fetch até devolver todos os dados de auditoria.

Esses campos estão relacionados à paginação dos dados de auditoria: marcador, fetchedCount e hasMore. Veja abaixo as explicações desses campos.

Detalhes dos Campos do auditFeed

Estes são os detalhes que os campos do auditFeed podem mostrar para a consulta:

de - hora de início
para - hora de fim
marker - The marker field is a unique identifier for the last item of audit data that the API query returned
fetchedCount - número de itens obtidos (máximo de 1000 itens por solicitação)
hasMore - quando verdadeiro, indica que há mais itens para a consulta obter
contas (auditFeedAccountRecords) - Para revendedores que gerenciam várias contas, este campo especifica a conta que foi alterada e inclui todos os registros e dados de auditoria (array com consultas e campos aninhados)

auditFeed From

O campo De mostra a hora de início para os dados da consulta e é definido no argumento de Período de Tempo.

auditFeed To

O campo Para mostra a hora de término para os dados da consulta e é definido no argumento de Período de Tempo.

auditFeed Marker

Quando há mais de 1000 itens de dados de auditoria durante a duração da consulta, o campo Marcador mostra um identificador que indica o início de uma nova iteração para obter os itens. Por exemplo, se a consulta retornar 2500 itens, estes são os resultados nas iterações de obtenção:

primeira iteração - fetchedCount = 1000 (itens), marcador = 1234abc, hasMore = true
segunda iteração - fetchedCount = 1000 (itens), marcador = 4567def, hasMore = true
terceira iteração - fetchedCount = 500 (itens), marcador = 8901xyz, hasMore = false
Você pode ignorar o valor do marcador na iteração final

auditFeed fetchedCount

Os campos fetchedCount mostram o número total de itens na ação de obtenção atual. O valor máximo para este campo é 1000.

auditFeed hasMore

Quando o valor do campo hasMore é verdadeiro, há outra iteração de obtenção de itens após esta.

auditFeed Accounts

Os campos Contas (auditFeedAccountRecords) mostram os IDs de administradores e dados de auditoria para esta consulta. Use o argumento auditFeedAccountsRecords > AuditRecord > Nome do Campo de Auditoria para filtrar os dados de eventos que são exibidos para a consulta. Para mais informações sobre os campos AuditRecords, veja abaixo auditFeed > Nome do Campo > Nome do Campo de Auditoria.

Argumentos para o auditFeed

Estes são os argumentos que você pode passar e definir os dados que a consulta retorna:

accountIDs - account IDs (for multiple accounts, enter the IDs as an array)
ids - ID de conta (argumento legado)
timeFrame - starting and ending time of the query
filtros (Filtro de Entrada de Campo de Auditoria) - filtrar os dados do log de auditoria que são consultados (array com consultas aninhadas)
marcador - mostrar somente itens para uma iteração de obtenção específica de acordo com o valor do marcador

auditFeed accountIDs Argument

Digite um ou mais IDs de conta para os dados que a consulta retorna. Este argumento é obrigatório.

This account ID isn't shown in the Cato Management Application, instead it is the number in the URL for the Cato Management Application. For example, the account ID is 26 for the following URL: https://cc2.catonetworks.com/#!/26/topology.

auditFeed timeFrame Argument

Digite o período de tempo para os dados que a consulta retorna. O argumento está no formato <tipo>.<valor do tempo>. Este argumento é obrigatório.

Estas são as opções suportadas para definir o período de tempo:

último.<duração do tempo> - O valor <duração do tempo> para o tipo último está de acordo com ISO-8601 e retorna dados para os tempos específicos anteriores. Por exemplo:
- timeFrame = last.PT5M shows the previous 5 minutes
- timeFrame = last.PT2H shows the previous 2 hours
- timeFrame = last.P1D shows the previous 1 day
- timeFrame = last.P3M mostra os últimos 3 meses
- timeFrame = last.P1Y mostra o último 1 ano
<timezone>.<short-time-frame-spec> - O período combina uma data de início e fim no formato YY-MM-DD/hh:mm:ss de acordo com o fuso horário especificado. Por exemplo, timeFrame = utc.2020-02-{11/04:50:00--21/04:50:00} mostra dados de análises de 11 de fevereiro de 2020 4:50:00 am a 21 de fevereiro de 2020 4:50:00 am.

Argumento de Filtros de Auditoria

O argumento de filtros (AuditFieldFilterInput) permite que você defina o item específico que está incluído na consulta de trilha de auditoria. Estes são os argumentos que você pode definir:

Nome do campo > AuditFieldName - define os itens da Trilha de Auditoria
operador - define como ativar os valores para filtrar os dados de auditoria
valores - define o valor do filtro que é usado com o operador

auditFeed > Nome do campo > AuditFieldName

Estes são os nomes dos campos para os diferentes tipos de configurações da Aplicativo de Gerenciamento Cato monitoradas em Sistema > Trilha de Auditoria.

administrador - o administrador cuja ação gerou o registro
nome_modelo - o nome do objeto que foi afetado, por exemplo Meu Site
admin_id - o ID do administrador cuja ação gerou o registro
módulo - Módulo do sistema que foi alterado, por exemplo, Configuração de MFA ou Inspeção TLS
data_inserção - hora em que a alteração foi realizada ou salva
tipo_alteração - descreve a alteração que o administrador fez, os valores são: CRIADO, ELIMINADO, MODIFICADO, ATIVADO, DESABILITADO, IGNORADO
data_criação - hora em que a alteração foi iniciada
alteração - um relato detalhado da alteração no formato JSON
tipo_modelo - o tipo de objeto que foi alterado, por exemplo Local, Socket, InterfaceSocket

Argumento de Marcador de auditFeed

O argumento marcador permite que você limite a consulta aos eventos para uma iteração específica. Para mostrar os valores do marcador, execute a consulta com o argumento marcador com um valor vazio. A consulta retorna os valores do marcador para o argumento de período de tempo definido.

Por exemplo, se a consulta retornar 2500 eventos, então estes são os resultados nas primeiras três iterações de busca:

primeira iteração - fetchedCount = 1000 (eventos), marcador = 1234abc, hasMore = true
segunda iteração - fetchedCount = 1000 (eventos), marcador = 4567def, hasMore = true
terceira iteração - fetchedCount = 1000 (eventos), marcador = 8901xyz, hasMore = true

Para mostrar apenas os eventos na segunda iteração, defina o argumento marcador como 4567def.

Cato API - AuditFeed