群集事件 API 分页更改

为了提高 API 性能，Azure Databricks 更新在 Cluster 事件 API 中的分页方式。

2026 年 7 月 30 日，Azure Databricks将弃用 limit、offset、total_count 和 next_page/api/2.1/clusters/events API 终结点中的字段。这些字段将替换为新的基于令牌的分页字段，以提高 API 性能。

有什么变化

群集事件 API 当前使用基于限制和偏移的分页机制来检索群集事件的成批记录。该方法将被替换为使用以下新字段的基于令牌分页。

page_size （替换 limit）
page_token （替换 offset）
next_page_token （替换 next_page）
prev_page_token （向后分页的新字段）

字段 total_count 也将从 API 响应中删除。

需要采取行动

在 2026 年 7 月 30 日之前，必须：

更新使用群集事件 API 的任何代码，以使用新的分页字段而不是已弃用的字段。
更新依赖于群集事件 API 的任何第三方工具或集成，以使用新的分页方法。

API 请求示例

以下示例演示已弃用的分页方法，并演示如何使用新的分页方法。

弃用的分页方法

以下示例显示了已弃用的分页方法，该方法使用 limit 和 offset：

curl -X POST \
  https://<databricks-instance-url>/api/2.1/clusters/events \
  -H 'Authorization: Bearer <databricks-auth-token>' \
  -H 'Content-Type: application/json' \
  -d '{
        "cluster_id": "1234-567890-brick1",
        "start_time": 1617238800000,
        "end_time": 1619485200000,
        "event_types": ["STARTING", "TERMINATING"],
        "limit": 100,
        "offset": 0
      }'

API 响应包含一个 next_page 对象，该对象用于构造下一个请求。

新的分页方法

可以使用新的基于令牌的分页方法发出等效的请求，方法是：page_size

curl -X POST \
  https://<databricks-instance-url>/api/2.1/clusters/events \
  -H 'Authorization: Bearer <databricks-auth-token>' \
  -H 'Content-Type: application/json' \
  -d '{
        "cluster_id": "1234-567890-brick1",
        "start_time": 1617238800000,
        "end_time": 1619485200000,
        "event_types": ["STARTING", "TERMINATING"],
        "page_size": 100
      }'

响应将包含一个 next_page_token，您可以使用它来检索事件的下一页。在下一个请求中，您需要将此令牌添加到 page_token 查询参数中。

curl -X POST \
  https://<databricks-instance-url>/api/2.1/clusters/events \
  -H 'Authorization: Bearer <databricks-auth-token>' \
  -H 'Content-Type: application/json' \
  -d '{
        "cluster_id": "1234-567890-brick1",
        "start_time": 1617238800000,
        "end_time": 1619485200000,
        "event_types": ["DRIVER_HEALTH_EVENT", "NODE_HEALTH_EVENT"],
        "page_size": 100,
        "page_token": "<next_page_token>"
      }'

Last updated on 2026-05-08