Apache Flink Jobs API

openapi: 3.0.1
info:
  title: Flink JobManager REST Cluster Jobs API
  contact:
    email: user@flink.apache.org
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: v1/2.0-SNAPSHOT
tags:
- name: Jobs
paths:
  /jobs:
    get:
      description: Returns an overview over all jobs and their current state.
      operationId: getJobIdsWithStatusesOverview
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobIdsWithStatusOverview'
      summary: Apache Flink List Jobs
      tags:
      - Jobs
  /jobs/metrics:
    get:
      description: Provides access to aggregated job metrics.
      operationId: getAggregatedJobMetrics
      parameters:
      - name: get
        in: query
        description: Comma-separated list of string values to select specific metrics.
        required: false
        style: form
        schema:
          type: string
      - name: agg
        in: query
        description: 'Comma-separated list of aggregation modes which should be calculated. Available aggregations are: "min, max, sum, avg, skew".'
        required: false
        style: form
        schema:
          $ref: '#/components/schemas/AggregationMode'
      - name: jobs
        in: query
        description: Comma-separated list of 32-character hexadecimal strings to select specific jobs.
        required: false
        style: form
        schema:
          $ref: '#/components/schemas/JobID'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AggregatedMetricsResponseBody'
      summary: Apache Flink List Jobs Metrics
      tags:
      - Jobs
  /jobs/overview:
    get:
      description: Returns an overview over all jobs.
      operationId: getJobsOverview
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MultipleJobsDetails'
      summary: Apache Flink List Jobs Overview
      tags:
      - Jobs
  /jobs/{jobid}:
    get:
      description: Returns details of a job.
      operationId: getJobDetails
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobDetailsInfo'
      summary: Apache Flink Get Jobs
      tags:
      - Jobs
    patch:
      description: Terminates a job.
      operationId: cancelJob
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      - name: mode
        in: query
        description: 'String value that specifies the termination mode. The only supported value is: "cancel".'
        required: false
        style: form
        schema:
          $ref: '#/components/schemas/TerminationMode'
      responses:
        '202':
          description: The request was successful.
      summary: Apache Flink Update Jobs
      tags:
      - Jobs
  /jobs/{jobid}/accumulators:
    get:
      description: Returns the accumulators for all tasks of a job, aggregated across the respective subtasks.
      operationId: getJobAccumulators
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      - name: includeSerializedValue
        in: query
        description: Boolean value that specifies whether serialized user task accumulators should be included in the response.
        required: false
        style: form
        schema:
          type: boolean
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobAccumulatorsInfo'
      summary: Apache Flink List Jobs Accumulators
      tags:
      - Jobs
  /jobs/{jobid}/checkpoints:
    get:
      description: Returns checkpointing statistics for a job.
      operationId: getCheckpointingStatistics
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckpointingStatistics'
      summary: Apache Flink List Jobs Checkpoints
      tags:
      - Jobs
    post:
      description: Triggers a checkpoint. The 'checkpointType' parameter does not support 'INCREMENTAL' option for now. See FLINK-33723. This async operation would return a 'triggerid' for further query identifier.
      operationId: triggerCheckpoint
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckpointTriggerRequestBody'
      responses:
        '202':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TriggerResponse'
      summary: Apache Flink Create Jobs Checkpoints
      tags:
      - Jobs
  /jobs/{jobid}/checkpoints/config:
    get:
      description: Returns the checkpointing configuration.
      operationId: getCheckpointConfig
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckpointConfigInfo'
      summary: Apache Flink List Checkpoints Config
      tags:
      - Jobs
  /jobs/{jobid}/checkpoints/details/{checkpointid}:
    get:
      description: Returns details for a checkpoint.
      operationId: getCheckpointStatisticDetails
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      - name: checkpointid
        in: path
        description: Long value that identifies a checkpoint.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckpointStatistics'
      summary: Apache Flink Get Checkpoints Details
      tags:
      - Jobs
  /jobs/{jobid}/checkpoints/details/{checkpointid}/subtasks/{vertexid}:
    get:
      description: Returns checkpoint statistics for a task and its subtasks.
      operationId: getTaskCheckpointStatistics
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      - name: checkpointid
        in: path
        description: Long value that identifies a checkpoint.
        required: true
        schema:
          type: integer
          format: int64
      - name: vertexid
        in: path
        description: 32-character hexadecimal string value that identifies a job vertex.
        required: true
        schema:
          $ref: '#/components/schemas/JobVertexID'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskCheckpointStatisticsWithSubtaskDetails'
      summary: Apache Flink Get Details Subtasks
      tags:
      - Jobs
  /jobs/{jobid}/checkpoints/{triggerid}:
    get:
      description: Returns the status of a checkpoint trigger operation.
      operationId: getCheckpointStatus
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      - name: triggerid
        in: path
        description: 32-character hexadecimal string that identifies an asynchronous operation trigger ID. The ID was returned then the operation was triggered.
        required: true
        schema:
          $ref: '#/components/schemas/TriggerId'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsynchronousOperationResult'
      summary: Apache Flink Get Jobs Checkpoints
      tags:
      - Jobs
  /jobs/{jobid}/clientHeartbeat:
    patch:
      description: Report the jobClient's aliveness.
      operationId: triggerHeartbeat
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JobClientHeartbeatRequestBody'
      responses:
        '202':
          description: The request was successful.
      summary: Apache Flink Update Jobs Clientheartbeat
      tags:
      - Jobs
  /jobs/{jobid}/config:
    get:
      description: Returns the configuration of a job.
      operationId: getJobConfig
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobConfigInfo'
      summary: Apache Flink List Jobs Config
      tags:
      - Jobs
  /jobs/{jobid}/exceptions:
    get:
      description: 'Returns the most recent exceptions that have been handled by Flink for this job. The ''exceptionHistory.truncated'' flag defines whether exceptions were filtered out through the GET parameter. The backend collects only a specific amount of most recent exceptions per job. This can be configured through web.exception-history-size in the Flink configuration. The following first-level members are deprecated: ''root-exception'', ''timestamp'', ''all-exceptions'', and ''truncated''. Use the data provided through ''exceptionHistory'', instead.'
      operationId: getJobExceptions
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      - name: maxExceptions
        in: query
        description: Comma-separated list of integer values that specifies the upper limit of exceptions to return.
        required: false
        style: form
        schema:
          type: integer
          format: int32
      - name: failureLabelFilter
        in: query
        description: Collection of string values working as a filter in the form of `key:value` pairs allowing only exceptions with ALL of the specified failure labels to be returned.
        required: false
        style: form
        schema:
          $ref: '#/components/schemas/FailureLabel'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobExceptionsInfoWithHistory'
      summary: Apache Flink List Jobs Exceptions
      tags:
      - Jobs
  /jobs/{jobid}/execution-result:
    get:
      description: Returns the result of a job execution. Gives access to the execution time of the job and to all accumulators created by this job.
      operationId: getJobExecutionResult
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobExecutionResultResponseBody'
      summary: Apache Flink List Jobs Execution-Result
      tags:
      - Jobs
  /jobs/{jobid}/jobmanager/config:
    get:
      description: Returns the jobmanager's configuration of a specific job.
      operationId: getJobManagerJobConfiguration
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ConfigurationInfoEntry'
      summary: Apache Flink List Jobmanager Config
      tags:
      - Jobs
  /jobs/{jobid}/jobmanager/environment:
    get:
      description: Returns the jobmanager's environment of a specific job.
      operationId: getJobManagerJobEnvironment
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentInfo'
      summary: Apache Flink List Jobmanager Environment
      tags:
      - Jobs
  /jobs/{jobid}/jobmanager/log-url:
    get:
      description: Returns the log url of jobmanager of a specific job.
      operationId: getJobManagerLogUrl
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogUrlResponse'
      summary: Apache Flink List Jobmanager Log-Url
      tags:
      - Jobs
  /jobs/{jobid}/metrics:
    get:
      description: Provides access to job metrics.
      operationId: getJobMetrics
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      - name: get
        in: query
        description: Comma-separated list of string values to select specific metrics.
        required: false
        style: form
        schema:
          type: string
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricCollectionResponseBody'
      summary: Apache Flink List Jobs Metrics
      tags:
      - Jobs
  /jobs/{jobid}/plan:
    get:
      description: Returns the dataflow plan of a job.
      operationId: getJobPlan
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobPlanInfo'
      summary: Apache Flink List Jobs Plan
      tags:
      - Jobs
  /jobs/{jobid}/rescaling:
    patch:
      description: Triggers the rescaling of a job. This async operation would return a 'triggerid' for further query identifier.
      operationId: rescaleJob
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      - name: parallelism
        in: query
        description: Positive integer value that specifies the desired parallelism.
        required: true
        style: form
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TriggerResponse'
      summary: Apache Flink Update Jobs Rescaling
      tags:
      - Jobs
  /jobs/{jobid}/rescaling/{triggerid}:
    get:
      description: Returns the status of a rescaling operation.
      operationId: getRescalingStatus
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      - name: triggerid
        in: path
        description: 32-character hexadecimal string that identifies an asynchronous operation trigger ID. The ID was returned then the operation was triggered.
        required: true
        schema:
          $ref: '#/components/schemas/TriggerId'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsynchronousOperationResult'
      summary: Apache Flink Get Jobs Rescaling
      tags:
      - Jobs
  /jobs/{jobid}/resource-requirements:
    get:
      description: Request details on the job's resource requirements.
      operationId: getJobResourceRequirements
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobResourceRequirementsBody'
      summary: Apache Flink List Jobs Resource-Requirements
      tags:
      - Jobs
    put:
      description: Request to update job's resource requirements.
      operationId: updateJobResourceRequirements
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JobResourceRequirementsBody'
      responses:
        '200':
          description: The request was successful.
      summary: Apache Flink Update Jobs Resource-Requirements
      tags:
      - Jobs
  /jobs/{jobid}/savepoints:
    post:
      description: Triggers a savepoint, and optionally cancels the job afterwards. This async operation would return a 'triggerid' for further query identifier.
      operationId: triggerSavepoint
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SavepointTriggerRequestBody'
      responses:
        '202':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TriggerResponse'
      summary: Apache Flink Create Jobs Savepoints
      tags:
      - Jobs
  /jobs/{jobid}/savepoints/{triggerid}:
    get:
      description: Returns the status of a savepoint operation.
      operationId: getSavepointStatus
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      - name: triggerid
        in: path
        description: 32-character hexadecimal string that identifies an asynchronous operation trigger ID. The ID was returned then the operation was triggered.
        required: true
        schema:
          $ref: '#/components/schemas/TriggerId'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsynchronousOperationResult'
      summary: Apache Flink Get Jobs Savepoints
      tags:
      - Jobs
  /jobs/{jobid}/status:
    get:
      description: Returns the current status of a job execution.
      operationId: getJobStatusInfo
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobStatusInfo'
      summary: Apache Flink List Jobs Status
      tags:
      - Jobs
  /jobs/{jobid}/stop:
    post:
      description: Stops a job with a savepoint. Optionally, it can also emit a MAX_WATERMARK before taking the savepoint to flush out any state waiting for timers to fire. This async operation would return a 'triggerid' for further query identifier.
      operationId: triggerStopWithSavepoint
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StopWithSavepointRequestBody'
      responses:
        '202':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TriggerResponse'
      summary: Apache Flink Create Jobs Stop
      tags:
      - Jobs
  /jobs/{jobid}/taskmanagers/{taskmanagerid}/log-url:
    get:
      description: Returns the log url of jobmanager of a specific job.
      operationId: getTaskManagerLogUrl
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      - name: taskmanagerid
        in: path
        description: 32-character hexadecimal string that identifies a task manager.
        required: true
        schema:
          $ref: '#/components/schemas/ResourceID'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogUrlResponse'
      summary: Apache Flink List Taskmanagers Log-Url
      tags:
      - Jobs
  /jobs/{jobid}/vertices/{vertexid}:
    get:
      description: Returns details for a task, with a summary for each of its subtasks.
      operationId: getJobVertexDetails
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      - name: vertexid
        in: path
        description: 32-character hexadecimal string value that identifies a job vertex.
        required: true
        schema:
          $ref: '#/components/schemas/JobVertexID'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobVertexDetailsInfo'
      summary: Apache Flink Get Jobs Vertices
      tags:
      - Jobs
  /jobs/{jobid}/vertices/{vertexid}/accumulators:
    get:
      description: Returns user-defined accumulators of a task, aggregated across all subtasks.
      operationId: getJobVertexAccumulators
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      - name: vertexid
        in: path
        description: 32-character hexadecimal string value that identifies a job vertex.
        required: true
        schema:
          $ref: '#/components/schemas/JobVertexID'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobVertexAccumulatorsInfo'
      summary: Apache Flink List Vertices Accumulators
      tags:
      - Jobs
  /jobs/{jobid}/vertices/{vertexid}/backpressure:
    get:
      description: Returns back-pressure information for a job, and may initiate back-pressure sampling if necessary.
      operationId: getJobVertexBackPressure
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      - name: vertexid
        in: path
        description: 32-character hexadecimal string value that identifies a job vertex.
        required: true
        schema:
          $ref: '#/components/schemas/JobVertexID'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobVertexBackPressureInfo'
      summary: Apache Flink List Vertices Backpressure
      tags:
      - Jobs
  /jobs/{jobid}/vertices/{vertexid}/flamegraph:
    get:
      description: Returns flame graph information for a vertex, and may initiate flame graph sampling if necessary.
      operationId: getJobVertexFlameGraph
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      - name: vertexid
        in: path
        description: 32-character hexadecimal string value that identifies a job vertex.
        required: true
        schema:
          $ref: '#/components/schemas/JobVertexID'
      - name: type
        in: query
        description: 'String value that specifies the Flame Graph type. Supported options are: "[FULL, ON_CPU, OFF_CPU]".'
        required: false
        style: form
        schema:
          $ref: '#/components/schemas/ThreadStates'
      - name: subtaskindex
        in: query
        description: Positive integer value that identifies a subtask.
        required: false
        style: form
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VertexFlameGraph'
      summary: Apache Flink List Vertices Flamegraph
      tags:
      - Jobs
  /jobs/{jobid}/vertices/{vertexid}/jm-operator-metrics:
    get:
      description: Provides access to jobmanager operator metrics. This is an operator that executes on the jobmanager and the coordinator for FLIP 27 sources is one example of such an operator.
      operationId: getJobManagerOperatorMetrics
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      - name: vertexid
        in: path
        description: 32-character hexadecimal string value that identifies a job vertex.
        required: true
        schema:
          $ref: '#/components/schemas/JobVertexID'
      - name: get
        in: query
        description: Comma-separated list of string values to select specific metrics.
        required: false
        style: form
        schema:
          type: string
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricCollectionResponseBody'
      summary: Apache Flink List Vertices Jm-Operator-Metrics
      tags:
      - Jobs
  /jobs/{jobid}/vertices/{vertexid}/metrics:
    get:
      description: Provides access to task metrics.
      operationId: getJobVertexMetrics
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      - name: vertexid
        in: path
        description: 32-character hexadecimal string value that identifies a job vertex.
        required: true
        schema:
          $ref: '#/components/schemas/JobVertexID'
      - name: get
        in: query
        description: Comma-separated list of string values to select specific metrics.
        required: false
        style: form
        schema:
          type: string
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricCollectionResponseBody'
      summary: Apache Flink List Vertices Metrics
      tags:
      - Jobs
  /jobs/{jobid}/vertices/{vertexid}/subtasks/accumulators:
    get:
      description: Returns all user-defined accumulators for all subtasks of a task.
      operationId: getSubtasksAllAccumulators
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string value that identifies a job.
        required: true
        schema:
          $ref: '#/components/schemas/JobID'
      - name: vertexid
        in: path
        description: 32-character hexadecimal string value that identifies a job vertex.
        required: true
        schema:
          $ref: '#/components/schemas/JobVertexID'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubtasksAllAccumulatorsInfo'
      summary: Apache Flink List Subtasks Accumulators
      tags:
      - Jobs
  /jobs/{jobid}/vertices/{vertexid}/subtasks/metrics:
    get:
      description: Provides access to aggregated subtask metrics.
      operationId: getAggregatedSubtaskMetrics
      parameters:
      - name: jobid
        in: path
        description: 32-character hexadecimal string valu

# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/apache-flink/refs/heads/main/openapi/apache-flink-jobs-api-openapi.yml