Эта статья является платформой для уведомлений о потенциальных разрушающих изменениях и объявлениях об окончании срока службы (EoL) схемы Cato GraphQL API и содержит информацию, которая может потребовать обновления клиента API.
Условия API, используемые в этой статье, объясняются в Что такое Cato API.
Для любых клиентов, использующих Cato API, мы рекомендуем нажать Следить, чтобы автоматически получать уведомления по электронной почте об обновлениях этой статьи о разрушающих изменениях API. Вы также можете увидеть больше информации о новых и обновленных API в Журнал Изменений Cato API.
Для получения дополнительной информации об API, смотрите справочник Cato Networks GraphQL 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.
Если вам нужно получить все истории, мы рекомендуем использовать подход с пагинацией.
Следующие поля и типы в API LastMileBWInput в настоящее время помечены как Deprecated и достигли окончания срока службы (EoL) 30 июня 2025 года.
Пожалуйста, вместо этого используйте рекомендованные поля и типы.
| Устаревший тип | Рекомендуемый тип |
|---|---|
| downstream | downstreamMbpsPrecision |
| upstream | upstreamMbpsPrecision |
Следующие поля и типы в API InterfaceInfo в настоящее время помечены как Deprecated и достигли окончания срока службы (EoL) 30 июня 2025 года.
Пожалуйста, вместо этого используйте рекомендованные поля и типы.
| Устаревший тип | Рекомендуемый тип |
|---|---|
| downstreamBandwidth | downstreamBandwidthMbpsPrecision |
| upstreamBandwidth | upstreamBandwidthMbpsPrecision |
Следующие поля и типы в API SocketInterfaceBandwidthInput в настоящее время помечены как Deprecated и достигли окончания срока службы (EoL) 30 июня 2025 года.
Пожалуйста, вместо этого используйте рекомендованные поля и типы.
| Устаревший тип | Рекомендуемый тип |
|---|---|
| downstreamBandwidth | downstreamBandwidthMbpsPrecision |
| upstreamBandwidth | upstreamBandwidthMbpsPrecision |
- API запроса
auditFeedпринимает список фильтров, используя типAuditFieldFilterInput. Каждый фильтр включает в себяfieldName, определенный типомFieldNameInput, который в настоящее время включает два поля ввода:AuditFieldNameиEventFieldName. - Однако, только
AuditFieldNameявляется допустимым и поддерживаемым входным полем. Для улучшения ясности схемы и избежания путаницы, полеEventFieldNameбыло удалено из схемы 8 июня 2025 года. - Обновите все скрипты и запросы, которые используют фильтры
auditFeed, чтобы использовать только входное полеAuditFieldName.
Следующие поля и типы в API EventFieldName в настоящее время помечены как Deprecated и достигли окончания срока службы (EoL) 1 мая 2025 года.
Пожалуйста, вместо этого используйте рекомендованные поля и типы.
| Устаревший тип | Рекомендуемый тип |
|---|---|
| application | application_id/application_name |
| custom_categories | custom_category_id/custom_category_name |
| custom_category | custom_category_id/custom_category_name |
| dest_site | dest_site_id/dest_site_name |
| device_posture_profiles | device_posture_profile |
| internalId | event_id |
| rule | rule_name |
| src_site | src_site_id/src_site_name |
Следующие поля и типы в API EventFieldName были отмечены как Устаревшие и завершили свой жизненный цикл (EoL) 1 марта 2025 года.
Пожалуйста, используйте вместо этого рекомендованные поля и типы.
| Устаревший тип | Рекомендуемый тип |
|---|---|
| parent_pid | src_process_parent_pid |
| pid | src_pid |
| process_path | src_process_path |
Следующее поле в Beta API StoryDrillDownFilter было отмечено как Устаревшее и завершило свой жизненный цикл (EoL) 23 февраля 2025 года.
Пожалуйста, используйте вместо этого рекомендуемые поля и типы.
| Устаревший тип | Рекомендуемый тип |
|---|---|
| значение | значения |
Следуя объявлению о завершении жизненного цикла (EoL) для некоторых значений подтипов, используемых в API потребления событий, связанных с клиентами Cato, развертывание приостановлено для учетных записей, использующих расположение CMA в Ирландии (cc.catonetworks.com) для следующих полей:
| Устаревший тип | Рекомендуемый тип |
|---|---|
| Подключено повторно | Подключено или отключено |
| Изменено PoP |
Подключено или отключено (Имя точки присутствия (PoP) возвращается в поле lastPopName.) |
- Для получения дополнительной информации см. CMA - Технические рекомендации
Следующие поля и типы, связанные с Клиентом Cato, были отмечены как устаревшие и больше не поддерживаются с 2 января 2025 года.
Пожалуйста, используйте вместо этого рекомендуемые поля и типы.
| Устаревший тип | Рекомендуемый тип | Примечания |
|---|---|---|
| VPN Never-Off-Bypass | Всегда включено обход | Значение подтипа VPN Never-Off-Bypass заменяется значением Всегда включено обход |
| Подключено повторно | Подключено или Отключено | Для увеличения детализации значение подтипа Подключено повторно разделяется на 2 новых значения: Подключено и Отключено |
| Изменено PoP |
Подключено или отключено (Имя точки присутствия (PoP) возвращается в поле lastPopName) |
Для увеличения детализации значение подтипа Изменено PoP разделяется на 2 новых значения: Подключено и Отключено |
- Для получения дополнительной информации, см. эту статью: Предстоящий EoL для некоторых подтипов данных о событиях Cato
0 комментариев
Войдите в службу, чтобы оставить комментарий.