/show/proc/status

URL: https://<aws.fqdn>/<aws.cluster.name>/gpudb-0/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

NameTypeDescription
run_idstringThe 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 ''.
optionsmap of string to strings

Optional parameters. The 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. The default value is false. The supported values are:

  • true
  • false
run_tagIf 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. If input parameter run_id is not specified, return statuses for all proc instances where a matching run tag was provided to /execute/proc. The default value is ''.

Output Parameter Description

The GPUdb 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:

NameTypeDescription
statusString'OK' or 'ERROR'
messageStringEmpty if success or an error message
data_typeString'show_proc_status_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

This embedded JSON represents the result of the /show/proc/status endpoint:

NameTypeDescription
proc_namesmap of string to stringsThe proc names corresponding to the returned run IDs.
paramsmap of string to maps of string to stringsThe string params passed to /execute/proc for the returned run IDs.
bin_paramsmap of string to maps of string to bytesThe binary params passed to /execute/proc for the returned run IDs.
input_table_namesmap of string to arrays of stringsThe input table names passed to /execute/proc for the returned run IDs.
input_column_namesmap of string to maps of string to arrays of stringsThe 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_namesmap of string to arrays of stringsThe output table names passed to /execute/proc for the returned run IDs.
optionsmap of string to maps of string to stringsThe optional parameters passed to /execute/proc for the returned run IDs.
overall_statusesmap 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.

Possible ValuesDescription
runningThe proc instance is currently running.
completeThe proc instance completed with no errors.
killedThe proc instance was killed before completion.
errorThe proc instance failed with an error.
noneThe proc instance does not have a status, i.e. it has not yet ran.
statusesmap of string to maps of string to strings

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

Possible ValuesDescription
map of string to strings
Possible ValuesDescription
runningThe proc instance is currently running.
completeThe proc instance completed with no errors.
killedThe proc instance was killed before completion.
errorThe proc instance failed with an error.
noneThe proc instance does not have a status, i.e. it has not yet ran.
messagesmap of string to maps of string to stringsMessages containing additional status information for the returned run IDs, grouped by data segment ID.
resultsmap of string to maps of string to maps of string to stringsString results for the returned run IDs, grouped by data segment ID.
bin_resultsmap of string to maps of string to maps of string to bytesBinary results for the returned run IDs, grouped by data segment ID.
outputmap 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.

Possible ValuesDescription
map of string to maps of string to arrays of strings
Possible ValuesDescription
map of string to arrays of strings
Possible Parameters (keys)Parameter Description
stdoutOutput lines from stdout.
stderrOutput lines from stderr.
timingsmap of string to maps of string to maps of string to longsTiming information for the returned run IDs, grouped by data segment ID.
infomap of string to stringsAdditional information.

Empty string in case of an error.