Retrieve info about a pipeline execution

GET /runtime/{env_org}/{ruuid}?{query_parameters}

Overview

This API retrieves information about the pipeline execution with the specified Runtime ID.

Prerequisites

  • Read access to the requested assets

Request

 GET https://{controlplane_path}/api/1/rest/public/runtime/{env_org}/{ruuid}?{query_parameters}

Path Parameters

Key Description
controlplane_path Required. The path to the SnapLogic control plane.

Example: control-plane-name.snaplogic.com

Where control-plane-name is the control plane you are using. For example,
  • elastic
  • uat
  • emea
org Required. The name of the SnapLogic Environment/Org.
ruuid Required. The Runtime ID of the pipeline.
To get the Runtime ID of a running pipeline:
  1. Go to Dashboard > Pipeline.
  2. In the Executing Pipelines of All Projects list, click the pipeline you want.
  3. From the address bar of the web browser tab that displays the pipeline, copy the value of the parameter pipe_runtime_id.

Query Parameters

Key Type Description
level string Returns task run information at the specified level of detail.
Valid values:
  • summaryReturns summarized information.
  • detail Returns detailed information.

Default: detail

Note: The level summary and detail are case-sensitive. When summary is selected, certain fields like session_id, snap_map, and export_link are excluded from the response. Alternatively, if no level is specified, the system defaults to detail.

Request Header

Specify Basic for authorization and application/json for content type.

 Authorization: Basic {your_encoded_security_credentials}
Content-Type: application/json

Request Body

None.

Response

Response Body

