Skip to contents

List Cluster Activity Events

Source: R/clusters.R
db_cluster_events.Rd

List Cluster Activity Events

Usage

db_cluster_events(
  cluster_id,
  start_time = NULL,
  end_time = NULL,
  event_types = NULL,
  order = c("DESC", "ASC"),
  offset = NULL,
  limit = NULL,
  host = db_host(),
  token = db_token(),
  perform_request = TRUE,
  page_size = 50,
  page_token = NULL
)

Arguments

cluster_id

The ID of the cluster to retrieve events about.

start_time

The start time in epoch milliseconds. If empty, returns events starting from the beginning of time.

end_time

The end time in epoch milliseconds. If empty, returns events up to the current time.

event_types

List. Optional set of event types to filter by. Default is to return all events. Event Types.

order

Either DESC (default) or ASC.

offset

[Deprecated] Use page_token instead. Legacy result offset. When supplied, uses legacy pagination with a warning. Descending requests with an offset require end_time.

limit

[Deprecated] Use page_size instead. Legacy page size, from 1 to 500. When supplied, uses legacy pagination with a warning.

host

Databricks workspace URL, defaults to calling db_host().

token

Databricks workspace token, defaults to calling db_token().

perform_request

If TRUE (default) the request is performed, if FALSE the httr2 request is returned without being performed.

page_size

Maximum number of events per page, from 0 to 500 (default: 50). Use 0 or NULL for the server default.

page_token

A next_page_token or prev_page_token from a previous response, or NULL for the first page.

Value

If perform_request = TRUE, returns the full single-page API response, including events and pagination metadata when present. If FALSE, returns an httr2_request.

Details

Retrieve one page of events about the activity of a cluster. Extract $events to access the records; earlier versions returned the records directly. Use the response's next_page_token or prev_page_token as page_token to navigate pages, retaining the same time and event filters.

offset and limit default to NULL and are omitted from token-based requests. Non-NULL legacy arguments cannot be combined with an explicitly supplied non-NULL page_size or page_token. Legacy arguments are forwarded for compatibility, but Databricks deprecates them on November 30, 2026. Migrate to page_size and tokens returned by the preceding response; numeric offsets cannot be converted to page tokens.

Supply epoch milliseconds as numeric values, not R integers.

See also

db_list_all_pages() to collect records from every page.

Other Clusters API: db_cluster_create(), db_cluster_edit(), db_cluster_get(), db_cluster_list(), db_cluster_list_node_types(), db_cluster_list_zones(), db_cluster_perm_delete(), db_cluster_pin(), db_cluster_resize(), db_cluster_restart(), db_cluster_runtime_versions(), db_cluster_start(), db_cluster_terminate(), db_cluster_unpin(), get_and_start_cluster(), get_latest_dbr()