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

Visão geral do AccountMetrics

A consulta accountMetrics ajuda você a analisar o estado e a qualidade das conexões dos sites e usuários SDP para a Cato Cloud. Este dado é para o tráfego dentro do túnel DTLS entre o site e a Cato Cloud.

O accountMetrics mostra métricas históricas, estáticas e analíticas da conta. Ele retorna dados que são semelhantes à janela Conectividade do Site no Aplicativo de Gerenciamento Cato.

Para contas de revendedor, você pode criar chaves de API separadas dentro de cada conta de cliente que você esteja conectando ao Cato API. Para saber mais sobre a limitação de taxa e a consulta da API accountMetrics, consulte Compreendendo a Limitação de Taxa do Cato API.

Trabalhando com Granularidade de Balde e Limites de Consulta API

Há um limite máximo de 100.000 itens retornados por consulta API accountMetrics. Se uma consulta atingir esse limite, ela não retorna dados adicionais e uma mensagem de erro é exibida.

A Cato calcula esse limite multiplicando os seguintes elementos:

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

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

• 10 sites
• 140 usuários VPN
• 5 métricas
• 150 baldes

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

Para mais informações sobre os tipos de rótulos da 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 balde) com base no prazo da consulta.

1. Prazo - Converta o prazo para segundos
2. Limite de balde - Calcule o limite de balde com base em 100000 / ((sites + usuários VPN) * (métricas))
3. Granularidade Mínima = (prazo) / (limite de balde)

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

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

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

Detalhes para os Campos de AccountMetrics

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

• ID - ID da conta
• de - hora de início
• para - hora de término
• granularidade - tamanho do balde
• sites - dados retornados para cada site (array com consultas e campos aninhados)
• séries temporais - prazo para os dados e define a relação entre os baldes e os dados (array com consultas e campos aninhados)

ID do AccountMetrics

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

Este 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.

AccountMetrics De

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

AccountMetrics Para

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

AccountMetrics Granularidade

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

A Granularidade é calculada de acordo com a fórmula: timeFrame/buckets. Por exemplo, se a consulta estiver retornando cinco minutos de dados (timeFrame) com 60 baldes, então a Granularidade (tamanho do balde) é 5 segundos (300 segundos / 60).

A Granularidade mínima para um balde é de 5 segundos. Quando a Granularidade do balde é inferior a 5 segundos, então é possível que nenhum dado seja retornado para aquele balde.

Para mais informações sobre o campo de Granularidade, consulte Trabalhando com accountMetrics > Granularidade.

AccountMetrics Sites

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

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

AccountMetrics Séries temporais

Mostra as métricas da conta de acordo com o período de tempo especificado (baldes) na consulta, e inclui estatísticas e métricas históricas. Este dado é semelhante ao campo Conectividade do Site na janela do Aplicativo de Gerenciamento Cato para cada site.

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

Argumentos para o accountMetrics

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

• accountID - ID da conta
• ID - ID da conta (argumento legado)
• timeFrame - hora de início e término da consulta
• groupInterfaces - Combinar análises para os links em um único link (para 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 valor booleano true)

Argumento accountID do 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 do Aplicativo de Gerenciamento Cato. Por exemplo, o ID da conta é 26 para a seguinte URL: https://cc2.catonetworks.com/#!/26/topology.

Argumento timeFrame do AccountMetrics

Insira o prazo 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 de tempo> - O valor <duração de tempo> para o tipo último está de acordo com ISO-8601 e retorna dados para os tempos 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 dia
  • timeFrame = último.P3M mostra os últimos 3 meses
  • timeFrame = último.P1Y mostra o último ano
• utc.<especificação de curto prazo> - O período de tempo combina uma data de início e fim no formato YY-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:
  • timeFrame = 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 am a 21 de fevereiro de 2020 4:50:00 am
  • timeFrame = utc.2020-02-11/{04:50:15--16:50:15} mostra 12 horas de dados de análise em 11 de fevereiro de 2020, das 4:50:15 am às 16:50:15 pm
  • timeFrame = 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 am a 11 de abril 4:50:00 am
  • timeFrame = 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 am a 11 de fevereiro de 2020 4:50:00 am

    Este formato permite configurar um período de tempo que inclui mais de um ano civil

Para mais sobre o argumento timeFrame e o campo de Granularidade, consulte Trabalhando com accountMetrics > Granularidade.

Argumento groupInterfaces do AccountMetrics

Quando o argumento booleano groupInterfaces é definido como true, então os dados para todas as interfaces são agregados a uma única interface.

Argumento groupDevices do AccountMetrics

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