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

Обзор АудитFeed

Запрос АудитFeed помогает анализировать действия, выполняемые администраторами в Приложении Управления Cato. Данные, которые возвращает этот запрос, аналогичны окну Система> Журнал аудита в Приложении Управления Cato.

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

Понимание полученных данных

Вызов API auditFeed разработан для поддержки извлечения более 2 миллионов элементов данных аудита в час. Чтобы помочь разбить возвращаемые данные на страницы, когда за временной интервал есть более 1000 элементов аудита, запрос повторяет извлечение, пока не вернет все данные аудита.

Эти поля относятся к разбиению аудиторских данных на страницы: маркер, fetchedCount и hasMore. См. ниже объяснения этих полей.

Детали Полей АудитFeed

Это детали, которые поля АудитFeed могут показать для запроса:

• от - начальное время
• до - конечное время
• маркер - Поле маркера является уникальным идентификатором для последнего элемента данных аудита, который вернул запрос API.
• fetchedCount - количество извлеченных элементов (максимум 1000 элементов за одно извлечение)
• hasMore - когда истинно, указывает, что есть дополнительные элементы для извлечения по запросу
• учетные записи (записиУчетнойЗаписиАудитFeed) - Для реселлеров, управляющих несколькими учетными записями, это поле указывает измененную учетную запись и включает все записи и данные аудита (массив с вложенными запросами и полями)

auditFeed От

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

auditFeed До

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

auditFeed Маркер

Когда за время запроса имеется более 1000 элементов данных аудита, поле маркера показывает идентификатор, указывающий начало новой итерации для извлечения элементов. Например, если запрос возвращает 2500 элементов, то это результаты по итерациям извлечения:

• первая итерация - fetchedCount = 1000 (элементы), маркер = 1234abc, hasMore = true
• вторая итерация - fetchedCount = 1000 (элементы), маркер = 4567def, hasMore = true
• третья итерация - fetchedCount = 500 (элементы), маркер = 8901xyz, hasMore = false

  Вы можете игнорировать значение маркера на последней итерации

auditFeed fetchedCount

Поля fetchedCount показывают общее количество элементов в текущем действии извлечения. Максимальное значение для этого поля - 1000.

auditFeed hasMore

Когда значение поля hasMore равно true, это означает, что после этой итерации происходит очередное извлечение элементов.

auditFeed Учетные записи

Поля Учетные записи (записиУчетнойЗаписиАудитFeed) показывают ID администраторов и данные аудита для этого запроса. Используйте аргумент записьУчетныхЗаписейАудитFeed > ЗаписьАудита > ИмяПоляАудита, чтобы отфильтровать отображаемые данные событий для запроса. Для получения дополнительной информации о полях записейАудита, см. ниже aудитFeed > имяПоля > ИмяПоляАудита.

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

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

• ID учетной записи - идентификаторы учетной записи (для нескольких учетных записей введите идентификаторы в виде массива)
• идентификаторы - идентификатор учетной записи (наследуемый аргумент)
• временной интервал - начальное и конечное время запроса
• фильтры (вводФильтраПоляАудита) - отфильтровать запрашиваемые данные журнала аудита (массив с вложенными запросами)
• маркер - показывать только элементы для конкретной итерации извлечения в соответствии со значением маркера

auditFeed accountIDs Аргумент

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

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

аргумент auditFeed timeFrame

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

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

• last.<продолжительность времени> - значение <продолжительность времени> для типа last соответствует ISO-8601 и возвращает данные за предыдущие определенные времена. Например:
  • Временной интервал = last.PT5M показывает предыдущие 5 минут
  • Временной интервал = last.PT2H показывает предыдущие 2 часа
  • Временной интервал = last.P1D показывает предыдущий 1 день
  • Временной интервал = last.P3M показывает предыдущие 3 месяца
  • Временной интервал = last.P1Y показывает предыдущий 1 год
• <часовой пояс>.<спецификация короткого временного интервала> - временной интервал комбинирует начальную и конечную дату в формате YY-MM-DD/hh:mm:ss в соответствии с указанным часовым поясом. Например, временной интервал = utc.2020-02-{11/04:50:00--21/04:50:00} показывает аналитические данные с 11 февраля 2020 г. 4:50:00 до 21 февраля 2020 г. 4:50:00.

аргумент фильтры auditFeed

Аргумент фильтры (AuditFieldFilterInput) позволяет определить конкретный элемент, включенный в запрос журнала аудита. Это аргументы, которые вы можете определить:

• Имя глобальной настройки > AuditFieldName - определите элементы из Журнала аудита
• operator - определяет, как активировать значения для фильтрации данных аудита
• values - определяют значение фильтра, которое используется с оператором

auditFeed > Имя глобальной настройки > AuditFieldName

Это имена полей для различных типов конфигураций Приложения Управления Cato, которые отслеживаются в Система > Журнал аудита.

• админ - администратор, чье действие сгенерировало запись
• model_name - название объекта, на который это повлияло, например Мой Сайт
• admin_id - ID администратора, чье действие сгенерировало запись
• Модуль - модуль системы, который был изменен, например Конфигурация MFA или Инспекция TLS
• время вставки - время, когда изменение было выполнено или сохранено
• тип изменения - описывает изменения, сделанные администратором; значения: СОЗДАНО, УДАЛЕНО, ИЗМЕНЕНО, ВКЛЮЧЕНО, ОТКЛЮЧЕНО, ПРОПУЩЕНО
• дата создания - время, когда изменение началось
• изменение - подробный отчет об изменении в формате JSON
• model_type - тип объекта, который был изменен, например Сайт, Сокет, SocketInterface

аргумент маркер auditFeed

Аргумент маркера позволяет ограничить запрос событиями для конкретной итерации извлечения. Чтобы показать значения маркера, выполните запрос с аргументом маркера с пустым значением. Запрос возвращает значения маркера для определенного аргумента временного интервала.

Например, если запрос возвращает 2500 событий, это результаты за первые три итерации извлечения:

• первая итерация - fetchedCount = 1000 (событий), маркер = 1234abc, hasMore = true
• вторая итерация - fetchedCount = 1000 (событий), маркер = 4567def, hasMore = true
• третья итерация - fetchedCount = 1000 (событий), маркер = 8901xyz, hasMore = true

Чтобы показать только события на второй итерации, установите аргумент маркера на 4567def.