Info |
---|
This topic might be out-of-date and is replaced by the following: |
In this article
Table of Contents | ||||
---|---|---|---|---|
|
...
Parameter Name | Data Type | Description | Default Value | Example |
---|---|---|---|---|
org | String | Required. The name of the Org. | N/A | DevOrg |
start | Integer | The start timestamp in milliseconds. | N/A | 1426809189000 |
end | Integer | The start timestamp in milliseconds. | N/A | 1426852861000 |
offset | Integer | The start point of the records. | 0 | 0 |
limit | Integer | The maximum number of runtimes to return in a query. The maximum possible is 1000. | 10 | 25 |
last_hours | Integer | Returns data for last n hours. The maximum limit is 1080 hours (45 days). | 1 | 48 |
pipe_name | String | Returns data for a particular Pipeline. | N/A | test pipeline |
org_wide | Boolean | Returns data for whole org including all phases. | N/A | global prod |
state | String | Indicates one of the following Pipeline states.
| N/A | Started |
invoker | String | Returns data for users who invoke the API call with this parameter. Invoker. The type of triggering mechanism for the Pipeline (case sensitive)
| N/A | invoker=scheduled |
plex_label | String | Returns the runtime information for a particular Snaplex label. | N/A | east plex |
cc_label | String | Returns the information for a particular cc label (JCC node’s hostname). | N/A | node 2 |
user_id | String | Returns information for particular users. | N/A | user_id=user_a@example.com,user_b@example.com |
project_path | String | Returns the runtime information for particular project.
| N/A | /Snaplogic/projects/test_project |
mode | String | Indicates one of the two following modes for the Pipeline: the mode of the Pipeline. | N/A | Standard |
Request Example
...
Field Key | Type | Description |
---|---|---|
prepare_handoff_timestamp | String | The Pipeline runtime prepare handoff time. |
feed_call | Boolean | A flag that indicates if the pipeline should increment the API meter (True/False). |
class_fqid | String | The Pipeline class_id with version number at the end. Format: <class_id>_<version>. |
duration | Integer | The Pipeline execution duration |
parent_ruuid | String | The runtime ID of the parent Pipeline. |
create_time | String | The time that the runtime is created. |
snode_id | String | The Snaplex node ID of the Pipeline instance. |
org_snode_id | String | The Snaplex node ID for the Org in which the Pipeline resides. |
env_map | Map | The Snaplex environment. |
instance_version | Integer | The version of instance captured by the API. |
user_id | String | The user who ran the Pipeline. |
project_snode_id | String | The Snaplex node ID for the Project in which the Pipeline resides. |
notification | Map | Indicates if a notification is set up for the Pipeline runtime. |
notification.recipients | String | Indicates who receives the notification. |
notification.states | String | When runtime state is changed to one of the other states, send notification to recipients. |
label | String | The label for the Pipeline. |
class_version | String | The version of the Snap Pack. |
snaplex_label | String | The name of the Snaplex and the JCC node label. |
time_stamp | String | The time stamp of the current operation, regardless of the runtime state. |
error_list | List | List of errors encountered at runtime. |
cc_start_ms | Integer | The start of the runtime on JCC node in milliseconds. |
invoker | String | The user who invoked the API. |
poll_time_stamp | String | The time when the SnapLogic control plane receives the runtime from JCC node. |
ccid | String | The ID for the JCC node instance. |
delivery_options | Map | Delivery options set on a child Pipeline. |
cc_external_uri | String | The external URI of the JCC node executing the Pipeline. |
runtime_path_id | String | The identifier of the Snaplex, made by the following combination: <subscriber_id>/<plex_environment>/<plex_location>. |
documents_count | Integer | The number of documents processed in the runtime. |
failure | String | Indicates if a failure occurred during document processing. |
reason | String | Indicates the reason for a failure. |
parent_pipeline_fqid | String | The unique ID for the Pipeline Execute Snap in the parent Pipeline that called the child Pipeline. |
cc_end_ms | String | The end of the runtime on the JCC Node in milliseconds. |
runtime_label | String | The name of the Snaplex. |
cc_poll_ms | Integer | The time when the JCC node pushes the runtime status in milliseconds. |
class_id | String | Instance identifier of the Pipeline instance. |
statistics_time_stamp | String | The time at which the JCC node collects statistics. |
cc_prepare_start_ms | Integer | The start time when the JCC node prepares the runtime. |
instance_id | String | The Pipeline runtime instance identifier; it is the same as the Pipeline runtime ID. |
parent_pipeline_ruuid | String | The runtime ID of the parent Pipeline. |
plex_path | String | The path of the Snaplex. |
resolution | String | The suggested action to take when the runtime fails. |
cc_prepare_end_ms | Integer | The finish time when the JCC node prepares the runtime. |
pipe_invoker | String | The method of invocation. |
references | List | The references to other SnapLogic Assets in the Pipeline runtime, including the following reference types:
|
message_history | map | The messages from a FeedMaster during the runtime. Each message includes the following timestamps:
|
delivery_count | Integer | The number of messages delivered to the FeedMaster. Another field named JMSXDeliveryCount reports the same statistic. |
Monitoring API Usage for Tasks
...