Note

This documentation is for a prior release of Kinetica. For the latest documentation, click here.

/admin/alter/jobs

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

Name

Type

Description

job_ids

array of longs

Jobs to be modified.

action

string

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

cancel

options

map of string to strings

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

Supported Parameters (keys)	Parameter Description
job_tag	Job 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:

Name

Type

Description

status

String

'OK' or 'ERROR'

message

String

Empty if success or an error message

data_type

String

'admin_alter_jobs_response' or 'none' in case of an error

data

String

Empty string

data_str

JSON or String

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

Name	Type	Description
job_ids	array of longs	Jobs on which the action was performed.
action	string	Action requested on the jobs.
status	array of strings	Status of the requested action for each job.
info	map of string to strings	Additional information.

Empty string in case of an error.