Skip to main content
admin_alter_jobs(job_ids=None, action=None, options=)[source]

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.

Parameters

job_ids (list of longs) –

Jobs to be modified. The user can provide a single element (which will be automatically promoted to a list internally) or a list.

action (str) –

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

  • cancel

options (dict of str to str) –

Optional parameters. Allowed keys are:

  • job_tag – Job tag returned in call to create the job.

The default value is an empty dict ( ).

Returns

A dict with the following entries–

job_ids (list of longs) –

Jobs on which the action was performed.

action (str) –

Action requested on the jobs.

status (list of str) –

Status of the requested action for each job.

info (dict of str to str) –

Additional information.