メインコンテンツまでスキップ
に最終更新

クラスターイベントAPIのページネーションの変更

APIのパフォーマンスを向上させるため、DatabricksはクラスターイベントAPIにおけるページネーションの仕組みを更新しています。

2026年7月30日、Databricksは/api/2.1/clusters/events APIエンドポイントのlimit 、 offset 、 total_count 、 next_pageフィールドを非推奨にします。これらのフィールドは、APIのパフォーマンスを向上させるために、新しいトークンベースのページネーションフィールドに置き換えられます。

何が変わるのか​

クラスターイベントAPIは現在、リミットとオフセットに基づくページネーションを使用して、クラスターイベントのバッチを取得しています。これは、以下の新しいフィールドを使用したトークンベースのページネーションに置き換えられます。

  • page_size （ limitを置き換えます）
  • page_token （ offsetを置き換えます）
  • next_page_token （ next_pageを置き換えます）
  • prev_page_token （後方ページネーション用の新しいフィールド）

APIレスポンスからtotal_countフィールドも削除されます。

対応が必要​

2026年7月30日までに、以下のことを行う必要があります。

  1. クラスターイベントAPIを使用するコードを更新し、非推奨のフィールドではなく新しいページネーションフィールドを使用するようにしてください。

  2. クラスターイベントAPIに依存するサードパーティ製のツールや統合機能はすべて、新しいページネーション方式を使用するように更新してください。

APIリクエストの例​

以下の例は、非推奨となったページネーション方法を示し、新しいページネーション方法の使用方法を説明します。

非推奨のページネーション方法​

次の例は、 limitとoffsetを使用する非推奨のページネーション方法を示しています。

JSON
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を使用して新しいトークンベースのページネーション方式で同等のリクエストを行うことができます。

JSON
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とともにイベントのページが含まれています：

JSON
{
  "events": [
    {
      "cluster_id": "1234-567890-brick1",
      "timestamp": 1619471498409,
      "type": "TERMINATING",
      "details": {
        "reason": {
          "code": "INACTIVITY",
          "type": "SUCCESS",
          "parameters": {
            "inactivity_duration_min": "120"
          }
        }
      }
    },
    {
      "cluster_id": "1234-567890-brick1",
      "timestamp": 1619470210000,
      "type": "STARTING",
      "details": {
        "user": "someone@example.com"
      }
    }
  ],
  "next_page_token": "CAESFjEyMzQtNTY3ODkwLWJyaWNrMRgB",
  "prev_page_token": ""
}

次のリクエストで、next_page_tokenの値をpage_tokenフィールドに追加します：

JSON
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,
        "page_token": "<next_page_token>"
      }'
このページの見出し