Note: The results include:
  • Only the pipeline executions that you have permissions to view. Environment/Org admins can view all pipeline executions.
  • Up to 500 of the most recent runs of a child pipeline within a single run of the parent pipeline.
 {
  "response_map": {
    "feed_call": true,
    "subpipeline_parameters": { ... },
    "llfeed_status": {
      "message_history": [ ... ],
      "messages": [ ... ],
      "documents_count": ...,
      "max_in_flight": ...,
      "summary": "..."
    },
    "class_fqid": "...",
    "snode_id": "...",
    "ttl": ...,
    "org_snode_id": "...",
    "cc_prepare_end_ms": ...,
    "parent_path": "...",
    "error_list": [ ... ],
    "child_count": ...,
    "data_locations": [ ... ],
    "env_map": { ... },
    "restart_attempts": ...,
    "error_documents_count": ...,
    "env_map_list": [
      {
        "ciphertext": "...",
        "sym_key": {
          "alias": "...",
          "key": "..."
        }
      }
    ],
    "statistics_time_stamp": "...",
    "job_trigger": "...",
    "cc_fast_push_expire_time_ms": ...,
    "fault_injections": ...,
    "slserver_lease_expire_time": "...",
    "cc_poll_ms": ...,
    "instance_id": "...",
    "mode": "...",
    "async": ...,
    "pipe_invoker": "...",
    "create_time": "...",
    "duration": ...,
    "notification": {
      "slack_recipients": [
        {
          "user": [ ... ],
          "channel": [ ... ]
        }
      ]
    },
    "label": "...",
    "state": "...",
    "replicaset_label": "...",
    "invoker": "...",
    "cc_user": "...",
    "time_stamp": "...",
    "cc_external_uri": "...",
    "partition_snode_id": "...",
    "lint_id_list": [ ... ],
    "reason": "...",
    "threads": [ ... ],
    "prepare_handoff_timestamp": "...",
    "slot_count": ...,
    "end_stage": "...",
    "search": "...",
    "limits": "...",
    "class_id": "...",
    "has_lints": ...,
    "q_threshold_time": "...",
    "control_plane_scheduling": [
      {
        "update_buckets": { ... },
        "leases": { ... },
        "stats": {
          "active_pipelines": [ ... ],
          "cpu_user": ...,
          "mem_used": ...,
          "active_threads": ...,
          "open_file_descriptors": ...,
          "system_load_average": ...
        },
        "generation": ...,
        "slots_in_use": ...,
        "time_stamp": "...",
        "_id": "..."
      }
    ],
    "suggest_uris": "...",
    "task_status": [ ... ],
    "cc_prepare_start_ms": ...,
    "phase_snode_id": "...",
    "duration_ms": ...,
    "parent_ruuid": "...",
    "references": [
      {
        "path": "...",
        "pipe_origin": "...",
        "time_updated": "...",
        "asset_type": "...",
        "snode_id": "..."
      }
    ],
    "do_start": ...,
    "statistics": {
      "output_views": { ... },
      "input_views": { ... }
    },
    "user_id": "...",
    "connect_pipeline_views": ...,
    "container_type": "...",
    "priority": ...,
    "instance_fqid": "...",
    "info_flag_list": [ ... ],
    "runtime_path_id": "...",
    "lint_list": [ ... ],
    "failure": "...",
    "state_log": [
      {
        "timestamp": ...,
        "ccid": "...",
        "new_state": "NoUpdate"
      },
      {
        "timestamp": ...,
        "new_state": "Prepared"
      },
      {
        "timestamp": ...,
        "new_state": "Started"
      }
    ],
    "ruuid": "...",
    "parent_pipeline_fqid": "...",
    "execution_timeout": "...",
    "path_id": "...",
    "plex_snode_id": "...",
    "error": { ... },
    "plex_path": "...",
    "invoker_snode_id": "...",
    "invoker_path_id": "...",
    "snaplex_label": "...",
    "platform_globals": {
      "task": {
        "start": {
          "_snaptype_datetime": "..."
        },
        "end": {
          "_snaptype_datetime": "..."
        }
      }
    },
    "init_xid": "...",
    "nested_pipeline": ...,
    "project_snode_id": "...",
    "class_version": ...,
    "warning_list": [ ... ],
    "root_ruuid": "...",
    "cc_start_ms": ...,
    "poll_time_stamp": "...",
    "artifacts_map": {
      "...": "..."
    },
    "artifact_snap_id_map": {
      "...": "..."
    },
    "ccid": "...",
    "delivery_options": { ... },
    "metrics": {
      "queuedCount": ...,
      "totalSnapDelay": ...,
      "idleTime": ...,
      "memoryOverhead": ...,
      "inFlightCount": ...,
      "startTime": ...
    },
    "expire_time": "...",
    "runtime_label": "...",
    "cc_stop_ms": ...,
    "root_path": "...",
    "invoker_name": "...",
    "error_fp_list": [ ... ],
    "flags": {
      "immediate_mode": ...,
      "is_suggest": ...,
      "connect_views_to_relay": ...
    },
    "captured_env_map": {
      "key1": {
        "captured": ...,
        "value": "..."
      }
    },
    "llfeed_context": {
      "path_id": "...",
      "job_alias": "...",
      "masters": [
        {
          "uri": "...",
          "certificate": "...",
          "cc_id": "..."
        }
      ],
      "max_in_flight": ...
    },
    "documents_count": ...,
    "resolution": "..."
  },
  "http_status_code": 200
}
Key Type Description
feed_call Boolean If true, the pipeline execution increments the API meter.
subpipeline_parameters object If the pipeline execution was triggered by a parent pipeline, the key-value pairs of parameters passed to this child pipeline.
llfeed_status object
  • message_history. (array) The history of messages received from a FeedMaster.
  • messages. (array) An array of strings containing recent messages from a FeedMaster during pipeline execution. Each message includes the following timestamps:
    • recv_time. The time when a FeedMaster node receives the message to send to the JCC node.
    • start_time. The time when the JCC node receives the message from the FeedMaster node.
    • ack_time. The time when the JCC node acknowledges the message and removes it.
    • reply_time. The time when the JCC node replies to a message sent from the FeedMaster node.
  • documents_count. (integer) The number of documents processed.
  • max_in_flight. (integer) The maximum number of concurrent pipeline executions that the Environment/Org is allowed.
  • summary. (string) A summary of the feed status.
