Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API, enabling users to perform a wide range of operations on various Dataiku DSS resources. Specifically for the Machine Learning - Experiment Tracking resource, it supports the Clean Project operation, which permanently deletes experiments and runs marked as deleted within a specified project.

Common scenarios where this node is beneficial include automating management tasks in Dataiku DSS projects, such as cleaning up experiment tracking data to maintain project hygiene or freeing up storage by removing obsolete experiment records.

Practical example:

  • You have a Dataiku DSS project accumulating many old experiments and runs marked as deleted. Using this node's "Clean Project" operation under the Machine Learning - Experiment Tracking resource, you can automate the permanent deletion of these records to keep your project clean and performant.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku DSS project where the operation will be performed.
Request Body A JSON object representing the request payload if required by the specific operation.

For the Clean Project operation under Machine Learning - Experiment Tracking, only the Project Key is mandatory.

Output

The node outputs the response from the Dataiku DSS API call in the json field of the output item array.

  • For the Clean Project operation, the output will typically be a JSON object confirming the success or failure of the cleanup action.
  • If the operation involves downloading files (not applicable here), binary data would be returned accordingly.

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 set up in n8n.
  • Missing Required Parameters: The node validates required parameters like Project Key before making API calls. Ensure all mandatory fields are filled.
  • API Errors: Errors returned from the Dataiku DSS API will be surfaced with messages prefixed by "Error calling Dataiku DSS API". Check the message and stack trace for details.
  • Network Issues: Connectivity problems to the Dataiku DSS server will cause request failures. Verify network access and server availability.

Links and References


This summary focuses on the Machine Learning - Experiment Tracking resource and the Clean Project operation as requested.

Discussion