Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API
Join our community

Actions364

Overview

This node interacts with the Dataiku DSS API to perform various operations on different resources within a Dataiku DSS instance. Specifically, for the Job resource and the Get Job Status operation, it retrieves the current status of a specified job in a given project. This is useful for monitoring job progress, checking if a job has completed successfully, or diagnosing issues with job execution.

Common scenarios include:

  • Monitoring the state of data processing or model training jobs.
  • Automating workflows that depend on job completion status.
  • Integrating job status checks into larger automation pipelines.

Example: You can use this node to query the status of a long-running data preparation job by providing the project key and job ID, then take conditional actions based on whether the job succeeded or failed.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku DSS project where the job is running.
Job ID The unique identifier of the job whose status you want to retrieve.

Output

The output contains a JSON object representing the job status as returned by the Dataiku DSS API. This includes details summarizing the state of the job and its activities, such as whether it is running, succeeded, failed, or aborted, along with any relevant metadata about the job.

If the job status retrieval is successful, the output will be an array with one element containing the parsed JSON response from the API under the json field.

No binary data output is produced for this operation.

Dependencies

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

Troubleshooting

  • Missing Credentials Error: If the API credentials are not provided or invalid, the node will throw an error indicating missing credentials.
  • Required Parameters Missing: The node validates that both "Project Key" and "Job ID" are provided; otherwise, it throws an error specifying which parameter is missing.
  • API Request Failures: Network issues, incorrect server URL, or insufficient permissions may cause API request failures. The node will report errors with messages from the API.
  • Parsing Errors: If the API returns non-JSON responses unexpectedly, the node attempts to handle them gracefully but may fail if the response format is unexpected.

To resolve these issues:

  • Ensure valid API credentials are set up.
  • Provide all required parameters.
  • Verify network connectivity and API endpoint correctness.
  • Check user permissions in Dataiku DSS for accessing job information.

Links and References

Discussion