> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# /show/proc/status

```
URL: http://<db.host>:<db.port>/show/proc/status
```

Shows the statuses of running or completed proc instances. Results are grouped
by run ID (as returned from [/execute/proc](/content/api/rest/execute_proc_rest))
and data segment ID (each invocation of the proc command on a data segment is
assigned a data segment ID).

## Input Parameter Description

<ParamField body="run_id" type="string">
  The run ID of a specific proc instance for which the status will be returned. If a proc with a matching run ID is not found, the response will be empty. If not specified, the statuses of all executed proc instances will be returned.

  The default value is ''.
</ParamField>

<ParamField body="options" type="map of string to strings">
  Optional parameters.

  The default value is an empty map ( \{} ).

  <Expandable title="options">
    <ParamField body="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.

      The default value is `false`.

      The supported values are:

      * true
      * false
    </ParamField>

    <ParamField body="run_tag">
      If input parameter *run\_id* is specified, return the status for a proc instance that has a matching run ID and a matching run tag that was provided to [/execute/proc](/content/api/rest/execute_proc_rest). If input parameter *run\_id* is not specified, return statuses for all proc instances where a matching run tag was provided to [/execute/proc](/content/api/rest/execute_proc_rest).

      The default value is ''.
    </ParamField>
  </Expandable>
</ParamField>

## Output Parameter Description

The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query.  Here is a description of the various fields of the wrapper:

<ResponseField name="status" type="String">
  'OK' or 'ERROR'
</ResponseField>

<ResponseField name="message" type="String">
  Empty if success or an error message
</ResponseField>

<ResponseField name="data_type" type="String">
  'show\_proc\_status\_response' or 'none' in case of an error
</ResponseField>

<ResponseField name="data" type="String">
  Empty string
</ResponseField>

<ResponseField name="data_str" type="JSON or String">
  This embedded JSON represents the result of the /show/proc/status endpoint:

  <Expandable title="data_str">
    <ResponseField name="proc_names" type="map of string to strings">
      The proc names corresponding to the returned run IDs.
    </ResponseField>

    <ResponseField name="params" type="map of string to maps of string to strings">
      The string params passed to [/execute/proc](/content/api/rest/execute_proc_rest) for the returned run IDs.
    </ResponseField>

    <ResponseField name="bin_params" type="map of string to maps of string to bytes">
      The binary params passed to [/execute/proc](/content/api/rest/execute_proc_rest) for the returned run IDs.
    </ResponseField>

    <ResponseField name="input_table_names" type="map of string to arrays of strings">
      The input table names passed to [/execute/proc](/content/api/rest/execute_proc_rest) for the returned run IDs.
    </ResponseField>

    <ResponseField name="input_column_names" type="map of string to maps of string to arrays of strings">
      The input column names passed to [/execute/proc](/content/api/rest/execute_proc_rest) for the returned run IDs, supplemented with the column names for input tables not included in the input column name map.
    </ResponseField>

    <ResponseField name="output_table_names" type="map of string to arrays of strings">
      The output table names passed to [/execute/proc](/content/api/rest/execute_proc_rest) for the returned run IDs.
    </ResponseField>

    <ResponseField name="options" type="map of string to maps of string to strings">
      The optional parameters passed to [/execute/proc](/content/api/rest/execute_proc_rest) for the returned run IDs.
    </ResponseField>

    <ResponseField name="overall_statuses" type="map of string to 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.

      * **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.
      * **none**: The proc instance does not have a status, i.e. it has not yet ran.
    </ResponseField>

    <ResponseField name="statuses" type="map of string to maps of string to strings">
      Statuses for the returned run IDs, grouped by data segment ID.

      * **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.
      * **none**: The proc instance does not have a status, i.e. it has not yet ran.
    </ResponseField>

    <ResponseField name="messages" type="map of string to maps of string to strings">
      Messages containing additional status information for the returned run IDs, grouped by data segment ID.
    </ResponseField>

    <ResponseField name="results" type="map of string to maps of string to maps of string to strings">
      String results for the returned run IDs, grouped by data segment ID.
    </ResponseField>

    <ResponseField name="bin_results" type="map of string to maps of string to maps of string to bytes">
      Binary results for the returned run IDs, grouped by data segment ID.
    </ResponseField>

    <ResponseField name="output" type="map of string to maps of string to maps of string to arrays of strings">
      Output lines for the returned run IDs, grouped by data segment ID.

      <Expandable title="output">
        <ResponseField name="stdout">
          Output lines from stdout.
        </ResponseField>

        <ResponseField name="stderr">
          Output lines from stderr.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="timings" type="map of string to maps of string to maps of string to longs">
      Timing information for the returned run IDs, grouped by data segment ID.
    </ResponseField>

    <ResponseField name="info" type="map of string to strings">
      Additional information.
    </ResponseField>
  </Expandable>

  Empty string in case of an error.
</ResponseField>