/kill/proc

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/kill/proc

Kills a running proc instance.

Input Parameter Description

NameTypeDescription
run_idstringThe run ID of a running proc instance. If a proc with a matching run ID is not found or the proc instance has already completed, no procs will be killed. If not specified, all running proc instances will be killed. The default value is ''.
optionsmap of string to strings

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

Supported Parameters (keys)Parameter Description
run_tagIf input parameter run_id is specified, kill the 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, kill the proc instance(s) 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'kill_proc_request' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

This embedded JSON represents the result of the /kill/proc endpoint:

NameTypeDescription
run_idsarray of stringsList of run IDs of proc instances that were killed.
infomap of string to stringsAdditional information.

Empty string in case of an error.