Мы настоятельно рекомендуем, прежде чем начать работу с Cato API, ознакомиться с политикой поддержки для Cato API.

Обзор Учетная запись Метрики

Запрос Учетная запись Метрики помогает вам анализировать состояние и качество соединений сайтов и Пользователи SDP с облаком Кейто. Эти данные касаются трафика внутри DTLS-туннеля между сайтом и облаком Кейто.

accountMetrics shows historical metrics, statics, and analytics for the account. Оно возвращает данные, которые аналогичны окну Соединение сайта в Приложение Управления Cato.

Для Учетные записи реселлера, вы можете создать отдельные ключи API внутри каждой учетной записи клиента, которую вы подключаете к Cato API. Для получения дополнительной информации об ограничении частоты запросов и о запросе accountMetrics API, смотрите Понимание ограничения частоты запросов Cato API.

Working with Bucket Granularity and API Query Limits

There is a maximum limit of 100,000 returned items per accountMetrics API query. Если запрос достигает этого предела, то запрос не возвращает дополнительных данных и отображается сообщение об ошибке.

Кейто вычисляет этот предел, умножая следующие элементы:

• Общее количество сайтов плюс пользователи VPN
• Количество метрик (API-метки/телеметрия)
• Количество бакетов

In other words, the sum of (sites + VPN users) * (metrics) * (buckets) must be less than 100,000. Например, следующий запрос вызовет ошибку:

• 10 сайтов
• 140 VPN users
• 5 метрики
• 150 бакетов

(10 + 140) * 5 * 150 = 112,500 items in the query. В этом примере вы можете уменьшить количество бакетов для успешного выполнения запроса.

For more about the types of API labels, see Cato API - AccountMetrics > Timeseries.

Рассчитывание минимальной гранулярности для запроса

This section explains how to calculate the minimum granularity (bucket size) based on the time frame for the query.

1. Временной интервал - Преобразуйте временной интервал в секунды
2. Ограничение бакета - Вычислите ограничение бакета на основе 100000 / ((сайты + пользователи VPN) * (метрики) )
3. Минимальная Гранулярность = (временной интервал) / (ограничение бакета)

Например, первая строка в таблице ниже показывает лимит запросов на 7 дней, 100 сайтов и пользователей VPN, с 5 метриками:

• 7 дней = 604 800 секунд
• 200 бакетов = 10000 / (100) * (5)
• 3024 секунды минимальная гранулярность = 604800 / 200

Следующая таблица показывает пример настроек для запроса accountMetrics с минимальной гранулярностью бакетов:

Подробности для полей accountMetrics

Ниже приведены подробности, которые поля accountMetrics могут вернуть для запроса:

• ID - идентификатор аккаунта
• из - время начала
• до - время окончания
• гранулярность - размер бакета
• сайты - данные, возвращаемые для каждого сайта (массив с вложенными запросами и полями)
• временные ряды - временной интервал для данных, и определяет связь между бакетами и данными (массив с вложенными запросами и полями)

accountMetrics ID

Поле ID показывает уникальный внутренний ID аккаунта.

Этот ID аккаунта не отображается в Приложении Управления Cato, вместо этого он является числом в URL для Приложения Управления Cato. Например, ID аккаунта равен 26 для следующего URL: https://cc2.catonetworks.com/#!/26/topology.

accountMetrics от

Поле От показывает время начала данных запроса и определяется в аргументе временной интервал.

accountMetrics до

Поле До показывает время окончания данных запроса и определяется в аргументе временной интервал.

Гранулярность accountMetrics

Поле Гранулярность показывает продолжительность в секундах для одного бакета метрик. Количество Bucket определяется в аргументе временные ряды > bucket.

Гранулярность вычисляется по следующей формуле: временной интервал / бакеты. Например, если запрос возвращает данные за пять минут (временной интервал) с 60 Bucket, то гранулярность (размер Bucket) составляет 5 секунд (300 секунд / 60).

Минимальная детальность для Bucket составляет 5 секунд. Если детальность Bucket меньше 5 секунд, возможно, данные для этого Bucket не будут возвращены.

Для получения дополнительной информации о поле Granularity, см. Работа с accountMetrics > Granularity.

