Apache Flink

Apache Flink Overview API

The Overview API from Apache Flink — 1 operation(s) for overview.

GitHub OpenAPI

Documentation

📖
Documentation
https://nightlies.apache.org/flink/flink-docs-stable/docs/ops/rest_api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/apache-flink/refs/heads/main/openapi/apache-flink-overview-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/apache-flink/refs/heads/main/json-schema/flink-rest-job-details-info-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/apache-flink/refs/heads/main/json-ld/apache-flink-rest-context.jsonld

OpenAPI Specification

apache-flink-overview-api-openapi.yml Raw ↑ 
openapi: 3.0.1
info:
  title: Flink JobManager REST Cluster Overview 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: Overview
paths:
  /overview:
    get:
      description: Returns an overview over the Flink cluster.
      operationId: getClusterOverview
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterOverviewWithVersion'
      summary: Apache Flink List Overview
      tags:
      - Overview
components:
  schemas:
    ClusterOverviewWithVersion:
      type: object
      properties:
        flink-commit:
          type: string
        flink-version:
          type: string
        jobs-cancelled:
          type: integer
          format: int32
        jobs-failed:
          type: integer
          format: int32
        jobs-finished:
          type: integer
          format: int32
        jobs-running:
          type: integer
          format: int32
        slots-available:
          type: integer
          format: int32
        slots-free-and-blocked:
          type: integer
          format: int32
        slots-total:
          type: integer
          format: int32
        taskmanagers:
          type: integer
          format: int32
        taskmanagers-blocked:
          type: integer
          format: int32