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 project deployment management, among many other resources. Specifically for the Project Deployer resource and the Get Deployment Status operation, it retrieves the current status of a specified project deployment on the Dataiku Project Deployer service.

This is useful in automation workflows where you need to monitor or check the state of a deployment, such as verifying if a deployment is active, completed, failed, or in progress before triggering subsequent steps.

Practical example:

  • After initiating a deployment of a project via the Project Deployer, use this node operation to poll and get the deployment status periodically until it reaches a desired state (e.g., "deployed" or "failed").
  • Integrate deployment status checks into CI/CD pipelines to automate deployment monitoring and alerting.

Properties

Name Meaning
Deployment ID The unique identifier of the deployment whose status you want to retrieve.

The node also requires credentials for accessing the Dataiku DSS API, specifically an API key and server URL, but these are configured separately and not exposed as input properties here.

Output

The output JSON contains the deployment status information returned by the Dataiku DSS API for the specified deployment ID. This typically includes details such as:

  • Current state of the deployment (e.g., running, succeeded, failed)
  • Progress or percentage completion
  • Any error messages or logs related to the deployment
  • Metadata about the deployment like timestamps, version, etc.

If the operation involves downloading files (not applicable for this operation), binary data would be returned accordingly, but for "Get Deployment Status," the output is purely JSON.

Dependencies

  • Requires a valid connection to a Dataiku DSS instance.
  • Requires an API key credential for authenticating requests to the Dataiku DSS API.
  • The node uses HTTP requests to the Dataiku DSS REST API endpoints.
  • Proper permissions on the Dataiku DSS instance to access project deployer deployments.

Troubleshooting

  • Missing Credentials Error: If the API key or server URL is not set or invalid, the node will throw an error indicating missing credentials. Ensure the API key credential is properly configured in n8n.
  • Deployment ID Required: The node throws an error if the Deployment ID property is empty when calling this operation. Make sure to provide a valid deployment ID.
  • HTTP Errors: If the deployment ID does not exist or the user lacks permission, the API may return 404 or 403 errors. Verify the deployment ID and user permissions.
  • Parsing Errors: If the API response is malformed or unexpected, JSON parsing might fail. Check the API server health and network connectivity.

Links and References


This summary focuses on the Project Deployer resource and the Get Deployment Status operation as requested, based on static analysis of the provided source code and input properties.

Discussion