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

从 2026 年 8 月 30 日起，我们将在整个 API 中实施更严格的类型验证，以符合记录的模式。 API 调用传递的值格式不符合字段文档类型，根据端点不同可能会受到影响。

• 变更内容：参数必须与其 Schema 定义的类型完全匹配。 例如， Int 字段仅接受整数值——字符串输入如 "5" 将不再被接受。 这不仅限于 Int 字段——任何以不匹配其文档类型的格式传递的参数都可能受到影响。

• 您在 2026 年 8 月 30 日之前应该做的：

  • 检查您的 API 调用中传递的值格式是否不符合文档的 Schema 类型（例如，字符串形式传递的数值）。

  • 更新任何不对齐的调用。

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

• 变更内容： 以前将ID字段作为数字长整型值返回的API响应（例如，1000000002）将始终以字符串形式返回（例如，"1000000002"）。

• 受影响的对象： 对于严格将ID字段处理为长整型/整数类型的API客户端，此变更可能会导致故障。

• 2026年6月21日之前的操作： 更新您的API客户端代码，以接受ID字段的长整型和字符串两种类型。 这样可以确保平稳过渡并在变更生效时防止中断。

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

• 当前和未来的CMA管理员必须始终包括电子邮件值

• 仅返回的人类管理员查询不受影响。

• 某些客户端可能需要处理响应负载中的null值，例如addAdminPayload

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

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

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

我们更改了什么？

• 以前，当未指定标记时，API返回最旧的可用标记。 这要求在达到最新事件之前消费完整的事件队列。

• 从2025年4月27日开始，如果未指定标记，API返回最新标记。 这允许API直接提取最新事件。

这是重大更改吗？

• 对于eventsFeed API的大多数使用案例，没有影响。 当标记字段用于查询时，没有更改，事件源的消费逻辑保持不变。

• 如果您有专用的逻辑来消耗队列以到达最近的事件，则不再需要此逻辑。

  • 现在，如果未指定输入标记，API提供最新标记。 使用此标记调用API会提取最新事件

  • API响应包含一个指向最新（队列顶部）位置的标记

  • 应更新对应的脚本和自动化进程。

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

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

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

推荐的替代字段：socket_serial。

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

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

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

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

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

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

• AuditFeed查询API接受使用AuditFieldFilterInput类型的过滤器列表。 每个过滤器包括一个由类型定义FieldNameInput的fieldName，目前包括两个输入字段：AuditFieldName和EventFieldName。

• 然而，只有AuditFieldName是有效和支持的输入字段。 为了提高模式清晰度并避免混淆，EventFieldName 字段已从模式中移除，日期为2025年6月8日。

• 更新所有使用auditFeed过滤器的脚本和查询，以仅使用AuditFieldName输入字段。

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

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

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

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

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

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

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

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

• 有关更多信息，请参阅CMA - 技术指南

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

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

• 欲了解更多信息，请参阅此文章：即将结束生命周期的部分Cato事件数据子类型