Aller au contenu principal
Dernière mise à jour le

Modifications de la pagination de l'API des événements de cluster

Pour améliorer les performances de l'API, Databricks met à jour le fonctionnement de la pagination dans l'API des événements de cluster.

Le 20 octobre 2026, Databricks rendra obsolètes les champs limit, offset, total_count et next_page dans l'Endpoint d'API /api/2.1/clusters/events. Ces champs seront remplacés par de nouveaux champs de pagination basés sur des jetons pour améliorer les performances de l'API.

Qu'est-ce qui change​

L'API d'événements de cluster utilise actuellement la pagination basée sur des limites et des décalages pour récupérer des batch d'événements de cluster. Ceci sera remplacé par une pagination basée sur des jetons à l'aide des nouveaux champs suivants :

  • page_size (remplace limit)
  • page_token (remplace offset)
  • next_page_token (remplace next_page)
  • prev_page_token (nouveau champ pour la pagination rétroactive)

Le champ total_count sera également supprimé des réponses d'API.

Action requise​

Avant le 20 octobre 2026, vous devez :

  1. Mettez à jour tout code qui utilise l'API d'événements de cluster pour utiliser les nouveaux champs de pagination au lieu des champs obsolètes.

  2. Mettez à jour tous les outils ou intégrations tiers qui dépendent de l'API d'événements de cluster afin d'utiliser la nouvelle méthode de pagination.

Exemples de requêtes API​

Les exemples suivants montrent la méthode de pagination obsolète et expliquent comment utiliser la nouvelle méthode de pagination.

Méthode de pagination obsolète​

L’exemple suivant montre la méthode de pagination obsolète qui utilise limit et 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
      }'

La réponse de l'API contenait un objet next_page que vous utiliseriez pour construire la requête suivante.

Nouvelle méthode de pagination​

Vous pouvez effectuer la requête équivalente en utilisant la nouvelle méthode de pagination basée sur un jeton en utilisant 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
      }'

La réponse contient une page d'événements, ainsi qu'un next_page_token que vous pouvez utiliser pour récupérer la page d'événements suivante :

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": ""
}

Vous ajouterez la valeur next_page_token au champ page_token dans la requête suivante :

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>"
      }'
Sur cette page