Databricks icon

Databricks

Interact with Databricks API

Overview

The node interacts with the Databricks API, specifically supporting multiple resources including "Model Serving." For the "Get Serving Endpoint" operation under the "Model Serving" resource, it retrieves details about a specific serving endpoint by its name. This is useful for users who want to programmatically access information about deployed machine learning model endpoints on Databricks, such as their configuration or status.

Practical examples include:

  • Fetching the current configuration of a model serving endpoint before updating it.
  • Monitoring or auditing deployed model endpoints in an automated workflow.
  • Integrating model serving metadata retrieval into CI/CD pipelines or dashboards.

Properties

Name Meaning
Endpoint Name Name of the serving endpoint to retrieve

This property is required and expects a string representing the exact name of the serving endpoint.

Output

The node outputs JSON data containing the details of the specified serving endpoint. The structure typically includes metadata about the endpoint such as its configuration, status, and possibly usage statistics depending on the Databricks API response.

If the node supports binary data output (not indicated here), it would represent any associated files or artifacts related to the endpoint, but this is not evident from the provided code.

Dependencies

  • Requires an active Databricks account with appropriate permissions to access model serving endpoints.
  • Needs an API authentication token credential configured in n8n to authorize requests to the Databricks API.
  • The base URL for the Databricks instance must be set correctly in the credentials.

Troubleshooting

  • Common issues:

    • Incorrect or missing endpoint name will cause the API call to fail or return no data.
    • Invalid or expired API token will result in authorization errors.
    • Network connectivity problems to the Databricks host can cause request failures.
  • Error messages:

    • Authorization errors typically indicate invalid credentials; verify and update the API token.
    • "Endpoint not found" errors suggest the specified endpoint name does not exist; double-check the spelling and availability.
    • Timeout or network errors require checking internet connection and Databricks service status.

Links and References

Discussion