Потенциальные разрушающие изменения API Cato и окончание срока службы (EoL)

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

• Что меняется: Параметры должны в точности соответствовать их типу, определённому схемой. Например, поля Int будут принимать только целочисленные значения — ввод строки, такой как "5", больше не будет принят. Это не ограничивается лишь полями Int — любой параметр, переданный в формате, не соответствующем задокументированному типу, может быть затронут.

• Что следует сделать до 30 августа 2026 года:

  • Проверьте ваши вызовы API на значения, переданные в формате, не соответствующем задокументированному типу схемы (например, числовые значения, переданные в виде строк).

  • Обновите любые невыравненные вызовы.

В настоящее время API шлюз Cato может возвращать ID поля как строку или Long (целое число). Как часть обновления предстоящей инфраструктуры, все ID поля будут последовательно возвращаться как строки.

• Что изменяется: Ответы API, которые ранее возвращали ID поля как числовые значения Long (например, 1000000002), теперь будут возвращать их как строковые значения (например, "1000000002").

• На кого это повлияет: Клиенты API, которые обрабатывают ID поля строго как Long/целые числа, могут столкнуться с проблемами, когда это изменение будет внедрено.

• Что следует сделать до 21 июня 2026 года: Обновите код вашего API клиента, чтобы принимать как Long, так и String типы для ID полей. Это обеспечит плавный переход и предотвратит сбои, когда изменения вступят в силу.

10 августа 2025 года, поле email в API addAdmin и updateAdmin стало опциональным (nullable). Это изменение поддерживает предстоящую инфраструктуру для поддержки более точного управления доступом к API, которая включает в себя скрипты и автоматизацию с использованием сервисных принципалов.

• Текущие и будущие человеческие администраторы CMA должны всегда включать значение email

• Запросы, возвращающие только человеческих администраторов, не затрагиваются.

• Некоторым клиентам, возможно, придется обрабатывать нулевые значения в полезных данных ответа, таких как addAdminPayload.

Это, как правило, не приводит к разрушительным изменениям, но может повлиять на клиентов, которые предполагают, что email всегда присутствует. Проверьте вашу интеграцию, чтобы избежать проблем.

API eventsFeed использует маркер для поэтапного вытягивания ленты событий. Поле Marker показывает идентификатор, указывающий начало новой итерации для выборки событий. API читает события из очереди на основе уникального поля Marker и предоставляет расположение следующего маркера в ответе. Если в очереди нет новых событий, поле Marker остается пустым.

Альтернативной моделью потребления событий является использование прямой интеграции без кода, смотрите Интеграция событий Cato с AWS S3 и Интеграция событий Cato с учетной записью хранения Azure.

Что мы изменили?

• Ранее, когда маркер не был указан, API возвращал самый старый доступный маркер. Это требовало потребления всей очереди событий до достижения самых последних событий.

• Начиная с 27 апреля 2025 года, если маркер не указан, API возвращает самый последний маркер. Это позволяет API напрямую извлекать самые последние события.

Это разрушающее изменение?

• Для большинства случаев использования API eventsFeed нет воздействия. Нет изменений, когда поле маркера используется для запроса, и логика потребления событий остается неизменной.

• Если у вас есть специальная логика для обработки очереди, чтобы добраться до последних событий, эта логика больше не нужна.

  • Теперь, если входной маркер не указан, API предоставляет самый последний маркер. Вызов API с этим маркером извлекает самые последние события

  • Ответ API содержит маркер, который указывает на самый последний (верхний в очереди) местоположении

  • Соответствующие сценарии и автоматизированные процессы должны быть обновлены

Мы изменили функциональность поля limit, так что limit=0 больше не поддерживается, так как это не считается лучшей практикой. Чтобы обеспечить бесперебойную работу, необходимо обновить все скрипты или запросы, которые зависят от этого параметра. Вместо этого вы можете установить лимит от 1 до 2000, что полностью поддерживается API.

Если вам нужно получить все истории, мы рекомендуем использовать подход с пагинацией.

Поле события secondary_socket_serial в API EventFieldName в настоящее время помечено как Deprecated и достигло окончания срока службы (EoL) 18 марта 2026 года.

Рекомендуемое альтернативное поле: socket_serial

Следующие поля и типы в API LastMileBWInput в настоящее время помечены как Deprecated и достигли окончания срока службы (EoL) 30 июня 2025 года.

Пожалуйста, используйте вместо этого рекомендованные поля и типы.

Следующие поля и типы в API InterfaceInfo в настоящее время помечены как Deprecated и достигли окончания срока службы (EoL) 30 июня 2025 года.

Пожалуйста, используйте вместо этого рекомендованные поля и типы.

Следующие поля и типы в API SocketInterfaceBandwidthInput в настоящее время помечены как Deprecated и достигли окончания срока службы (EoL) 30 июня 2025 года.

Пожалуйста, используйте вместо этого рекомендованные поля и типы.

• API запроса auditFeed принимает список фильтров, используя тип AuditFieldFilterInput. Каждый фильтр включает в себя fieldName, определенный типом FieldNameInput, который в настоящее время включает два поля ввода: AuditFieldName и EventFieldName.

• Однако, только AuditFieldName является допустимым и поддерживаемым входным полем. Для улучшения ясности схемы и избежания путаницы, поле EventFieldName было удалено из схемы 8 июня 2025 года.

• Обновите все скрипты и запросы, которые используют фильтры auditFeed, чтобы использовать только входное поле AuditFieldName.

Следующие поля и типы в API EventFieldName в настоящее время помечены как Deprecated и достигли окончания срока службы (EoL) 1 мая 2025 года.

Пожалуйста, используйте вместо этого рекомендованные поля и типы.

Поле bgp_peer_description в API EventFieldName было отмечено как устаревшее и достигнет конца жизни 15 апреля 2025 года.

Следующие поля и типы в API EventFieldName были отмечены как Устаревшие и завершили свой жизненный цикл (EoL) 1 марта 2025 года.

Пожалуйста, используйте вместо этого рекомендованные поля и типы.

Следующее поле в Beta API StoryDrillDownFilter было отмечено как Устаревшее и завершило свой жизненный цикл (EoL) 23 февраля 2025 года.

Пожалуйста, используйте вместо этого рекомендованные поля и типы.

Следуя объявлению о завершении жизненного цикла (EoL) для некоторых значений подтипов, используемых в API потребления событий, связанных с клиентами Cato, развертывание приостановлено для учетных записей, использующих расположение CMA в Ирландии (cc.catonetworks.com) для следующих полей:

• Для получения дополнительной информации см. CMA - Технические рекомендации

Следующие поля и типы, связанные с Клиентом Cato, были отмечены как устаревшие и больше не поддерживаются с 2 января 2025 года.

Пожалуйста, используйте вместо этого рекомендованные поля и типы.

• Для получения дополнительной информации, см. эту статью: Предстоящий EoL для некоторых подтипов данных о событиях Cato