Recomendamos fortemente que antes de começar a usar a API Cato, você reveja a Política de Suporte para a API Cato.
Visão Geral de eventsFeed
A consulta eventsFeed ajuda a analisar eventos gerados por atividades relacionadas a redes, segurança, Sockets, Clientes Cato, e mais. Os dados de evento que esta consulta retorna são semelhantes à página Monitoramento > Eventos no Aplicativo de Gerenciamento Cato.
Para contas de revendedor, você pode criar Chaves de API separadas dentro de cada conta de cliente à qual você 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 Obtidos
A chamada API eventsFeed é projetada para análise e monitoramento em grande volume de eventos em sua conta. Os dados para esta consulta API são atualizados em quase tempo real.
A Cato armazena dados de eventos dos sete dias anteriores. A cada 24 horas, os dados com mais de sete dias são excluídos.
Estes campos estão relacionados à paginação dos eventos: marcador, e fetchedCount. Veja abaixo as explicações desses campos.
Habilitando eventsFeed para Sua Conta
Use a janela de Gerenciamento de Acesso à API para habilitar sua conta a enviar eventos para o servidor da API Cato. Após habilitar eventsFeed, aguarde cerca de 30 minutos para que o servidor da API colete eventos suficientes para retornar dados para a consulta.
Para habilitar eventsFeed para sua conta:
- No painel de navegação, selecione Administração > API & Integrações e clique na aba Integração de Eventos.
- Selecione Habilitar integração com eventos da Cato. Sua conta começa a enviar eventos para o servidor da API Cato.
Detalhes para os Campos de 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 da API retornou
- fetchedCount - número de eventos obtidos (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 da API, o campo Marcador mostra um identificador que indica o início de uma nova iteração para obter eventos. Por exemplo, se a consulta retornar 7500 eventos, então estes 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 para a iteração final
fetchedCount de eventsFeed
O campo fetchedCount mostra o número total de eventos na ação de busca atual. O valor máximo para este campo é 3000.
contas de eventsFeed
Os campos Contas (eventsFeedAccountRecords) mostram os IDs da conta 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 enum de EventFieldName para os diferentes tipos de eventos, consulte a Referência da API GraphQL da Cato Networks.
Argumentos para eventsFeed
Estes são os argumentos que você pode passar e definir os dados que são retornados pela consulta:
- accountIDs - IDs das contas (para várias contas, insira os IDs como um array)
- filtros (EventFieldFilterInput) - filtrar os dados de evento e log de auditoria que são consultados (array com consultas aninhadas)
- marcador - mostrar apenas eventos para uma iteração de busca específica de acordo com o valor do marcador
Argumento ID de eventsFeed
Insira um ou mais IDs de contas Cato para os dados que a consulta retorna. Este argumento é obrigatório.
Este ID da 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 o seguinte URL: https://cc2.catonetworks.com/#!/26/topology.
Argumento de filtros de eventsFeed
O argumento filtros (EventFieldFilterInput) permite que você defina os eventos específicos que são incluídos na consulta. Estes são os argumentos que você pode definir:
- fieldName > NomeCampoFiltroEvento - definir o Tipo de Evento ou subtipo de Descoberta de Evento
- operador - definir como ativar os valores para filtrar os dados do evento
- Insira a versão do SO - definir o valor do filtro que é usado com o operador
A seguinte sintaxe de filtro é um exemplo de uma consulta que é 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 que é 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 do marcador de eventsFeed
O argumento do 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, estes são os resultados nas três primeiras iterações de busca:
- primeira iteração - contadorObtido = 3000 (Eventos), marcador = 1234abc
- segunda iteração - contadorObtido = 3000 (Eventos), marcador = 4567def
- terceira iteração - contadorObtido = 3000 (Eventos), marcador = 8901xyz
Para mostrar apenas os eventos na segunda iteração, defina o argumento marcador para 4567def.
Para buscar todos os eventos na fila, execute a consulta com um argumento de marcador vazio (marcador:"") com a consulta GraphQL inicial.
0 comentário
Por favor, entre para comentar.