Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node interacts with the Dataiku DSS API to perform various operations related to managing long-running tasks, among many other resources. Specifically for the "Long Task" resource and the "Get Running Task State" operation, it retrieves the current state of a running long task identified by a Job ID. This is useful in scenarios where you need to monitor the progress or status of asynchronous or lengthy processes within Dataiku DSS.

Practical examples include:

  • Monitoring the execution state of a data processing job that runs asynchronously.
  • Checking if a long task has completed, failed, or is still running before proceeding with dependent workflow steps.
  • Integrating Dataiku DSS long task status checks into automated workflows for alerting or conditional logic.

Properties

Name Meaning
Job ID The identifier of the long-running task (job) whose state you want to retrieve.
Query Parameters Optional additional query parameters as key-value pairs to customize the API request.

The "Query Parameters" collection supports multiple optional parameters such as active, activity, allUsers, limit, page, wait, etc., which can be used to filter or control the API response. For this specific operation, these parameters are appended as URL query strings.

Output

The node outputs JSON data representing the state of the requested running long task. The structure corresponds directly to the Dataiku DSS API response for the long task's state endpoint. It typically includes details such as:

  • Current status of the task (e.g., running, completed, failed).
  • Progress information.
  • Any relevant metadata about the task execution.

If the operation involves downloading files or binary content (not applicable for this operation), the node would output binary data accordingly.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key credential) for authentication with the Dataiku DSS API.
  • The node uses HTTP requests to communicate with the Dataiku DSS REST API endpoints.

Troubleshooting

  • Missing Credentials: If the API credentials are not set or invalid, the node will throw an error indicating missing Dataiku DSS API credentials.
  • Missing Required Parameters: The node validates required parameters like Job ID for this operation. Omitting these will cause errors specifying which parameter is missing.
  • API Errors: Errors returned from the Dataiku DSS API (e.g., 404 if the job does not exist, 401 for unauthorized access) will be surfaced as node errors with descriptive messages.
  • Network Issues: Connectivity problems to the Dataiku DSS server will result in request failures; ensure the server URL and network access are correct.
  • Unexpected Response Format: If the API returns unexpected data, parsing errors may occur; verify the API version compatibility.

Links and References


This summary focuses on the "Long Task" resource and the "Get Running Task State" operation as requested, based on static analysis of the provided source code and property definitions.

Discussion