get_cluster_status: Retrieve the information for a cluster.

In RafiKurlansik/bricksteR: R Package for Making Databricks Easy to Use.

Retrieve the information for a cluster.

Description

Will retrieve detailed information on a Databricks cluster. You can locate the cluster ID in the URL of the cluster configuration page. For example:

Usage

get_cluster_status(cluster_id, workspace, token = NULL, verbose = T, ...)

Arguments

cluster_id	A string containing the unique id for an online Databricks cluster
workspace	A string representing the web workspace of your Databricks instance. E.g., "https://eastus2.azuredatabricks.net" or "https://demo.cloud.databricks.com".
verbose	If TRUE, will print the API response to the console. Defaults to FALSE.
...	Additional options to be passed to data.table::fread which is used to parse the API response.

Details

https://mycompany.cloud.databricks.com/#/setting/clusters/xxxx-xxxxx-xxxxxx/

Where xxxx-xxxxx-xxxxxx is the cluster ID.

The API endpoint for terminating a cluster is '2.0/clusters/get'. For all details on API calls please see the official documentation at https://docs.databricks.com/dev-tools/api/latest/.

Value

A list with four elements:

• response - The full API response, including status code.

• response_json - The JSON result.

• response_list - The JSON result transformed into a list.

• response_df - The JSON result transformed into a dataframe.

Examples

workspace <- "https://myworkspace.cloud.databricks.com"
cluster_id <- "0818-155203-cheese22"

get_cluster_status(workspace = workspace, cluster_id = cluster_id)

RafiKurlansik/bricksteR documentation built on Oct. 13, 2022, 6:58 a.m.