Recomendamos fortemente que antes de começar a usar a API Cato, você reveja a Política de Implantação para a API Cato.

Visão geral do eventsFeed

A consulta eventsFeed ajuda você a analisar eventos gerados por atividades relacionadas a rede, segurança, Sockets, Clientes Cato e mais. Os dados de eventos que esta consulta retorna são semelhantes à página Monitoramento > Eventos no Aplicativo de Gerenciamento Cato.

Para contas de revendedores, você pode criar chaves de API separadas dentro de cada conta de cliente que está se conectando à API Cato. Para mais informações sobre limitações de taxa e a consulta da API eventsFeed, consulte Entendendo as Limitações de Taxa da API Cato.

Entendendo Eventos Buscados

A chamada da API eventsFeed é projetada para análise e monitoramento de alto volume de eventos na sua conta. Os dados para esta consulta de API são atualizados quase em tempo real.

A Cato armazena dados de eventos pelos três dias anteriores. A cada 24 horas, os dados que têm mais de três dias são excluídos.

Esses campos estão relacionados à paginação dos eventos: marcador e fetchedCount. Veja abaixo as explicações desses campos.

Habilitar eventsFeed para Sua Conta

Use a janela de Gerenciamento de Acesso API para habilitar sua conta para enviar eventos ao servidor API Cato. Após habilitar eventsFeed, espere cerca de 30 minutos para que o servidor API colete eventos suficientes para retornar dados para a consulta.

Para habilitar eventsFeed para sua conta:

1. No painel de navegação, selecione Administração > Integrações e clique na aba Integração de Eventos.
2. Selecione Habilitar integração com eventos Cato. Sua conta começa a enviar eventos para o servidor API Cato.

Detalhes para os Campos do eventsFeed

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

• marcador - O campo marcador é um identificador único para o último evento que a consulta API retornou
• fetchedCount - número de eventos buscados (máximo de 3000 eventos por busca)
• contas (eventsFeedAccountRecords) - dados de eventos para a conta (array com consultas e campos aninhados)

Marcador de eventsFeed

Quando há mais de 3000 eventos na fila do servidor API, o campo Marcador mostra um identificador que indica o início de uma nova iteração para buscar eventos. Por exemplo, se a consulta retornar 7500 eventos, então esses são os resultados ao longo das iterações de busca:

• primeira iteração - fetchedCount = 3000 (eventos), marcador = 1234abc
• segunda iteração - fetchedCount = 3000 (eventos), marcador = 4567def

• terceira iteração - fetchedCount = 1500 (eventos), marcador = 8901xyz

  Você pode ignorar o valor do marcador na última iteração

Marcadores podem apontar para a fila de eventos até os três dias anteriores.

eventsFeed fetchedCount

O campo fetchedCount mostra o número total de eventos na ação de busca atual. O valor máximo para este campo é 3000.

eventsFeed Contas

Os campos Contas (eventsFeedAccountRecords) mostram os IDs de contas e dados de eventos para esta consulta. Use o argumento eventsFeedAccountsRecords > EventRecord > EventFieldName para filtrar os dados de eventos que são exibidos para a consulta. Para mais informações sobre os EventRecords, consulte Cato API - EventsFeed > EventRecord.

eventsFeed > registros > EventFieldName

Para mais informações sobre os valores de enumeração de EventFieldName para os diferentes tipos de eventos, veja o Referência da API GraphQL Cato Networks.

Argumentos para o eventsFeed

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

• IDs de conta - IDs de conta (para múltiplas contas, insira os IDs como um array)
• filtros (EventFieldFilterInput) - filtrar os dados de eventos e log de auditoria que são consultados (array com consultas aninhadas)
• marcador - mostrar apenas eventos para uma iteração de busca específica conforme o valor do marcador

Argumento ID do eventsFeed

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

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

Argumento de filtros do eventsFeed

O argumento de filtros (EventFieldFilterInput) permite definir os eventos específicos que são incluídos na consulta. Estes são os argumentos que você pode definir:

• fieldName > EventFeedFilterFieldName - definir o tipo ou subtipo de evento a partir da Descoberta de Eventos
• operador - definir como ativar os valores para filtrar os dados de eventos
• valores - definir o valor de filtro que é usado com o operador

A seguinte sintaxe de filtro é um exemplo de uma consulta filtrada para mostrar tipos de eventos com o valor Segurança:

"filters": [
{
"fieldName": "event_type",
"operator": "is",
"values": ["Segurança"]
}
]

A seguinte sintaxe de filtro é um exemplo de uma consulta filtrada para mostrar apenas subtipos de eventos com o valor Firewall de Internet:

"filters": [
{
"fieldName": "event_sub_type",
"operator": "is",
"values": ["Firewall de Internet"]
}
]

Argumento marcador do eventsFeed

O argumento marcador é obrigatório e permite limitar a consulta aos eventos para uma iteração de busca específica. Por exemplo, se a consulta retornar 10500 eventos, então esses são os resultados ao longo das primeiras três iterações de busca:

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

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

Para buscar todos os eventos na fila, execute a consulta com um argumento marcador vazio (marcador:"") na consulta GraphQL inicial.