This page is no longer maintained (). For the most current information, go to https://docs.snaplogic.com/public-apis/get-runtime-org-ruuid.html. |
GET /runtime/{org}/{ruuid}
This API retrieves information about the pipeline run with the specified Runtime ID.
Read access to the requested assets
|
Key | Description |
---|---|
| Required. The path to your SnapLogic pod. Example: |
| Required. The name of the SnapLogic Org. |
| Required. The Runtime ID of the Pipeline. To get the Runtime ID of a running Pipeline:
|
Key | Type | Description |
---|---|---|
| string | Returns Task run information at the specified level of detail. Valid values:
Default: |
Specify Basic
for authorization and application/json
for content type.
|
None.
The results include only the Task runs that you have permissions to view. Org Admins can view all Task runs.
The results include only the Task runs that you have permissions to view. Org Admins can view all Task runs.
{ "response_map": { "feed_call": ..., "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 |
---|---|---|
| Boolean | If |
| object | If the Task was triggered by a parent Pipeline, the key-value pairs of parameters passed to this Task. |
| object |
|
| string | The fully-qualified ID of a Snap. It consists of the Snap class ID and the class version. |
| string | The ID Of the Snaplex node that processed the Task run. |
| integer | A Task's time to live, expressed in milliseconds. |
| string | The ID of the Snaplex node that hosts the Org. |
| integer | |
| string | The path to the parent Pipeline, if this Task is a child. |
| string | When the Task was deleted. Format: UTC |
| array | |
| integer | The number of children of this Task's Pipeline. |
| array | An array of objects containing information about each data location (source or target). |
| object | |
| integer | The number of attempts to restart the Task after a failure or suspension. |
| integer | The number of documents that had errors. |
| array | An array of Objects containing:
|
| string | |
| string ??? | |
| integer | |
| string ??? | |
| string | |
| integer | |
| string | The UUID of the Task run. |
| string | The mode of the Task run. |
| Boolean | If Learn more: Understanding Synchronous and Asynchronous Execution of Triggered Tasks |
| string | How the Pipeline was invoked. |
| string | The time when the Task run was created. Format: UTC |
| integer | The length of time the Task ran, expressed in milliseconds. |
| object | Information about recipients of notifications. |
| string | The label or name of the Task run. |
| string | The status of the Task run. |
| string | |
| string | The user that invoked the Task run. |
| string | |
| string | The time when the Task run started. Format: UTC |
| string | The URI of the node where the Task is running. |
| string | The ID of the node partition where the Task is running. |
| array | |
| string | The reason for running the Task, if specified. |
| array | |
| string | |
| integer | |
| string | |
| string | The search string used to locate this Task run. |
| string ??? | |
| string | |
| Boolean | |
| string | |
| array | |
| string | |
| integer | |
| array | |
| integer | |
| string | |
| integer | |
| string | Runtime ID of the (parent) Task that triggered this (child) Task. |
| array | |
| Boolean | |
| object | |
| string | |
| Boolean | |
| string | |
| integer | The priority of this Task instance. |
| string | The fully qualified ID of this Task instance. |
| array | |
| string | |
| array | |
| string | |
| array | An array of objects containing changes in the state, the timestamp for each change, and other information. Possible values:
|
| string | The Runtime ID of the Task run. |
| string | The fully qualified ID of the (parent) Pipeline that triggered this Task run. |
| string | |
| string | |
| string | |
| object | If errors occurred, an object containing metadata about the errors. |
| string | The path to the Snaplex where the Task ran. |
| string | The ID of the Snaplex node where the parent or invoker is located. |
| string | |
| string | The label or name of the Snaplex where the Task ran. |
| object |
|
| string | |
| Boolean | If |
| string | The ID of the Snaplex node where the project is located. |
| string | |
| array | If the Task run generated warnings, an array of objects containing metadata about the warnings. |
| string | The ID of the root Task instance, if this Task is a descendant. |
| integer | The length of time since the Snaplex node was started, expressed in milliseconds. |
| string | Format: UTC |
| object | |
| object | |
| string | The ID of the Snaplex node where the Task ran. |
| object | |
| object |
|
| string | When the Task run expires. Format: UTC |
| string | |
| string | Reason for closing the Task. |
| integer | |
| string | |
| string | |
| array | |
| object | |
| object | |
| object | |
| integer | |
| string |