Pular para o conteúdo principal
Última atualização em

alterações na paginação da API de eventos de cluster

Para melhorar o desempenho API , Databricks está atualizando o funcionamento da paginação na APIde eventos de cluster.

Em 30 de julho de 2026, o Databricks irá descontinuar os campos limit, offset, total_count e next_page no endpoint da API /api/2.1/clusters/events . Esses campos serão substituídos por novos campos de paginação baseados em tokens para melhorar o desempenho da API.

O que está mudando?​

A API de eventos de cluster usa atualmente paginação baseada em limite e deslocamento para recuperar lotes de eventos de cluster. Isso será substituído por paginação baseada em tokens, utilizando os seguintes novos campos:

  • page_size (substitui limit)
  • page_token (substitui offset)
  • next_page_token (substitui next_page)
  • prev_page_token (novo campo para paginação inversa)

O campo total_count também será removido das respostas da API.

Ação necessária​

Antes de 30 de julho de 2026, você deve:

  1. Atualize todo o código que utiliza a API de eventos de cluster para usar os novos campos de paginação em vez dos campos obsoletos.

  2. Atualize quaisquer ferramentas ou integrações de terceiros que dependam da API de eventos do cluster para usar o novo método de paginação.

exemplos de requisição de API​

Os exemplos a seguir mostram o método de paginação obsoleto e demonstram como usar o novo método de paginação.

Método de paginação obsoleto​

O exemplo a seguir mostra o método de paginação obsoleto que usa limit e 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
      }'

A resposta da API continha um objeto next_page que você usaria para construir a próxima solicitação.

Novo método de paginação​

Você pode fazer a solicitação equivalente usando o novo método de paginação baseado em tokens usando 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
      }'

A resposta contém uma página de eventos juntamente com um next_page_token que pode ser usado para recuperar a próxima página de eventos:

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

Será necessário adicionar o valor next_page_token ao campo page_token na próxima solicitação:

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>"
      }'
Nesta página