
Apache Flink CancelJob
CertifiedCancel a running Flink job
Apache Flink CancelJob
Cancel a running Flink job
Stops a Flink job via the REST API, optionally creating a savepoint first. Supports draining streaming jobs and waits until the cancellation completes or times out.
type: io.kestra.plugin.flink.CancelJobExamples
Cancel a job with savepoint
id: cancel-flink-job
namespace: company.team
inputs:
- id: jobId
type: STRING
required: true
tasks:
- id: cancel-job
type: io.kestra.plugin.flink.CancelJob
restUrl: "http://flink-jobmanager:8081"
jobId: "{{ inputs.jobId }}"
withSavepoint: true
savepointDir: "s3://flink/savepoints/canceled/{{ execution.id }}"
drainJob: true
# jobId must be a valid Flink JobID and the Flink JobManager must be reachable.
# The savepoint path requires Flink filesystem support and storage access permissions.
Force cancel without savepoint
id: force-cancel-job
namespace: company.team
inputs:
- id: jobId
type: STRING
required: true
tasks:
- id: force-cancel
type: io.kestra.plugin.flink.CancelJob
restUrl: "http://flink-jobmanager:8081"
jobId: "{{ inputs.jobId }}"
withSavepoint: false
# jobId must be a valid Flink JobID and the Flink JobManager must be reachable.
Installation
Our standard Docker images already include this plugin. If you use a -slim image or another setup, install it with the following command:
kestractl plugins get io.kestra.plugin:plugin-flink --compatible-for $KESTRA_VERSION For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.
For Kestra CLI, replace LATEST with a specific version or version range to pin the plugin version.
Properties
jobId *string
Job ID
ID of the Flink job to cancel.
restUrl *string
Flink REST API URL
Base URL of the Flink REST API (e.g., http://flink-jobmanager: 8081).
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150cancellationTimeout integerstring
60Cancellation timeout
Maximum polling time for cancellation and savepoint completion in seconds; in-flight REST request timeouts follow the Kestra HTTP client. Defaults to 60.
drainJob booleanstring
falseDrain job
Drain streaming input before stopping. Applicable to streaming jobs only; defaults to false.
savepointDir string
Savepoint directory
Target directory for the savepoint; required when withSavepoint is true.
withSavepoint booleanstring
falseCreate savepoint before cancellation
Trigger a savepoint before cancelling the job; defaults to false.
Outputs
cancellationResult string
Cancellation result
Result message returned by Flink for the cancellation request.
jobId string
Cancelled job ID
ID of the Flink job that was cancelled.
savepointPath string
Savepoint path
Path to the savepoint created before cancellation when requested.