Command Execution

View as Markdown

Use and configure compute for Databricks

CancelPOST /api/1.2/commands/cancelCreatePOST /api/1.2/contexts/createDestroyPOST /api/1.2/contexts/destroyExecutePOST /api/1.2/commands/executeGet Command StatusGET /api/1.2/commands/statusGet Context StatusGET /api/1.2/contexts/status

Cancel GA

POST /api/1.2/commands/cancel

Cancels a currently running command within an execution context.

The command ID is obtained from a prior successful call to execute.

API scopes: command-execution

Request body

clusterIdstring

commandIdstring

contextIdstring

View as Markdown

Request

{
  "clusterId": "string",
  "commandId": "string",
  "contextId": "string"
}

Response

{}

Create GA

POST /api/1.2/contexts/create

Creates an execution context for running cluster commands.

If successful, this method returns the ID of the new execution context.

API scopes: command-execution

Request body

clusterIdstring

Running cluster id

languagestring

Values: LANGUAGE_UNSPECIFIED, PYTHON, SCALA, SQL, R

Response

idstring

View as Markdown

Request

{
  "clusterId": "string",
  "language": "string"
}

Response

{
  "id": "1234567890123456789"
}

Destroy GA

POST /api/1.2/contexts/destroy

Deletes an execution context.

API scopes: command-execution

Request body

clusterIdstring

contextIdstring

View as Markdown

Request

{
  "clusterId": "string",
  "contextId": "string"
}

Response

{}

Execute GA

POST /api/1.2/commands/execute

Runs a cluster command in the given execution context, using the provided language.

If successful, it returns an ID for tracking the status of the command's execution.

API scopes: command-execution

Request body

clusterIdstring

Running cluster id

contextIdstring

Running context id

languagestring

Values: LANGUAGE_UNSPECIFIED, PYTHON, SCALA, SQL, R

commandstring

Executable code

Response

idstring

View as Markdown

Request

{
  "clusterId": "1234-567890-span123",
  "command": "print('Hello, World!')",
  "contextId": "1234567890123456789",
  "language": "python"
}

Response

{
  "id": "1234ab56-7890-1cde-234f-5abcdef67890"
}

Get Command Status GA

GET /api/1.2/commands/status

Gets the status of and, if available, the results from a currently executing command.

The command ID is obtained from a prior successful call to execute.

API scopes: command-execution

Parameters

clusterIdstringquery

contextIdstringquery

commandIdstringquery

Response

idstring

statusstring

Values: COMMAND_STATUS_UNSPECIFIED, COMMAND_CANCELLED, COMMAND_CANCELLING, COMMAND_ERROR, COMMAND_FINISHED, COMMAND_QUEUED, COMMAND_RUNNING

resultsobject

Show child attributesHide child attributes

causestring

The cause of the error

dataobject

fileNamestring

The image data in one of the following formats:

1. A Data URL with base64-encoded image data: data:image/{type};base64,{base64-data}. Example: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA...

2. A FileStore file path for large images: /plots/{filename}.png. Example: /plots/b6a7ad70-fb2c-4353-8aed-3f1e015174a4.png

fileNamesarray of string

List of image data for multiple images. Each element follows the same format as file_name.

isJsonSchemaboolean

true if a JSON schema is returned instead of a string representation of the Hive type.

posint32

internal field used by SDK

resultTypestring

Values: RESULT_TYPE_UNSPECIFIED, ERROR_RESULT, IMAGE_RESULT, IMAGES_RESULT, TABLE_RESULT, TEXT_RESULT

schemaarray of object

The table schema

summarystring

The summary of the error

truncatedboolean

true if partial results are returned.

View as Markdown

Response

{
  "id": "1234ab56-7890-1cde-234f-5abcdef67890",
  "results": {
    "data": "Hello, World!",
    "resultType": "text"
  },
  "status": "Finished"
}

Get Context Status GA

GET /api/1.2/contexts/status

Gets the status for an execution context.

API scopes: command-execution

Parameters

clusterIdstringquery

contextIdstringquery

Response

idstring

statusstring

Values: CONTEXT_STATUS_UNSPECIFIED, CONTEXT_RUNNING, CONTEXT_PENDING, CONTEXT_ERROR

View as Markdown

Response

{
  "id": "1234567890123456789",
  "status": "Running"
}