Version:

Show Proc StatusΒΆ

Shows the statuses of running or completed proc instances. Results are grouped by run ID (as returned from Execute Proc) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).

Input Parameter Description

Name Type Description
run_id string The run ID of a specific running or completed proc instance for which the status will be returned. If the run ID is not found, nothing will be returned. If not specified, the statuses of all running and completed proc instances will be returned. Default value is ''.
options map of strings

Optional parameters. Default value is an empty map ( {} ).

Supported Parameters (keys) Parameter Description
clear_complete

If set to true, if a proc instance has completed (either successfully or unsuccessfully) then its status will be cleared and no longer returned in subsequent calls. Default value is 'false'. The allowed values are:

  • true
  • false

Output Parameter Description

Name Type Description
proc_names map of strings The proc names corresponding to the returned run IDs.
params map of maps of strings The string params passed to Execute Proc for the returned run IDs.
bin_params map of maps of bytes The binary params passed to Execute Proc for the returned run IDs.
input_table_names map of arrays of strings The input table names passed to Execute Proc for the returned run IDs.
input_column_names map of maps of arrays of strings The input column names passed to Execute Proc for the returned run IDs, supplemented with the column names for input tables not included in the input column name map.
output_table_names map of arrays of strings The output table names passed to Execute Proc for the returned run IDs.
options map of maps of strings The optional parameters passed to Execute Proc for the returned run IDs.
overall_statuses map of strings

Overall statuses for the returned run IDs. Note that these are rollups and individual statuses may differ between data segments for the same run ID; see output parameter statuses and output parameter messages for statuses from individual data segments.

Allowed Values Description
running The proc instance is currently running.
complete The proc instance completed with no errors.
killed The proc instance was killed before completion.
error The proc instance failed with an error.
statuses map of maps of strings

Statuses for the returned run IDs, grouped by data segment ID.

Allowed Values Description
map of strings
Allowed Values Description
running The proc instance is currently running.
complete The proc instance completed with no errors.
killed The proc instance was killed before completion.
error The proc instance failed with an error.
messages map of maps of strings Messages containing additional status information for the returned run IDs, grouped by data segment ID.
results map of maps of maps of strings String results for the returned run IDs, grouped by data segment ID.
bin_results map of maps of maps of bytes Binary results for the returned run IDs, grouped by data segment ID.
timings map of maps of maps of longs Timing information for the returned run IDs, grouped by data segment ID.