Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API, allowing users to perform a wide range of operations on various Dataiku DSS resources. Specifically for the Streaming Endpoint resource and the Set Streaming Endpoint Schema operation, the node updates the schema configuration of a specified streaming endpoint within a project.

Common scenarios where this node is beneficial include:

  • Automating the management of streaming endpoints in Dataiku DSS projects.
  • Updating or modifying the schema of streaming endpoints programmatically as part of data pipeline workflows.
  • Integrating schema updates into CI/CD pipelines or automated deployment processes.

Practical example:

  • You have a streaming endpoint that ingests real-time data, and you want to update its schema dynamically based on evolving data structures. This node can be used to send the updated schema JSON to the Dataiku DSS API to apply the changes without manual intervention.

Properties

Name Meaning
Project Key The key identifier of the Dataiku DSS project containing the streaming endpoint.
Streaming Endpoint ID The unique identifier of the streaming endpoint whose schema is to be set or updated.
Request Body A JSON object representing the new schema definition to apply to the streaming endpoint.

Output

The node outputs the response from the Dataiku DSS API after attempting to set the streaming endpoint schema. The output is provided in the json field and typically contains the updated schema details or confirmation of the update.

If the API returns binary data (not typical for this operation), it would be prepared accordingly, but for setting schemas, the output is JSON.

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 Dataiku DSS API credentials are properly configured in n8n.
  • Required Parameters Missing: Errors indicating missing "Project Key" or "Streaming Endpoint ID" mean these fields must be filled before execution.
  • Invalid JSON in Request Body: Ensure the JSON schema provided in the Request Body is correctly formatted; invalid JSON will cause API errors.
  • API Connection Issues: Network issues or incorrect server URLs can cause request failures. Verify connectivity and server address.
  • Permission Denied: The API key used must have sufficient permissions to modify streaming endpoint schemas in the specified project.

Links and References

Discussion