Apache Flink CancelJob

Apache Flink CancelJob

Certified

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.

yaml
type: io.kestra.plugin.flink.CancelJob

Cancel a job with savepoint

yaml
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

yaml
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

Job ID

ID of the Flink job to cancel.

Flink REST API URL

Base URL of the Flink REST API (e.g., http://flink-jobmanager: 8081).

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.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset 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.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
Default60

Cancellation timeout

Maximum polling time for cancellation and savepoint completion in seconds; in-flight REST request timeouts follow the Kestra HTTP client. Defaults to 60.

Defaultfalse

Drain job

Drain streaming input before stopping. Applicable to streaming jobs only; defaults to false.

Savepoint directory

Target directory for the savepoint; required when withSavepoint is true.

Defaultfalse

Create savepoint before cancellation

Trigger a savepoint before cancelling the job; defaults to false.

Cancellation result

Result message returned by Flink for the cancellation request.

Cancelled job ID

ID of the Flink job that was cancelled.

Savepoint path

Path to the savepoint created before cancellation when requested.