Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
CloudOS CLI Documentation
CloudOS CLI Documentation

Contents:

  • Getting Started
  • cloudos-cli
  • CLI Reference
  • API Reference
    • cloudos_cli
      • cloudos_cli.clos
      • cloudos_cli.configure
        • cloudos_cli.configure.configure
      • cloudos_cli.cost
        • cloudos_cli.cost.cost
      • cloudos_cli.datasets
        • cloudos_cli.datasets.datasets
      • cloudos_cli.import_wf
        • cloudos_cli.import_wf.import_wf
      • cloudos_cli.jobs
        • cloudos_cli.jobs.job
      • cloudos_cli.link
        • cloudos_cli.link.link
      • cloudos_cli.logging
        • cloudos_cli.logging.logger
      • cloudos_cli.procurement
        • cloudos_cli.procurement.images
      • cloudos_cli.queue
        • cloudos_cli.queue.queue
      • cloudos_cli.related_analyses
        • cloudos_cli.related_analyses.related_analyses
      • cloudos_cli.utils
        • cloudos_cli.utils.array_job
        • cloudos_cli.utils.cloud
        • cloudos_cli.utils.details
        • cloudos_cli.utils.errors
        • cloudos_cli.utils.last_wf
        • cloudos_cli.utils.requests
        • cloudos_cli.utils.resources
    • cloudos_cli._version
    • cloudos_cli.clos
    • cloudos_cli.configure
      • cloudos_cli.configure.configure
    • cloudos_cli.configure.configure
    • cloudos_cli.datasets
      • cloudos_cli.datasets.datasets
    • cloudos_cli.datasets.datasets
    • cloudos_cli.import_wf
      • cloudos_cli.import_wf.import_wf
    • cloudos_cli.import_wf.import_wf
    • cloudos_cli.jobs
      • cloudos_cli.jobs.job
    • cloudos_cli.jobs.job
    • cloudos_cli.link
      • cloudos_cli.link.link
    • cloudos_cli.link.link
    • cloudos_cli.procurement
      • cloudos_cli.procurement.images
    • cloudos_cli.procurement.images
    • cloudos_cli.queue
      • cloudos_cli.queue.queue
    • cloudos_cli.queue.queue
    • cloudos_cli.utils
      • cloudos_cli.utils.array_job
      • cloudos_cli.utils.cloud
      • cloudos_cli.utils.details
      • cloudos_cli.utils.errors
      • cloudos_cli.utils.last_wf
      • cloudos_cli.utils.requests
      • cloudos_cli.utils.resources
    • cloudos_cli.utils.array_job
    • cloudos_cli.utils.cloud
    • cloudos_cli.utils.details
    • cloudos_cli.utils.errors
    • cloudos_cli.utils.last_wf
    • cloudos_cli.utils.requests
    • cloudos_cli.utils.resources
Back to top
View this page

cloudos_cli.related_analyses.related_analyses¶

cloudos_cli.related_analyses.related_analyses(cloudos_url, apikey, j_id, workspace_id, output_format, verify=True)[source]¶

Retrieve and display related analyses for a given job in a Cloudos workspace.

This function fetches the working directory and related analyses information for a specified job. If the job is a Bash job (which does not have related analyses), a warning is displayed. If the job’s intermediate results have been deleted, a message is shown indicating who deleted them and when. The related analyses can be output in JSON format or displayed as a formatted table.

Parameters:
  • cloudos_url (str) – The base URL of the Cloudos instance.

  • apikey (str) – API key for authentication.

  • j_id (str) – The ID of the job to analyze.

  • workspace_id (str) – The ID of the workspace containing the job.

  • output_format (str) – Output format, either ‘json’ or another format for table display.

  • verify (bool, optional) – Whether to verify SSL certificates. Defaults to True.

Raises:
  • ValueError – If the job does not have a working directory associated.:

  • Exception – Propagates exceptions not related to missing ‘workDirectory’ field.:

Next
cloudos_cli.utils
Previous
cloudos_cli.related_analyses
Copyright © 2025, Lifebit AI
Made with Sphinx and @pradyunsg's Furo
On this page
  • cloudos_cli.related_analyses.related_analyses
    • related_analyses()