class_fqid string The fully-qualified ID of a Snap.

Format: {Snap_class_id}_{class_version}

snode_id string The ID of the JCC node that contains the pipeline execution instance.
ttl integer A pipeline execution's time to live, expressed in milliseconds.
org_snode_id string The ID of the Snaplex node that hosts the Environment/Org of the pipeline.
cc_prepare_end_ms integer The time when the JCC node completed preparing the pipeline execution instance, expressed in milliseconds.
parent_path string The path to the parent pipeline, if this pipeline is a child.
delete_time string When the pipeline execution was deleted.

Format: UTC

error_list array Errors encountered at runtime.
child_count integer The number of children of this pipeline.
data_locations array An array of objects containing information about each data location (source or target).
env_map object Information about the Snaplex environment.
restart_attempts integer The number of attempts to restart the pipeline execution after a failure or suspension.
error_documents_count integer The number of documents that had errors.
env_map_list array An array of objects containing:
  • ciphertext. (string)
  • sym_key. (Object) An object containing the alias and key.
statistics_time_stamp string The time when the JCC node collects statistics.

Format: UTC

job_trigger string
cc_fast_push_expire_time_ms integer Expressed in milliseconds.
fault_injections string
slserver_lease_expire_time string

Format: UTC

cc_poll_ms integer The time when the JCC node pushes the runtime status, expressed in milliseconds.
instance_id string The identifier of the pipeline execution instance; the same as the pipeline Runtime ID.
mode string The mode of the pipeline execution.
Possible values:
  • standard
async Boolean If true, the pipeline execution was run asynchronously.

Learn more: Understanding Synchronous and Asynchronous Execution of Triggered Tasks

pipe_invoker string How the pipeline was invoked.
Possible values:
  • always_on
create_time string The time when the pipeline execution instance was created.

Format: UTC

duration integer The length of time that the pipeline ran, expressed in milliseconds.
notification object Information about recipients of notifications.
label string The name of the pipeline.
state string The status of the pipeline execution.
Valid values:
  • Queued – Pipeline is queued for processing; all pipelines start in this state.
  • NoUpdate – Intermediate state at startup.
  • Prepared – Pipeline has been prepared.
  • Started – Pipeline has started running.
  • Completed – Pipeline has completed successfully.
  • Failing – Pipeline encountered an error and is waiting for Snaps to complete execution before moving to the Failed state.
  • Failed – Pipeline failed.
  • Stopped – Pipeline was stopped either by the user or by the system, as indicated by the "stopper" key.
  • Stopping – Pipeline is stopping.
  • Suspending – Resumable Pipeline encountered an error and is storing its state.
  • Suspended – Resumable Pipeline encountered an error and is suspended.
  • Resuming – Resumable Pipeline is loading its state and will resume execution where it left off.
replicaset_label string
invoker string The user who invoked the pipeline execution.
cc_user string
time_stamp string The timestamp of the current operation, regardless of the runtime state.

Format: UTC

cc_external_uri string The external URI of the JCC node where the pipeline is running.
partition_snode_id string The ID of the Snaplex node partition where the pipeline ran.
lint_id_list array
reason string The reason for the failure, if any.
threads array
prepare_handoff_timestamp string The time when the pipeline execution instance is prepared.

Format: UTC

slot_count integer
end_stage string
Possible values:
  • EXECUTE
search string The search string used to locate this pipeline execution.
limits string
class_id string The identifier of the pipeline execution instance.
has_lints Boolean
q_threshold_time string

Format: UTC

