Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API, allowing users to interact programmatically with various Dataiku DSS resources and operations. Specifically for the Streaming Endpoint resource with the Get Streaming Endpoint Settings operation, it retrieves the configuration details of a specified streaming endpoint within a project.

Common scenarios where this node is beneficial include:

  • Automating retrieval of streaming endpoint configurations for monitoring or auditing.
  • Integrating streaming endpoint settings into larger workflows for dynamic decision-making.
  • Managing multiple streaming endpoints across projects by fetching their current settings programmatically.

Practical example:

  • A user wants to fetch the settings of a particular streaming endpoint in a Dataiku project to verify its configuration before deploying or updating related data flows.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku project containing the streaming endpoint.
Streaming Endpoint ID The unique identifier of the streaming endpoint whose settings are to be retrieved.

Output

The node outputs the JSON response from the Dataiku DSS API representing the streaming endpoint's settings. This JSON object contains all configuration details of the specified streaming endpoint, such as connection parameters, status, schema references, and other relevant metadata.

If the operation involves binary data (not applicable for this specific operation), the node would output the binary content under the binary field with an appropriate filename.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key) for authentication with the Dataiku DSS API.
  • The node expects the Dataiku DSS server URL and user API key to be configured in the credentials.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing credentials, ensure that the API key credential for Dataiku DSS is properly set up in n8n.
  • Required Parameter Errors: The node validates required parameters like Project Key and Streaming Endpoint ID. Missing these will cause errors; ensure these fields are correctly filled.
  • API Request Failures: Network issues, incorrect server URLs, or invalid API keys can cause request failures. Verify connectivity and credentials.
  • Unexpected Response Format: If the API returns unexpected data or errors, check the Dataiku DSS API documentation and ensure the streaming endpoint ID exists and is accessible.

Links and References


This summary focuses on the "Streaming Endpoint" resource and the "Get Streaming Endpoint Settings" operation as requested, based on static analysis of the provided source code and property definitions.

Discussion