Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API to perform various operations on different resources within a Dataiku DSS instance. Specifically, for the Long Task resource and the List Tasks in Progress operation, it retrieves a list of long-running tasks currently in progress on the DSS server.

This functionality is useful for monitoring and managing asynchronous or time-consuming tasks that are running in the background of a Dataiku DSS project. For example, users can track the status of data processing jobs, model training tasks, or other automated workflows that take significant time to complete.

Practical examples include:

  • Monitoring all active long tasks to check progress or identify stuck tasks.
  • Integrating task status checks into automation pipelines to trigger subsequent steps only after certain tasks complete.
  • Auditing system usage by listing all ongoing long tasks across projects.

Properties

Name Meaning
Query Parameters A collection of optional parameters to filter or modify the request when listing tasks in progress. Possible options include: active (boolean), activity (string), allUsers (boolean), limit (number), page (number), and many others as listed in the provided JSON. These parameters allow fine-grained control over which tasks are returned, such as filtering by activity type, user scope, pagination, and more.

The full list of query parameters includes many options like active, allUsers, limit, page, filter, tags, type, wait, etc., enabling detailed filtering and pagination of the long tasks.

Output

The node outputs an array of JSON objects representing the tasks currently in progress. Each object corresponds to a long task with its details as returned by the Dataiku DSS API.

If the response contains binary data (not typical for this operation), it would be output as binary data under the binary.data field, but for "List Tasks in Progress" the output is JSON.

Example output structure (simplified):

[
  {
    "taskId": "string",
    "status": "string",
    "startTime": "timestamp",
    "user": "string",
    "activity": "string",
    "progress": "number",
    ...
  },
  ...
]

The exact fields depend on the Dataiku DSS API response for long tasks.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key) for authentication with the DSS server.
  • The node uses HTTP requests to the DSS REST API endpoints.
  • No additional external services are required beyond the Dataiku DSS API.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing credentials, ensure that you have configured the API key credential for the Dataiku DSS instance in n8n.
  • Required Parameter Errors: Many operations require specific parameters (e.g., project key, job ID). For "List Tasks in Progress", no mandatory parameters are strictly required, but providing filters may help narrow results.
  • API Request Failures: Network issues, incorrect server URL, or invalid API keys will cause request failures. Verify connectivity and credentials.
  • Unexpected Response Format: If the API returns unexpected data or errors, check the API version compatibility and the correctness of query parameters.
  • Rate Limits or Permissions: Ensure the API key has sufficient permissions to list long tasks and that the DSS instance is not rate-limiting requests.

Links and References


This summary focuses on the "Long Task" resource and the "List Tasks in Progress" operation, describing how the node constructs the API request, handles input properties, and processes the output accordingly.

Discussion