Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node interacts with the Dataiku DSS API to perform various operations on Jupyter Notebooks within a Dataiku project. Specifically, for the "Notebook" resource and the "List Jupyter Notebook Sessions" operation, it retrieves the list of active sessions for a specified Jupyter notebook in a given project.

This functionality is useful when you want to monitor or manage active notebook sessions programmatically, such as checking which notebooks are currently in use or managing session lifecycles in an automated workflow.

Example Use Case:

  • Automate monitoring of active Jupyter notebook sessions in a Dataiku project to trigger alerts or cleanup inactive sessions.
  • Integrate session listing into a larger automation pipeline that manages notebook lifecycle or user activity.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku project containing the notebook.
Notebook Name The name of the Jupyter notebook whose active sessions you want to list.

Output

The output JSON contains the list of active sessions for the specified Jupyter notebook. Each item in the output array represents one active session with its details as returned by the Dataiku DSS API.

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

Dependencies

  • Requires an API key credential for authenticating with the Dataiku DSS API.
  • The node expects the Dataiku DSS server URL and user API key to be configured in the credentials.
  • The node makes HTTP requests to the Dataiku DSS REST API endpoints.

Troubleshooting

  • Missing Credentials Error: If the API key credential is not set or invalid, the node will throw an error indicating missing credentials.
  • Required Parameter Missing: The node validates required parameters like Project Key and Notebook Name. Omitting these will cause errors specifying which parameter is missing.
  • API Request Failures: Network issues, incorrect server URL, or insufficient permissions can cause API request failures. Check the API key permissions and network connectivity.
  • Parsing Errors: If the API response is not valid JSON, the node attempts to handle it gracefully but may return raw text or an error.

Links and References


This summary focuses on the "Notebook" resource and the "List Jupyter Notebook Sessions" operation as requested, based on static analysis of the provided source code and input properties.

Discussion