accountMetrics Сайты

Поле Сайты содержит данные, связанные с одним или несколькими сайтами в учётной записи. Вы также можете указать данные для пользователей VPN с их User ID.

Для получения дополнительной информации о поле Sites для accountMetrics, см. Cato API - AccountMetrics > Сайты.

accountMetrics Временные ряды

Показывает метрики для учётной записи в соответствии с указанным временным интервалом (Bucket) в запросе и включает историческую статистику и метрики. Эти данные аналогичны полю окна Подключение сайта в Приложении Управления Cato для каждого сайта.

Для получения более подробной информации о поле Временные ряды для accountMetrics, смотрите Cato API - AccountMetrics > Временные ряды.

Аргументы для accountMetrics

Эти аргументы можно передать и определить данные, которые запрашиваются:

• accountID - ID учётной записи
• ID - ID учётной записи (устаревший аргумент)
• timeFrame - начальное и конечное время запроса
• groupInterfaces - Объедините аналитику для ссылок в одну ссылку (для булевых значений true)
• groupDevices - Для нескольких сайтов и одного сайта с несколькими Sockets объедините аналитику в один Socket (для булевых значений true)

Аргумент accountMetrics accountID.

Введите ID учётной записи для данных, которые запрашиваются. Этот аргумент обязателен.

Этот ID учётной записи не отображается в Приложении Управления Cato, вместо этого это номер в URL для Приложения Управления Cato. Например, ID учётной записи равен 26 для следующего URL: https://cc2.catonetworks.com/#!/26/topology.

Аргумент accountMetrics Временной интервал.

Введите временной интервал для данных, которые запрашиваются. Аргумент имеет формат <тип>.<значение времени>. Этот аргумент обязателен.

Вот поддерживаемые параметры для определения временного интервала:

• last.<временная_длительность> - Значение <временная_длительность> для типа last соответствует ISO-8601 и возвращает данные за предыдущие определённые времена. Например:
  • временнойИнтервал = last.PT5M показывает предыдущие 5 минут
  • временнойИнтервал = last.PT2H показывает предыдущие 2 часа
  • временнойИнтервал = last.P1D показывает предыдущий 1 день
  • временнойИнтервал = last.P3M показывает предыдущие 3 месяца
  • временнойИнтервал = last.P1Y показывает предыдущий 1 год
• utc.<короткоеОписание_временногоИнтервала> - Временной интервал объединяет дату начала и окончания в формате ГГГГ-ММ-ДД/чч:мм:сс в соответствии с указанным часовым поясом. Вы должны ввести все значения даты и времени для аргумента. Например:
  • временнойИнтервал = utc.2020-02-{11/04:50:00--21/04:50:00} показывает 10 дней аналитических данных с 11 февраля 2020 года 4:50:00 до 21 февраля 2020 года 4:50:00
  • временнойИнтервал = utc.2020-02-11/{04:50:15--16:50:15} показывает 12 часов аналитических данных 11 февраля 2020 года с 4:50:15 до 16:50:15
  • временнойИнтервал = utc.2020-{02-11/04:50:00--04-11/04:50:00} показывает 2 месяца аналитических данных с 11 февраля 2020 года 4:50:00 до 11 апреля 4:50:00
  • временнойИнтервал = utc.{2019-10-01/04:50:00--2020-02-11/04:50:00} показывает 4 месяца аналитических данных с 1 октября 2019 4:50:00 до 11 февраля 2020 4:50:00

    Этот формат позволяет настроить временной интервал, который включает более одного календарного года

Для получения дополнительной информации об аргументе timeFrame и поле Granularity, см. Работа с accountMetrics > Granularity.

Аргумент accountMetrics groupInterfaces

Когда булевый аргумент groupInterfaces установлен на true, данные для всех интерфейсов агрегируются в один интерфейс.

Аргумент accountMetrics groupDevices

Когда булевый аргумент groupDevices установлен на true, аналитика для всех сокетов (обычно двух при высокой доступности) агрегируется как один результат. Для достижения наилучших результатов для агрегированных Sockets, мы рекомендуем использовать согласованные имена и функциональность (например, Назначение) для связей на обоих Sockets.