Cato API 潜在的重大更改和终止公告

本文是关于 Cato GraphQL API 模式潜在重大更改和生命周期终止(EoL)公告的通知平台,包含可能需要您更新 API 客户端的信息。

本文中使用的条款在内容是 Cato API中进行了说明。

对于任何使用 Cato API 的客户,我们建议您单击关注以自动接收关于 API 重大更改的本文更新的电子邮件通知。 您还可以在Cato API 更新日志中查看有关新建和已更新API的更多信息。

有关API的更多信息,请参阅Cato Networks GraphQL API 参考

潜在的破坏性变更

2026年6月21日 - API ID字段:类型从长整型/整数变更为字符串

目前,Cato的API网关可能会将ID字段返回为字符串或长整型(整数)。 作为即将进行的基础设施更新的一部分,所有ID字段将始终以字符串形式返回。

  • 变更内容:以前将ID字段作为数字长整型值返回的API响应(例如,1000000002)将始终以字符串形式返回(例如,"1000000002")。
  • 受影响的对象:对于严格将ID字段处理为长整型/整数类型的API客户端,此变更可能会导致故障。
  • 2026年6月21日之前的操作:更新您的API客户端代码,以接受ID字段的长整型和字符串两种类型。 这样可以确保平稳过渡并在变更生效时防止中断。

2025年8月10日 - 修改addAdmin和updateAdmin API中的电子邮件字段

在2025年8月10日,addAdmin和updateAdmin API中的电子邮件字段变成可选(可为空)。 此更改支持即将推出的基础架构,以支持包括使用服务主体的脚本和自动化在内的细粒度 API 访问控制。

  • 当前和未来的CMA管理员必须始终包括电子邮件
  • 仅返回的人类管理员查询不受影响。
  • 某些客户端可能需要处理响应负载中的null值,例如addAdminPayload

这通常不是重大更改,但可能会影响假设email始终存在的客户端。 请查看您的集成以避免问题。

2025年4月27日 - eventsFeed查询API支持获取最新事件

eventsFeed API 使用标记来启用事件提要的迭代拉取。 标记字段显示一个标识符,指示提取事件的新迭代的开始。 API 根据唯一的标记字段从队列中读取事件,并在响应中提供下一个标记位置。 如果队列中没有新事件,则标记字段为空

另一种事件消费模型是使用直接无代码集成,请参阅将Cato事件与AWS S3集成将Cato事件与Azure存储账户集成

我们更改了什么? 

  • 以前,当未指定标记时,API返回最旧的可用标记。 这要求在达到最新事件之前消费完整的事件队列。
  • 从2025年4月27日开始,如果未指定标记,API返回最新标记。 这允许API直接提取最新事件。

这是重大更改吗? 

  • 对于eventsFeed API的大多数使用案例,没有影响。 当标记字段用于查询时,没有更改,事件源的消费逻辑保持不变。
  • 如果您有专用的逻辑来消耗队列以到达最近的事件,则不再需要此逻辑。

    • 现在,如果未指定输入标记,API提供最新标记。 使用此标记调用API会提取最新事件
    • API响应包含一个指向最新(队列顶部)位置的标记
    • 应更新对应的脚本和自动化进程。

2025年2月9日 - 对于XDR API的变更,limit=0不再受到支持

我们更改了limit字段的功能,不再支持limit=0,因为这不被认为是最佳实践。 为确保持续顺利运行,您需要更新依赖于此参数的任何脚本或查询。 相反,您可以设置 1-2000 之间的限制,API 完全支持。

如果您需要检索所有故事,我们建议使用分页方法。

即将宣布的生命周期结束通知。

 

先前的终止公告

2026年3月18日 - SecondarySocketSerial字段终止支持

EventFieldName API中的secondary_socket_serial事件字段目前被标记为已弃用,并将于2026年3月18日终止支持。

推荐的替代字段:socket_serial

2025年6月30日 - LastMileBwInput、InterfaceInfo和SocketInterfaceBandwidthInput类型终止支持