control_plane_scheduling array
suggest_uris string
task_status array
cc_prepare_start_ms integer The time when the JCC node starts preparing the pipeline execution instance, expressed in milliseconds
phase_snode_id string
duration_ms integer Expressed in milliseconds.
parent_ruuid string The Runtime ID of the parent pipeline that triggered this child pipeline.
references array The references to other SnapLogic assets in the pipeline execution, including the following reference types:
  • path. The path to the referenced asset.
  • pipe_origin. If applicable, the referenced parent pipeline (indicated by pipe_exec or subpipeline).
  • time_updated. The time of the most recent asset update.
  • asset_type. The type of asset that is referenced.
  • snode_id. The ID of the node containing the referenced SnapLogic asset.
do_start Boolean
statistics object
user_id string The user who ran the pipeline.
connect_pipeline_views Boolean
container_type string The type of container (JCC node).
Possible values:
  • regular
  • mixed
  • null
priority integer The priority of this pipeline execution instance.
instance_fqid string The fully qualified ID of this pipeline execution instance.
info_flag_list array
runtime_path_id string The identifier of the Snaplex.

Format: {org}/rt/{snaplex-location}/{snaplex-environment}

lint_list array
failure Boolean Indicates if a failure occurred during document processing.
state_log array An array of objects containing changes in the state, the timestamp for each change, and other information.
Possible values:
  • Queued – Pipeline is queued for processing; all pipelines start in this state.
  • NoUpdate – Intermediate state at startup.
  • Prepared – Pipeline has been prepared.
  • Started – Pipeline has started running.
  • Completed – Pipeline has completed successfully.
  • Failing – Pipeline encountered an error and is waiting for Snaps to complete execution before moving to the Failed state.
  • Failed – Pipeline failed.
  • Stopped – Pipeline was stopped either by the user or by the system, as indicated by the "stopper" key.
  • Stopping – Pipeline is stopping.
  • Suspending – Resumable Pipeline encountered an error and is storing its state.
  • Suspended – Resumable Pipeline encountered an error and is suspended.
  • Resuming – Resumable Pipeline is loading its state and will resume execution where it left off.
ruuid string The Runtime ID of the pipeline execution.
parent_pipeline_fqid string The fully qualified ID of the (parent) pipeline execution that triggered this (child) pipeline execution.
execution_timeout string
path_id string
plex_snode_id string
error object If errors occurred, an object containing metadata about the errors.
plex_path string The path to the Snaplex.
invoker_snode_id string The ID of the Snaplex node where the parent or invoker is located.
invoker_path_id string
snaplex_label string The name of the Snaplex and the label of the JCC node where the pipeline ran.
platform_globals object Metadata about platform processes.

Example: task contains the timestamps when the task started and ended.

init_xid string
nested_pipeline Boolean If true, the execution is for a nested pipeline and was triggered by the parent pipeline.
project_snode_id string The ID of the Snaplex node where the project of the pipeline is located.
class_version string The version of the Snap Pack.
warning_list array If the pipeline execution generated warnings, an array of objects containing metadata about the warnings.
root_ruuid string The ID of the root pipeline execution instance, if this pipeline execution is a descendant.
cc_start_ms integer The length of time since the Snaplex node was started, expressed in milliseconds.
poll_time_stamp string The time when the SnapLogic Control Plane received the pipeline execution instance from the JCC node.

Format: UTC

artifacts_map object
artifact_snap_id_map object
ccid string The ID of the JCC node where the pipeline ran.
delivery_options object Delivery options set on a child pipeline execution.
metrics object
  • queuedCount
  • totalSnapDelay – The total number of milliseconds that Snaps within the pipeline execution were delayed.
  • idleTime
  • memoryOverhead
  • inFlightCount
  • startTime
expire_time string When the pipeline execution expires.

Format: UTC

runtime_label string The name of the pipeline.
cc_stop_ms integer Expressed in milliseconds.
root_path string
invoker_name string
error_fp_list array
flags object
captured_env_map object
llfeed_context object
documents_count integer The number of documents processed by the pipeline.
resolution string The suggested action to take when the runtime fails.