db_cluster_list: List Clusters

In brickster: R Toolkit for 'Databricks'

List Clusters

Description

List Clusters

Usage

db_cluster_list(
  host = db_host(),
  token = db_token(),
  perform_request = TRUE,
  page_size = 20,
  page_token = NULL
)

Arguments

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 clusters per page, from 1 to 100 (default: 20). Use 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.

Details

Retrieve one page of pinned and active clusters, and clusters terminated within the past 30 days. Use next_page_token to request subsequent pages. Extract ⁠$clusters⁠ to access the records; earlier versions returned these records directly without pagination metadata.

Value

If perform_request = TRUE, returns the full single-page API response with class db_cluster_list, including pagination tokens when present. Each record in clusters has class db_cluster. If FALSE, returns an httr2_request.

See Also

db_list_all_pages() to collect records from every page.

Other Clusters API: db_cluster_create(), db_cluster_edit(), db_cluster_events(), db_cluster_get(), 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()

Examples

## Not run: 
page <- db_cluster_list()
clusters <- page$clusters
if (!is.null(page$next_page_token) && nzchar(page$next_page_token)) {
  next_page <- db_cluster_list(page_token = page$next_page_token)
}

## End(Not run)

brickster documentation built on Oct. 9, 2026, 5:07 p.m.