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

Visão Geral de accountMetrics

A consulta accountMetrics ajuda você a analisar o estado e a qualidade das conexões de sites e Usuários SDP à Cato Cloud. Esses dados são para o tráfego dentro do túnel DTLS entre o site e a Cato Cloud.

accountMetrics mostra métricas históricas, estatísticas e análises para a conta. Ele retorna dados similares à janela de Conectividade de Site no Aplicativo de Gerenciamento da Cato.

Para contas de revendedor, você pode criar chaves de API separadas dentro de cada conta de cliente que estiver conectando à API da Cato. Para mais sobre limitações de taxa e a consulta API accountMetrics, veja Compreendendo a Limitação de Taxa da API da Cato.

Trabalhando com Granularidade de Bucket e Limites de Consulta API

Há um limite máximo de 100.000 itens retornados por consulta API accountMetrics. Se uma consulta alcançar esse limite, ela não retornará dados adicionais e uma mensagem de erro será exibida.

A Cato calcula esse limite com base na multiplicação dos seguintes elementos:

• Número total de sites mais usuários VPN
• Número de métricas (rótulos API/telemetria)
• Número de buckets

Em outras palavras, a soma de (sites + usuários VPN) * (métricas) * (buckets) deve ser menor que 100.000. Por exemplo, a seguinte consulta produzirá um erro:

• 10 Sites
• 140 Usuários VPN
• 5 métricas
• 150 buckets

(10 + 140) * 5 * 150 = 112.500 itens na consulta. Neste exemplo, você pode reduzir o número de buckets para executar a consulta com sucesso.

Para mais informações sobre os tipos de rótulos API, consulte Cato API - AccountMetrics > Séries Temporais.

Calculando a Granularidade Mínima para uma Consulta

Esta seção explica como calcular a granularidade mínima (tamanho do bucket) com base no período de tempo da consulta.

1. Período de tempo - Converta o período de tempo para segundos
2. Limite de bucket - Calcule o limite de bucket com base em 100000 / ( (Sites + Usuários VPN) * (métricas) )
3. Granularidade Mínima = (período de tempo) / (limite de bucket)

Por exemplo, a primeira linha na tabela abaixo mostra o limite de consultas para 7 dias, 100 sites e usuários VPN, com 5 métricas:

• 7 dias = 604.800 segundos
• 200 buckets = 10000 / (100) * (5)
• 3024 segundos de granularidade mínima = 604800 / 200

A tabela a seguir mostra configurações de exemplo para a consulta accountMetrics com a granularidade mínima do bucket:

Detalhes para os Campos de accountMetrics

Estes são os detalhes que os campos de accountMetrics podem retornar para a consulta:

• ID - ID da Conta
• de - hora de início
• para - hora de finalização
• granularidade - tamanho do bucket
• sites - dados que são retornados para cada site (matriz com consultas e campos aninhados)
• séries temporais - período de tempo para os dados, e define a relação entre os buckets e os dados (matriz com consultas e campos aninhados)

ID de accountMetrics

O campo ID mostra o ID interno único da conta.

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

De accountMetrics

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

Para accountMetrics

O campo Para mostra a hora de finalização para os dados da consulta e é definido no argumento período de tempo.

Granularidade de accountMetrics

O campo Granularidade mostra a duração em segundos para um único bucket de métricas. O número de buckets é definido no argumento séries temporais > bucket.

A Granularidade é calculada de acordo com a fórmula seguinte: período de tempo/buckets. Por exemplo, se a consulta estiver retornando cinco minutos de dados (Período de Tempo) com 60 Buckets, então a Granularidade (tamanho do Bucket) é 5 segundos (300 segundos / 60).

A Granularidade mínima para um Bucket é de 5 segundos. Quando a Granularidade do Bucket é menor que 5 segundos, é possível que nenhum dado seja retornado para esse Bucket.

Para mais sobre o campo de Granularidade, veja Trabalhando com accountMetrics > Granularidade.

Locais de accountMetrics

O campo Locais contém dados relacionados a um ou mais sites na conta. Você também pode especificar dados para Usuários VPN com seus IDs de Usuário.

Para mais sobre o campo Locais para accountMetrics, veja Cato API - AccountMetrics > Locais.

Séries Temporais de accountMetrics

Mostra as métricas para a conta de acordo com o Período de Tempo especificado (Buckets) na consulta, e inclui estatísticas e métricas históricas. Esses dados são semelhantes ao campo janela Conectividade de Site no Aplicativo de Gerenciamento Cato para cada Site.

Para mais sobre o campo séries temporais para accountMetrics, veja Cato API - AccountMetrics > Séries Temporais.

Argumentos para as accountMetrics

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

• accountID - ID da Conta
• ID - ID da Conta (argumento legado)
• Período de Tempo - hora de início e fim da consulta
• groupInterfaces - Combina análises para os Links em um único Link (para o valor booleano true)
• groupDevices - Para múltiplos sites, e um único site com múltiplos Sockets, combine as análises em um único Socket (para o valor booleano true)

Argumento ID da Conta de accountMetrics

Insira o ID da Conta 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 a seguinte URL: https://cc2.catonetworks.com/#!/26/topologia.

Argumento Período de Tempo de accountMetrics

Insira o Período 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 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:
  • Período de Tempo = último.PT5M mostra os 5 Minutos anteriores
  • Período de Tempo = último.PT2H mostra as 2 Horas anteriores
  • Período de Tempo = último.P1D mostra o 1 Dia anterior
  • Período de Tempo = último.P3M mostra os 3 Meses anteriores
  • Período de Tempo = último.P1Y mostra o 1 Ano anterior
• utc.<especificação de tempo curto> - O Período de Tempo combina uma data e hora de início e fim no formato AA-MM-DD/hh:mm:ss de acordo com o fuso horário especificado. Você deve inserir todos os valores de data e hora para o argumento. Por exemplo:
  • Período de Tempo = utc.2020-02-{11/04:50:00--21/04:50:00} mostra 10 Dias de dados de Análise de 11 de fevereiro de 2020 4:50:00 até 21 de fevereiro de 2020 4:50:00
  • Período de Tempo = utc.2020-02-11/{04:50:15--16:50:15} mostra 12 Horas de dados de Análise em 11 de fevereiro de 2020, de 4:50:15 a 16:50:15
  • Período de Tempo = utc.2020-{02-11/04:50:00--04-11/04:50:00} mostra 2 Meses de dados de Análise de 11 de fevereiro de 2020 4:50:00 até 11 de abril 4:50:00
  • Período de Tempo = utc.{2019-10-01/04:50:00--2020-02-01/04:50:00} mostra 4 Meses de dados de Análise de 1 de outubro de 2019 4:50:00 até 11 de fevereiro de 2020 4:50:00

    Este formato permite configurar um Período de Tempo que inclui mais de um ano civil

Para mais sobre o argumento de Período de Tempo e o campo de Granularidade, veja Trabalhando com accountMetrics > Granularidade.

Argumento groupInterfaces de accountMetrics

Quando o argumento booleano groupInterfaces é definido como true, então os dados de todas as Interfaces são agregados a uma única Interface.

Argumento groupDevices de accountMetrics

Quando o argumento booleano groupDevices é definido como true, então as análises para todos os Sockets (geralmente dois em alta disponibilidade) são agregadas como um único resultado. Para obter os melhores resultados para Sockets agregados, recomendamos que haja nomes e funcionalidades consistentes (por exemplo, Destino) para os Links em ambos os Sockets.