Dataiku DSS

Overview

This node interacts with the Dataiku DSS API to perform various operations on different resources within a Dataiku DSS instance. Specifically, for the Webapp resource and the Get Webapp Backend State operation, it retrieves the current backend state of a specified web application within a project.

Common scenarios where this node is beneficial include:

• Monitoring the status of a web application backend in an automated workflow.
• Integrating Dataiku DSS webapp backend state checks into larger automation or alerting systems.
• Triggering subsequent actions based on the backend state of a webapp (e.g., restart if stopped).

Practical example:

• You have a Dataiku DSS webapp deployed for data visualization. Using this node, you can periodically check if the backend is running properly and notify your team or trigger a restart if it is down.

Properties

Output

The output JSON contains the response from the Dataiku DSS API endpoint that provides the backend state of the specified webapp. This typically includes details about the current status of the backend service such as whether it is running, stopped, or in an error state.

If the operation involves downloading files (not applicable here), binary data would be returned accordingly, but for this operation, the output is purely JSON describing the backend state.

Example output structure (conceptual):

{
  "status": "RUNNING",
  "lastRestartTime": "2024-06-01T12:34:56Z",
  "uptimeSeconds": 3600,
  "errorMessage": null
}

Dependencies

• Requires an active connection to a Dataiku DSS instance.
• Needs an API authentication token credential for the Dataiku DSS API.
• The node expects the Dataiku DSS server URL and user API key to be configured in the credentials.
• No additional external services are required beyond the Dataiku DSS API.

Troubleshooting

• Missing Credentials Error: If the node throws an error about missing API credentials, ensure that the Dataiku DSS API credentials are correctly set up in n8n.
• Required Parameter Errors: The node validates required parameters like Project Key and Webapp ID. Missing these will cause errors. Make sure these inputs are provided.
• API Request Failures: Network issues or incorrect server URLs can cause request failures. Verify connectivity and correct server address.
• Unexpected Response Format: If the API changes or returns unexpected data, parsing errors may occur. Check the Dataiku DSS API documentation for updates.

Links and References

• Dataiku DSS API Documentation
• Dataiku DSS Webapps Management
• n8n Documentation on Custom Nodes