Nós recomendamos fortemente que, antes de começar a usar a Cato API, por favor revise a Política de Suporte para a Cato API.

Visão Geral do AuditFeed

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

Para contas de revendedores, você pode criar chaves de API separadas dentro de cada conta de cliente que você está conectando à Cato API. Para mais informações sobre limite de taxa e consulta auditFeed API, consulte Compreendendo Limitação de Taxa na Cato API.

Entendendo Dados Recuperados

A chamada auditFeed API é projetada para suportar a extração de mais de 2M itens de dados de auditoria por hora. Para ajudar a paginar os dados retornados, quando há mais de 1000 itens de auditoria durante a duração da timeFrame, então a consulta itera as recuperações até que retorne todos os dados de auditoria.

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

Detalhes para os Campos do AuditFeed

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

• de - hora de início
• para - hora de término
• marcador - O campo marcador é um identificador único para o último item de dados de auditoria que a consulta API retornou
• fetchedCount - número de itens recuperados (máximo de 1000 itens por recuperação)
• hasMore - quando verdadeiro, indica que há mais itens para a consulta recuperar
• contas (auditFeedAccountRecords) - Para revendedores que gerenciam múltiplas 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 De

O campo De mostra o horário de início para os dados da consulta e é definido no argumento timeFrame.

auditFeed Para

O campo Para mostra o horário de término para os dados da consulta e é definido no argumento timeFrame.

auditFeed Marcador

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 recuperar os itens. Por exemplo, se a consulta retornar 2500 itens, então esses são os resultados sobre as iterações de recuperaçã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

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

auditFeed hasMore

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

auditFeed Contas

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

Argumentos para o AuditFeed

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

• IDs de contas - IDs de contas (para múltiplas contas, insira os IDs como um array)
• ids - ID da conta (argumento legado)
• timeFrame - hora de início e término da consulta
• filtros (AuditFieldFilterInput) - filtre os dados do log de auditoria que são consultados (array com consultas aninhadas)
• marcador - mostrar apenas itens para uma iteração específica de recuperação conforme o valor do marcador

auditFeed IDs de contas Argumento

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

Este ID de conta não é mostrado no Aplicativo de Gerenciamento Cato, em vez disso, é o número na URL para o Aplicativo de Gerenciamento Cato. Por exemplo, o ID da conta é 26 para a seguinte URL: https://cc2.catonetworks.com/#!/26/topology.

auditFeed Argumento TimeFrame

Insira o intervalo de tempo para os dados que a consulta retorna. O argumento está no formato <tipo>.<valor de tempo>. Este argumento é obrigatório.

Estas são as opções suportadas para definir o intervalo de tempo:

• último.<duração de tempo> - O valor <duração de tempo> para o tipo último está de acordo com ISO-8601 e retorna dados para os horários específicos anteriores. Por exemplo:
  • timeFrame = último.PT5M mostra os últimos 5 minutos
  • timeFrame = último.PT2H mostra as últimas 2 horas
  • timeFrame = último.P1D mostra o último 1 dia
  • timeFrame = último.P3M mostra os últimos 3 meses
  • timeFrame = último.P1Y mostra o último 1 ano
• <fuso horário>.<especificação curta de intervalo de tempo> - A especificação de intervalo de tempo combina uma data de início e término 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 analíticos de 11 de fevereiro de 2020 4:50:00 am até 21 de fevereiro de 2020 4:50:00 am.

auditFeed Argumento de Filtros

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

• fieldName > AuditFieldName - defina os itens da Trilhas de Auditoria
• operador - definir como ativar os valores para filtrar os dados de auditoria
• valores - defina o valor do filtro que é usado com o operador

auditFeed > fieldName > AuditFieldName

Estes são os nomes de campo para os diferentes tipos de configurações do Aplicativo de Gerenciamento Cato monitorados em Sistema > Trilhas de Auditoria.

• admin - o admin cuja ação gerou o registro
• model_name - o nome do objeto que foi afetado, por exemplo, Meu Site
• admin_id - o ID do admin cuja ação gerou o registro
• módulo - módulo do sistema que foi alterado, por exemplo, Configuração MFA ou Inspeção TLS
• data_inserção - período que a mudança foi realizada ou salva
• tipo_mudança - descreve a mudança que o administrador fez, os valores são: CRIADO, DELETADO, MODIFICADO, ATIVADO, DESATIVADO, PULADO
• data_criação - período que a mudança foi iniciada
• mudança - um relato detalhado da mudança em formato JSON
• tipo_modelo - o tipo de objeto que foi alterado, por exemplo, Site, Socket, SocketInterface

auditFeed Argumento Marcador

O argumento do marcador permite limitar a consulta aos eventos para uma iteração específica de recuperação. Para mostrar os valores dos marcadores, execute a consulta com o argumento do marcador com um valor vazio. A consulta retorna os valores dos marcadores para o argumento timeFrame definido.

Por exemplo, se a consulta retornar 2500 eventos, então esses são os resultados sobre as três primeiras iterações de recuperação:

• 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 para 4567def.