/admin/alter/jobs

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/admin/alter/jobs

Perform the requested action on a list of one or more job(s). Based on the type of job and the current state of execution, the action may not be successfully executed. The final result of the attempted actions for each specified job is returned in the status array of the response. See Job Manager for more information.

Input Parameter Description

NameTypeDescription
job_idsarray of longsJobs to be modified.
actionstring

Action to be performed on the jobs specified by job_ids. The supported values are:

  • cancel
optionsmap of string to strings

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

Supported Parameters (keys)Parameter Description
job_tagJob tag returned in call to create the job

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

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

NameTypeDescription
job_idsarray of longsJobs on which the action was performed.
actionstringAction requested on the jobs.
statusarray of stringsStatus of the requested action for each job.
infomap of string to stringsAdditional information.

Empty string in case of an error.