以下字段和类型LastMileBWInput API内部标记为已弃用,并将于2025年6月30日终止支持。

请改用推荐的字段和类型。

已废弃类型 推荐类型
下行 下行Mbps精度
上行 上行Mbps精度

以下字段和类型InterfaceInfo API内部标记为已弃用,并将于2025年6月30日终止支持。

请改用推荐的字段和类型。

已废弃类型 推荐类型
下行带宽 下行带宽Mbps精度
上行带宽 上行带宽Mbps精度

以下字段和类型SocketInterfaceBandwidthInput API内部标记为已弃用,并将于2025年6月30日终止支持。

请改用推荐的字段和类型。

已废弃类型 推荐类型
下行带宽 下行带宽Mbps精度
上行带宽 上行带宽Mbps精度

2025年6月8日 - FieldNameInput中的EventFieldName字段终止支持

  • AuditFeed查询API接受使用AuditFieldFilterInput类型的过滤器列表。 每个过滤器包括一个由类型定义FieldNameInputfieldName,目前包括两个输入字段:AuditFieldNameEventFieldName
  • 然而,只有AuditFieldName是有效和支持的输入字段。 为了提高模式清晰度并避免混淆,EventFieldName 字段已从模式中移除,日期为2025年6月8日。
  • 更新所有使用auditFeed过滤器的脚本和查询,以仅使用AuditFieldName输入字段。

2025年5月1日 - EventFieldName类型终止支持

以下字段和类型EventFieldName API内部标记为已弃用,并将于2025年5月1日终止支持。

请改用推荐的字段和类型。

已废弃类型 推荐类型
应用 应用程序_id/应用程序_名称
自定义类别 自定义类别_id/自定义类别_名称
自定义类别 自定义类别_id/自定义类别_名称
目的站点 目的站点ID/目的站点名称
设备姿态配置文件 设备姿态配置文件
内部ID 事件ID
规则 规则名称
源站点 源站点ID/源站点名称

2025年4月15日 - bgp_peer_description终止支持

EventFieldName API 中的 bgp_peer_description 字段已被标记为弃用,并于2025年4月15日进入生命终结(EoL)。

2025年3月1日 - EventFieldName类型终止支持

EventFieldName API中,以下字段和类型已标记为已弃用,并于2025年3月1日结束生命周期(EoL)。

请使用推荐的字段和类型。

已弃用类型 推荐类型
parent_pid src_process_parent_pid
pid src_pid
process_path src_process_path

2025年2月23日 - StoryDrillDownFilter值字段终止支持

StoryDrillDownFilter Beta API中,以下字段已标记为已弃用,并于2025年2月23日结束生命周期(EoL)。

请改用推荐的字段和类型。

弃用类型 推荐类型
未选择设备属性

2025年2月11日 - Cato事件数据的一些子类型终止支持

在宣布部分用于Cato客户端相关的事件消费API的子类型值生命周期结束后,以下字段的推出已经暂停,以确保使用爱尔兰CMA位置(cc.catonetworks.com)的账户的正常操作:

弃用类型 推荐类型
已重新连接 已连接或已断开连接
已更改PoP

已连接或已断开连接

(PoP名称在lastPopName字段中返回。)

2025年1月2日 - 事件子类型终止支持

与 Cato 客户端相关的以下字段和类型已被标记为弃用,并将在 2025 年 1 月 2 日达到生命周期终止(EoL)。

请改用推荐的字段和类型。

弃用类型 推荐类型 注意
VPN永不关闭-绕过 始终开启绕过 VPN永不关闭-绕过子类型值将被替换为值始终开启绕过
已重新连接 已连接或已断开 为了增加精细度,已重新连接子类型值将分为两个新的值:已连接和已断开连接
已更改PoP

已连接或已断开连接

(PoP名称在lastPopName字段中返回)

为了增加精细度,已更改PoP子类型值将分为两个新的值:已连接和已断开连接

这篇文章有帮助吗?

1 人中有 0 人觉得有帮助

0 条评论