Engine

Covers Engine 2.0.0

tempest/job-cancel

Requests cancellation of a detached job owned by the requesting client. Queued jobs cancel immediately; running jobs may continue briefly while cooperative cancellation completes.

  • Category: Jobs

Request payload

FieldTypeRequirementDescription
job_idstringRequiredDetached job identifier.

Response payload

FieldTypeDescription
job_idstringDetached job identifier.
job_typestringOperation-specific job type.
client_idstringClient that owns the job.
statestringqueued, running, completed, failed, or canceled.
progress_rowsintegerCompleted work units reported by the job.
total_rowsinteger|nullTotal work units when known, otherwise null.
progress_percentnumberCompletion percentage from 0 through 100 when a total is known.
status_messagestringCurrent human-readable progress message.
errorstringFailure message, or an empty string when the job has not failed.
metadataobjectOperation-specific metadata supplied when the job was created.
resultany JSON valueOperation-specific result; meaningful after successful completion.
created_atintegerCreation time in Unix-epoch milliseconds.
started_atintegerStart time in Unix-epoch milliseconds, or 0 before execution starts.
finished_atintegerFinish time in Unix-epoch milliseconds, or 0 until terminal.
execution_lanestringgeneral or historical_query.
cancellation_requestedbooleanWhether cancellation has been requested.

Errors

  • job_id is required.
  • The job does not exist or belongs to another client.