View Runs

Pipeline enables users to list and search historical pipeline runs, facilitating monitoring and analysis of pipeline execution.

View Runs via Console

1. Go to the pipeline overview page.
2. Select the Runs tab.
3. A table will display all the pipeline runs for you to view.

View Runs via API

This endpoint returns a paginated list of pipeline runs.

export INSTILL_API_TOKEN=********

curl -X GET 'http://localhost:8080/v1beta/namespaces/NAMESPACE_ID/pipelines/PIPELINE_ID/runs' \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $INSTILL_API_TOKEN"

from instill.clients import init_pipeline_client

pipeline = init_pipeline_client(api_token="INSTILL_API_TOKEN", url="http://localhost:8080")
pipeline.list_pipeline_runs(namespace_id="NAMESPACE_ID", pipeline_id="PIPELINE_ID")
pipeline.close()

The NAMESPACE_ID and PIPELINE_ID path parameters must be replaced with the pipeline owner's ID (namespace) and the pipeline ID.

Run Object

The View Runs API returns a list of Run objects in the response. Below are the key fields:

• pipelineUid: The unique identifier of the pipeline.
• pipelineVersion: The specific version of the pipeline.
• pipelineRunUid: The unique identifier of the pipeline run.
• status: The current run status.
• source: The trigger method for the pipeline run.
• inputs: The inputs provided to the pipeline run.
• outputs: The resulting outputs of the pipeline run.
• recipeSnapshot: A snapshot of the pipeline's recipe at the time of execution.

For additional details, please refer to the API reference.

Example Run Object:

{
  "pipelineUid": "748d52a3-0c88-48d4-a7a9-a39b1da9707a",
  "pipelineRunUid": "1be6fac3-8aa0-409e-919f-27d31e1daeab",
  "pipelineVersion": "latest",
  "status": "RUN_STATUS_COMPLETED",
  "source": "RUN_SOURCE_CONSOLE",
  "totalDuration": 11788,
  "runnerId": "admin",
  "inputsReference": [
      {
        ...
      }
  ],
  "inputs": [
      {
        ...
      }
  ],
  "outputsReference": [
      {
        ...
      }
  ],
  "outputs": [
      {
        ...
      }
  ],
  "recipeSnapshot": {
      ...
  },
  "startTime": "2024-10-01T14:51:46.918797Z",
  "completeTime": "2024-10-01T14:51:58.811019Z"
}