/admin/show/jobs

URL: http://<db.host>:<db.port>/admin/show/jobs

Get a list of the current jobs in GPUdb.

Input Parameter Description

NameTypeDescription
optionsmap of string to strings

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

Supported Parameters (keys)Parameter Description
show_async_jobs

If true, then the completed async jobs are also included in the response. By default, once the async jobs are completed they are no longer included in the jobs list. The default value is false. The supported values are:

  • true
  • false
show_worker_info

If true, then information is also returned from worker ranks. By default only status from the head rank is returned. The supported values are:

  • true
  • false

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'admin_show_jobs_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

This embedded JSON represents the result of the /admin/show/jobs endpoint:

NameTypeDescription
job_idarray of longs 
statusarray of strings 
endpoint_namearray of strings 
time_receivedarray of longs 
auth_idarray of strings 
source_iparray of strings 
query_textarray of strings 
user_dataarray of strings 
flagsarray of strings 
infomap of string to strings

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

Possible Parameters (keys)Parameter Description
job_tagThe job tag specified by the user or if unspecified by user, an internally generated unique identifier for the job across clusters.
worker_infoWorker job information as json

Empty string in case of an error.