/cluster
Verb: DELETE Response code: 200 OK
Shuts down the cluster
            
{}            
          
            
{}            
          
/config
Verb: GET Response code: 200 OK
Returns the configuration of the WebUI.
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:DashboardConfiguration",
  "properties" : {
    "refresh-interval" : {
      "type" : "integer"
    },
    "timezone-name" : {
      "type" : "string"
    },
    "timezone-offset" : {
      "type" : "integer"
    },
    "flink-version" : {
      "type" : "string"
    },
    "flink-revision" : {
      "type" : "string"
    }
  }
}            
          
/jars
Verb: GET Response code: 200 OK
Returns a list of all jars previously uploaded via '/jars/upload'.
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarListInfo",
  "properties" : {
    "address" : {
      "type" : "string"
    },
    "files" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarListInfo:JarFileInfo",
        "properties" : {
          "id" : {
            "type" : "string"
          },
          "name" : {
            "type" : "string"
          },
          "uploaded" : {
            "type" : "integer"
          },
          "entry" : {
            "type" : "array",
            "items" : {
              "type" : "object",
              "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarListInfo:JarEntryInfo",
              "properties" : {
                "name" : {
                  "type" : "string"
                },
                "description" : {
                  "type" : "string"
                }
              }
            }
          }
        }
      }
    }
  }
}            
          
/jars/upload
Verb: POST Response code: 200 OK
Uploads a jar to the cluster. The jar must be sent as multi-part data. Make sure that the "Content-Type" header is set to "application/x-java-archive", as some http libraries do not add the header by default. Using 'curl' you can upload a jar via 'curl -X POST -H "Expect:" -F "jarfile=#path/to/flink-job.jar" http://hostname:port/jars/upload'.
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarUploadResponseBody",
  "properties" : {
    "filename" : {
      "type" : "string"
    },
    "status" : {
      "type" : "string",
      "enum" : [ "success" ]
    }
  }
}            
          
/jars/:jarid
Verb: DELETE Response code: 200 OK
Deletes a jar previously uploaded via '/jars/upload'.
Path parameters
  • jarid - description
            
{}            
          
            
{}            
          
/jars/:jarid/plan
Verb: GET Response code: 200 OK
Returns the dataflow plan of a job contained in a jar previously uploaded via '/jars/upload'.
Path parameters
  • jarid - description
Query parameters
  • entry-class (optional): description
  • parallelism (optional): description
  • program-args (optional): description
            
{}            
          
            
{
  "type" : "any"
}            
          
/jars/:jarid/run
Verb: POST Response code: 200 OK
Submits a job by running a jar previously uploaded via '/jars/upload'.
Path parameters
  • jarid - description
Query parameters
  • program-args (optional): description
  • entry-class (optional): description
  • parallelism (optional): description
  • allowNonRestoredState (optional): description
  • savepointPath (optional): description
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarRunRequestBody",
  "properties" : {
    "entryClass" : {
      "type" : "string"
    },
    "programArgs" : {
      "type" : "string"
    },
    "parallelism" : {
      "type" : "integer"
    },
    "allowNonRestoredState" : {
      "type" : "boolean"
    },
    "savepointPath" : {
      "type" : "string"
    }
  }
}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarRunResponseBody",
  "properties" : {
    "jobid" : {
      "type" : "any"
    }
  }
}            
          
/jobmanager/config
Verb: GET Response code: 200 OK
Returns the cluster configuration.
            
{}            
          
            
{
  "type" : "array",
  "items" : {
    "type" : "object",
    "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:ClusterConfigurationInfoEntry",
    "properties" : {
      "key" : {
        "type" : "string"
      },
      "value" : {
        "type" : "string"
      }
    }
  }
}            
          
/jobmanager/metrics
Verb: GET Response code: 200 OK
Provides access to job manager metrics.
Query parameters
  • get (optional): description
            
{}            
          
            
{
  "type" : "any"
}            
          
/jobs
Verb: GET Response code: 200 OK
Returns an overview over all jobs and their current state.
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:messages:webmonitor:JobIdsWithStatusOverview",
  "properties" : {
    "jobs" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "id" : "urn:jsonschema:org:apache:flink:runtime:messages:webmonitor:JobIdsWithStatusOverview:JobIdWithStatus",
        "properties" : {
          "id" : {
            "type" : "any"
          },
          "status" : {
            "type" : "string",
            "enum" : [ "CREATED", "RUNNING", "FAILING", "FAILED", "CANCELLING", "CANCELED", "FINISHED", "RESTARTING", "SUSPENDING", "SUSPENDED", "RECONCILING" ]
          }
        }
      }
    }
  }
}            
          
/jobs
Verb: POST Response code: 202 Accepted
Submits a job. This call is primarily intended to be used by the Flink client. This call expects amultipart/form-data request that consists of file uploads for the serialized JobGraph, jars anddistributed cache artifacts and an attribute named "request"for the JSON payload.
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobSubmitRequestBody",
  "properties" : {
    "jobGraphFileName" : {
      "type" : "string"
    },
    "jobJarFileNames" : {
      "type" : "array",
      "items" : {
        "type" : "string"
      }
    }
  }
}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobSubmitResponseBody",
  "properties" : {
    "jobUrl" : {
      "type" : "string"
    }
  }
}            
          
/jobs/metrics
Verb: GET Response code: 200 OK
Provides access to aggregated job metrics.
Query parameters
  • get (optional): description
  • agg (optional): description
  • jobs (optional): description
            
{}            
          
            
{
  "type" : "any"
}            
          
/jobs/overview
Verb: GET Response code: 200 OK
Returns an overview over all jobs.
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:messages:webmonitor:MultipleJobsDetails",
  "properties" : {
    "jobs" : {
      "type" : "array",
      "items" : {
        "type" : "any"
      }
    }
  }
}            
          
/jobs/:jobid
Verb: GET Response code: 200 OK
Returns details of a job.
Path parameters
  • jobid - description
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobDetailsInfo",
  "properties" : {
    "jid" : {
      "type" : "any"
    },
    "name" : {
      "type" : "string"
    },
    "isStoppable" : {
      "type" : "boolean"
    },
    "state" : {
      "type" : "string",
      "enum" : [ "CREATED", "RUNNING", "FAILING", "FAILED", "CANCELLING", "CANCELED", "FINISHED", "RESTARTING", "SUSPENDING", "SUSPENDED", "RECONCILING" ]
    },
    "start-time" : {
      "type" : "integer"
    },
    "end-time" : {
      "type" : "integer"
    },
    "duration" : {
      "type" : "integer"
    },
    "now" : {
      "type" : "integer"
    },
    "timestamps" : {
      "type" : "object",
      "additionalProperties" : {
        "type" : "integer"
      }
    },
    "vertices" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobDetailsInfo:JobVertexDetailsInfo",
        "properties" : {
          "id" : {
            "type" : "any"
          },
          "name" : {
            "type" : "string"
          },
          "parallelism" : {
            "type" : "integer"
          },
          "status" : {
            "type" : "string",
            "enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING" ]
          },
          "start-time" : {
            "type" : "integer"
          },
          "end-time" : {
            "type" : "integer"
          },
          "duration" : {
            "type" : "integer"
          },
          "tasks" : {
            "type" : "object",
            "additionalProperties" : {
              "type" : "integer"
            }
          },
          "metrics" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:IOMetricsInfo",
            "properties" : {
              "read-bytes" : {
                "type" : "integer"
              },
              "read-bytes-complete" : {
                "type" : "boolean"
              },
              "write-bytes" : {
                "type" : "integer"
              },
              "write-bytes-complete" : {
                "type" : "boolean"
              },
              "read-records" : {
                "type" : "integer"
              },
              "read-records-complete" : {
                "type" : "boolean"
              },
              "write-records" : {
                "type" : "integer"
              },
              "write-records-complete" : {
                "type" : "boolean"
              },
              "buffers-in-pool-usage-max" : {
                "type" : "float"
              },
              "buffers-in-pool-usage-max-complete" : {
                "type" : "boolean"
              },
              "buffers-out-pool-usage-max" : {
                "type" : "float"
              },
              "buffers-out-pool-usage-max-complete" : {
                "type" : "boolean"
              },
              "tps" : {
                "type" : "float"
              },
              "tps-complete" : {
                "type" : "boolean"
              },
              "delay" : {
                "type" : "long"
              },
              "delay-complete" : {
                "type" : "boolean"
            }
          }
        }
      }
    },
    "status-counts" : {
      "type" : "object",
      "additionalProperties" : {
        "type" : "integer"
      }
    },
    "plan" : {
      "type" : "string"
    }
  }
}            
          
/jobs/:jobid
Verb: PATCH Response code: 202 Accepted
Terminates a job.
Path parameters
  • jobid - description
Query parameters
  • mode (optional): description
            
{}            
          
            
{}            
          
/jobs/:jobid/accumulators
Verb: GET Response code: 200 OK
Returns the accumulators for all tasks of a job, aggregated across the respective subtasks.
Path parameters
  • jobid - description
Query parameters
  • includeSerializedValue (optional): description
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobAccumulatorsInfo",
  "properties" : {
    "job-accumulators" : {
      "type" : "array",
      "items" : {
        "type" : "any"
      }
    },
    "user-task-accumulators" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobAccumulatorsInfo:UserTaskAccumulator",
        "properties" : {
          "name" : {
            "type" : "string"
          },
          "type" : {
            "type" : "string"
          },
          "value" : {
            "type" : "string"
          }
        }
      }
    },
    "serialized-user-task-accumulators" : {
      "type" : "object",
      "additionalProperties" : {
        "type" : "any"
      }
    }
  }
}            
          
/jobs/:jobid/checkpoints
Verb: GET Response code: 200 OK
Returns checkpointing statistics for a job.
Path parameters
  • jobid - description
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics",
  "properties" : {
    "counts" : {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics:Counts",
      "properties" : {
        "restored" : {
          "type" : "integer"
        },
        "total" : {
          "type" : "integer"
        },
        "in_progress" : {
          "type" : "integer"
        },
        "completed" : {
          "type" : "integer"
        },
        "failed" : {
          "type" : "integer"
        }
      }
    },
    "summary" : {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics:Summary",
      "properties" : {
        "state_size" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics",
          "properties" : {
            "min" : {
              "type" : "integer"
            },
            "max" : {
              "type" : "integer"
            },
            "avg" : {
              "type" : "integer"
            }
          }
        },
        "end_to_end_duration" : {
          "type" : "object",
          "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics"
        },
        "alignment_buffered" : {
          "type" : "object",
          "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics"
        }
      }
    },
    "latest" : {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics:LatestCheckpoints",
      "properties" : {
        "completed" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics:CompletedCheckpointStatistics",
          "properties" : {
            "id" : {
              "type" : "integer"
            },
            "status" : {
              "type" : "string",
              "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
            },
            "is_savepoint" : {
              "type" : "boolean"
            },
            "trigger_timestamp" : {
              "type" : "integer"
            },
            "latest_ack_timestamp" : {
              "type" : "integer"
            },
            "state_size" : {
              "type" : "integer"
            },
            "end_to_end_duration" : {
              "type" : "integer"
            },
            "alignment_buffered" : {
              "type" : "integer"
            },
            "num_subtasks" : {
              "type" : "integer"
            },
            "num_acknowledged_subtasks" : {
              "type" : "integer"
            },
            "tasks" : {
              "type" : "object",
              "additionalProperties" : {
                "type" : "object",
                "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatistics",
                "properties" : {
                  "id" : {
                    "type" : "integer"
                  },
                  "status" : {
                    "type" : "string",
                    "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
                  },
                  "latest_ack_timestamp" : {
                    "type" : "integer"
                  },
                  "state_size" : {
                    "type" : "integer"
                  },
                  "end_to_end_duration" : {
                    "type" : "integer"
                  },
                  "alignment_buffered" : {
                    "type" : "integer"
                  },
                  "num_subtasks" : {
                    "type" : "integer"
                  },
                  "num_acknowledged_subtasks" : {
                    "type" : "integer"
                  }
                }
              }
            },
            "external_path" : {
              "type" : "string"
            },
            "discarded" : {
              "type" : "boolean"
            }
          }
        },
        "savepoint" : {
          "type" : "object",
          "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics:CompletedCheckpointStatistics"
        },
        "failed" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics:FailedCheckpointStatistics",
          "properties" : {
            "id" : {
              "type" : "integer"
            },
            "status" : {
              "type" : "string",
              "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
            },
            "is_savepoint" : {
              "type" : "boolean"
            },
            "trigger_timestamp" : {
              "type" : "integer"
            },
            "latest_ack_timestamp" : {
              "type" : "integer"
            },
            "state_size" : {
              "type" : "integer"
            },
            "end_to_end_duration" : {
              "type" : "integer"
            },
            "alignment_buffered" : {
              "type" : "integer"
            },
            "num_subtasks" : {
              "type" : "integer"
            },
            "num_acknowledged_subtasks" : {
              "type" : "integer"
            },
            "tasks" : {
              "type" : "object",
              "additionalProperties" : {
                "type" : "object",
                "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatistics"
              }
            },
            "failure_timestamp" : {
              "type" : "integer"
            },
            "failure_message" : {
              "type" : "string"
            }
          }
        },
        "restored" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics:RestoredCheckpointStatistics",
          "properties" : {
            "id" : {
              "type" : "integer"
            },
            "restore_timestamp" : {
              "type" : "integer"
            },
            "is_savepoint" : {
              "type" : "boolean"
            },
            "external_path" : {
              "type" : "string"
            }
          }
        }
      }
    },
    "history" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics",
        "properties" : {
          "id" : {
            "type" : "integer"
          },
          "status" : {
            "type" : "string",
            "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
          },
          "is_savepoint" : {
            "type" : "boolean"
          },
          "trigger_timestamp" : {
            "type" : "integer"
          },
          "latest_ack_timestamp" : {
            "type" : "integer"
          },
          "state_size" : {
            "type" : "integer"
          },
          "end_to_end_duration" : {
            "type" : "integer"
          },
          "alignment_buffered" : {
            "type" : "integer"
          },
          "num_subtasks" : {
            "type" : "integer"
          },
          "num_acknowledged_subtasks" : {
            "type" : "integer"
          },
          "tasks" : {
            "type" : "object",
            "additionalProperties" : {
              "type" : "object",
              "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatistics"
            }
          }
        }
      }
    }
  }
}            
          
/jobs/:jobid/checkpoints/config
Verb: GET Response code: 200 OK
Returns the checkpointing configuration.
Path parameters
  • jobid - description
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointConfigInfo",
  "properties" : {
    "mode" : {
      "type" : "any"
    },
    "interval" : {
      "type" : "integer"
    },
    "timeout" : {
      "type" : "integer"
    },
    "min_pause" : {
      "type" : "integer"
    },
    "max_concurrent" : {
      "type" : "integer"
    },
    "externalization" : {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointConfigInfo:ExternalizedCheckpointInfo",
      "properties" : {
        "enabled" : {
          "type" : "boolean"
        },
        "delete_on_cancellation" : {
          "type" : "boolean"
        }
      }
    }
  }
}            
          
/jobs/:jobid/checkpoints/details/:checkpointid
Verb: GET Response code: 200 OK
Returns details for a checkpoint.
Path parameters
  • jobid - description
  • checkpointid - description
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics",
  "properties" : {
    "id" : {
      "type" : "integer"
    },
    "status" : {
      "type" : "string",
      "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
    },
    "is_savepoint" : {
      "type" : "boolean"
    },
    "trigger_timestamp" : {
      "type" : "integer"
    },
    "latest_ack_timestamp" : {
      "type" : "integer"
    },
    "state_size" : {
      "type" : "integer"
    },
    "end_to_end_duration" : {
      "type" : "integer"
    },
    "alignment_buffered" : {
      "type" : "integer"
    },
    "num_subtasks" : {
      "type" : "integer"
    },
    "num_acknowledged_subtasks" : {
      "type" : "integer"
    },
    "tasks" : {
      "type" : "object",
      "additionalProperties" : {
        "type" : "object",
        "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatistics",
        "properties" : {
          "id" : {
            "type" : "integer"
          },
          "status" : {
            "type" : "string",
            "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
          },
          "latest_ack_timestamp" : {
            "type" : "integer"
          },
          "state_size" : {
            "type" : "integer"
          },
          "end_to_end_duration" : {
            "type" : "integer"
          },
          "alignment_buffered" : {
            "type" : "integer"
          },
          "num_subtasks" : {
            "type" : "integer"
          },
          "num_acknowledged_subtasks" : {
            "type" : "integer"
          }
        }
      }
    }
  }
}            
          
/jobs/:jobid/checkpoints/details/:checkpointid/subtasks/:vertexid
Verb: GET Response code: 200 OK
Returns checkpoint statistics for a task and its subtasks.
Path parameters
  • jobid - description
  • checkpointid - description
  • vertexid - description
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatisticsWithSubtaskDetails",
  "properties" : {
    "id" : {
      "type" : "integer"
    },
    "status" : {
      "type" : "string",
      "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
    },
    "latest_ack_timestamp" : {
      "type" : "integer"
    },
    "state_size" : {
      "type" : "integer"
    },
    "end_to_end_duration" : {
      "type" : "integer"
    },
    "alignment_buffered" : {
      "type" : "integer"
    },
    "num_subtasks" : {
      "type" : "integer"
    },
    "num_acknowledged_subtasks" : {
      "type" : "integer"
    },
    "summary" : {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatisticsWithSubtaskDetails:Summary",
      "properties" : {
        "state_size" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics",
          "properties" : {
            "min" : {
              "type" : "integer"
            },
            "max" : {
              "type" : "integer"
            },
            "avg" : {
              "type" : "integer"
            }
          }
        },
        "end_to_end_duration" : {
          "type" : "object",
          "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics"
        },
        "checkpoint_duration" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatisticsWithSubtaskDetails:CheckpointDuration",
          "properties" : {
            "sync" : {
              "type" : "object",
              "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics"
            },
            "async" : {
              "type" : "object",
              "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics"
            }
          }
        },
        "alignment" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatisticsWithSubtaskDetails:CheckpointAlignment",
          "properties" : {
            "buffered" : {
              "type" : "object",
              "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics"
            },
            "duration" : {
              "type" : "object",
              "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics"
            }
          }
        }
      }
    },
    "subtasks" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:SubtaskCheckpointStatistics",
        "properties" : {
          "index" : {
            "type" : "integer"
          },
          "status" : {
            "type" : "string"
          }
        }
      }
    }
  }
}            
          
/jobs/:jobid/config
Verb: GET Response code: 200 OK
Returns the configuration of a job.
Path parameters
  • jobid - description
            
{}            
          
            
{
  "type" : "any"
}            
          
/jobs/:jobid/exceptions
Verb: GET Response code: 200 OK
Returns the non-recoverable exceptions that have been observed by the job. The truncated flag defines whether more exceptions occurred, but are not listed, because the response would otherwise get too big.
Path parameters
  • jobid - description
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobExceptionsInfo",
  "properties" : {
    "root-exception" : {
      "type" : "string"
    },
    "timestamp" : {
      "type" : "integer"
    },
    "all-exceptions" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobExceptionsInfo:ExecutionExceptionInfo",
        "properties" : {
          "exception" : {
            "type" : "string"
          },
          "task" : {
            "type" : "string"
          },
          "location" : {
            "type" : "string"
          },
          "timestamp" : {
            "type" : "integer"
          }
        }
      }
    },
    "truncated" : {
      "type" : "boolean"
    }
  }
}            
          
/jobs/:jobid/execution-result
Verb: GET Response code: 200 OK
Returns the result of a job execution. Gives access to the execution time of the job and to all accumulators created by this job.
Path parameters
  • jobid - description
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobExecutionResultResponseBody",
  "properties" : {
    "status" : {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:queue:QueueStatus",
      "required" : true,
      "properties" : {
        "id" : {
          "type" : "string",
          "required" : true,
          "enum" : [ "IN_PROGRESS", "COMPLETED" ]
        }
      }
    },
    "job-execution-result" : {
      "type" : "any"
    }
  }
}            
          
/jobs/:jobid/metrics
Verb: GET Response code: 200 OK
Provides access to job metrics.
Path parameters
  • jobid - description
Query parameters
  • get (optional): description
            
{}            
          
            
{
  "type" : "any"
}            
          
/jobs/:jobid/plan
Verb: GET Response code: 200 OK
Returns the dataflow plan of a job.
Path parameters
  • jobid - description
            
{}            
          
            
{
  "type" : "any"
}            
          
/jobs/:jobid/vertices/details
Verb: GET Response code: 200 OK
Returns the detail contains vertices and operators of a job.
Path parameters
  • jobid - description
            
{}
            
          
            
{
    "type" : "object",
    "id" : "urn:jsonschema:org:apache:flink:runtime:messages:webmonitor:JobVerticesInfo",
    "properties" : {
      "vertices" : {
        "type" : "array",
        "items" : {
          "type" : "any"
        }
      },
      "operators" : {
        "type" : "array",
        "items" : {
          "type" : "any"
        }
      }
    }
}
            
          
/jobs/:jobid/taskmanagers
Verb: GET Response code: 200 OK
Returns an overview over all registered TaskManagers of a job.
Path parameters
  • jobid - description
            
{}
            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagersInfo",
  "properties" : {
    "taskmanagers" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerInfo",
        "properties" : {
          "id" : {
            "type" : "any"
          },
          "path" : {
            "type" : "string"
          },
          "dataPort" : {
            "type" : "integer"
          },
          "timeSinceLastHeartbeat" : {
            "type" : "integer"
          },
          "slotsNumber" : {
            "type" : "integer"
          },
          "freeSlots" : {
            "type" : "integer"
          },
          "hardware" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:instance:HardwareDescription",
            "properties" : {
              "cpuCores" : {
                "type" : "integer"
              },
              "physicalMemory" : {
                "type" : "integer"
              },
              "freeMemory" : {
                "type" : "integer"
              },
              "managedMemory" : {
                "type" : "integer"
              }
            }
          }
        }
      }
    }
  }
}
            
          
/jobs/:jobid/rescaling
Verb: PATCH Response code: 200 OK
Triggers the rescaling of a job.
Path parameters
  • jobid - description
Query parameters
  • parallelism (mandatory): description
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:TriggerResponse",
  "properties" : {
    "request-id" : {
      "type" : "any"
    }
  }
}            
          
/jobs/:jobid/pendingslotrequest
Verb: GET Response code: 200 OK
Returns pending slot resuests for a job.
Path parameters
  • jobid - description
            
{}
            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobPendingSlotRequestsInfo",
  "properties" : {
    "taskmanagers" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobPendingSlotRequestDetail",
        "properties" : {
          "id" : {
            "type" : "any"
          },
          "resource_profile" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:clusterframework:types:ResourceProfile",
            "properties" : {
              "cpuCores" : {
                "type" : "double"
              },
              "heapMemoryInMB" : {
                "type" : "integer"
              },
              "directMemoryInMB" : {
                "type" : "integer"
              },
              "nativeMemoryInMB" : {
                "type" : "integer"
              },
              "networkMemoryInMB" : {
                "type" : "integer"
              },
              "extendedResources" : {
                "type" : "any"
              }
            }
          },
          "sharing_id" : {
            "type" : "any"
          },
          "co-location_id" : {
            "type" : "any"
          },
          "tasks" : {
           "type" : "array",
            "items" : {
              "type" : "object",
              "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobPendingSlotRequestDetail:VertexTaskInfo",
              "properties" : {
                "vertex_id" : {
                  "type" : "any"
                },
                "task_name" : {
                  "type" : "string"
                },
                "subtask" : {
                  "type" : "integer"
                },
                "attempt" : {
                  "type" : "integer"
                }
              }
            }
          }
          "start_time" : {
            "type" : "integer"
          }
        }
      }
    }
  }
}
            
          
/jobs/:jobid/rescaling/:triggerid
Verb: GET Response code: 200 OK
Returns the status of a rescaling operation.
Path parameters
  • jobid - description
  • triggerid - description
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:AsynchronousOperationResult",
  "properties" : {
    "status" : {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:queue:QueueStatus",
      "properties" : {
        "id" : {
          "type" : "string",
          "required" : true,
          "enum" : [ "IN_PROGRESS", "COMPLETED" ]
        }
      }
    },
    "operation" : {
      "type" : "any"
    }
  }
}            
          
/jobs/:jobid/savepoints
Verb: POST Response code: 202 Accepted
Triggers a savepoint, and optionally cancels the job afterwards.
Path parameters
  • jobid - description
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:savepoints:SavepointTriggerRequestBody",
  "properties" : {
    "target-directory" : {
      "type" : "string"
    },
    "cancel-job" : {
      "type" : "boolean"
    }
  }
}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:TriggerResponse",
  "properties" : {
    "request-id" : {
      "type" : "any"
    }
  }
}            
          
/jobs/:jobid/savepoints/:triggerid
Verb: GET Response code: 200 OK
Returns the status of a savepoint operation.
Path parameters
  • jobid - description
  • triggerid - description
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:AsynchronousOperationResult",
  "properties" : {
    "status" : {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:queue:QueueStatus",
      "properties" : {
        "id" : {
          "type" : "string",
          "required" : true,
          "enum" : [ "IN_PROGRESS", "COMPLETED" ]
        }
      }
    },
    "operation" : {
      "type" : "any"
    }
  }
}            
          
/jobs/:jobid/vertices/:vertexid
Verb: GET Response code: 200 OK
Returns details for a task, with a summary for each of its subtasks.
Path parameters
  • jobid - description
  • vertexid - description
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexDetailsInfo",
  "properties" : {
    "id" : {
      "type" : "any"
    },
    "name" : {
      "type" : "string"
    },
    "parallelism" : {
      "type" : "integer"
    },
    "now" : {
      "type" : "integer"
    },
    "subtasks" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexDetailsInfo:VertexTaskDetail",
        "properties" : {
          "subtask" : {
            "type" : "integer"
          },
          "status" : {
            "type" : "string",
            "enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING" ]
          },
          "attempt" : {
            "type" : "integer"
          },
          "host" : {
            "type" : "string"
          },
          "start_time" : {
            "type" : "integer"
          },
          "end-time" : {
            "type" : "integer"
          },
          "duration" : {
            "type" : "integer"
          },
          "log-file-name" : {
            "type" : "string"
          },
          "stdout-file-name" : {
            "type" : "string"
          },
          "metrics" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:IOMetricsInfo",
            "properties" : {
              "read-bytes" : {
                "type" : "integer"
              },
              "read-bytes-complete" : {
                "type" : "boolean"
              },
              "write-bytes" : {
                "type" : "integer"
              },
              "write-bytes-complete" : {
                "type" : "boolean"
              },
              "read-records" : {
                "type" : "integer"
              },
              "read-records-complete" : {
                "type" : "boolean"
              },
              "write-records" : {
                "type" : "integer"
              },
              "write-records-complete" : {
                "type" : "boolean"
              },
              "buffers-in-pool-usage-max" : {
                "type" : "float"
              },
              "buffers-in-pool-usage-max-complete" : {
                "type" : "boolean"
              },
              "buffers-out-pool-usage-max" : {
                "type" : "float"
              },
              "buffers-out-pool-usage-max-complete" : {
                "type" : "boolean"
              },
              "tps" : {
                "type" : "float"
              },
              "tps-complete" : {
                "type" : "boolean"
              },
              "delay" : {
                "type" : "long"
              },
              "delay-complete" : {
                "type" : "boolean"
              }
            }
          }
        }
      }
    }
  }
}            
          
/jobs/:jobid/vertices/:vertexid/accumulators
Verb: GET Response code: 200 OK
Returns user-defined accumulators of a task, aggregated across all subtasks.
Path parameters
  • jobid - description
  • vertexid - description
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexAccumulatorsInfo",
  "properties" : {
    "id" : {
      "type" : "string"
    },
    "user-accumulators" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:UserAccumulator",
        "properties" : {
          "name" : {
            "type" : "string"
          },
          "type" : {
            "type" : "string"
          },
          "value" : {
            "type" : "string"
          }
        }
      }
    }
  }
}            
          
/jobs/:jobid/vertices/:vertexid/backpressure
Verb: GET Response code: 200 OK
Returns back-pressure information for a job, and may initiate back-pressure sampling if necessary.
Path parameters
  • jobid - description
  • vertexid - description
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexBackPressureInfo",
  "properties" : {
    "status" : {
      "type" : "string",
      "enum" : [ "deprecated", "ok" ]
    },
    "backpressure-level" : {
      "type" : "string",
      "enum" : [ "ok", "low", "high" ]
    },
    "end-timestamp" : {
      "type" : "integer"
    },
    "subtasks" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexBackPressureInfo:SubtaskBackPressureInfo",
        "properties" : {
          "subtask" : {
            "type" : "integer"
          },
          "backpressure-level" : {
            "type" : "string",
            "enum" : [ "ok", "low", "high" ]
          },
          "ratio" : {
            "type" : "number"
          }
        }
      }
    }
  }
}            
          
/jobs/:jobid/vertices/:vertexid/metrics
Verb: GET Response code: 200 OK
Provides access to task metrics.
Path parameters
  • jobid - description
  • vertexid - description
Query parameters
  • get (optional): description
            
{}            
          
            
{
  "type" : "any"
}            
          
/jobs/:jobid/vertices/:vertexid/subtasks/accumulators
Verb: GET Response code: 200 OK
Returns all user-defined accumulators for all subtasks of a task.
Path parameters
  • jobid - description
  • vertexid - description
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtasksAllAccumulatorsInfo",
  "properties" : {
    "id" : {
      "type" : "any"
    },
    "parallelism" : {
      "type" : "integer"
    },
    "subtasks" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtasksAllAccumulatorsInfo:SubtaskAccumulatorsInfo",
        "properties" : {
          "subtask" : {
            "type" : "integer"
          },
          "attempt" : {
            "type" : "integer"
          },
          "host" : {
            "type" : "string"
          },
          "user-accumulators" : {
            "type" : "array",
            "items" : {
              "type" : "object",
              "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:UserAccumulator",
              "properties" : {
                "name" : {
                  "type" : "string"
                },
                "type" : {
                  "type" : "string"
                },
                "value" : {
                  "type" : "string"
                }
              }
            }
          }
        }
      }
    }
  }
}            
          
/jobs/:jobid/vertices/:vertexid/subtasks/metrics
Verb: GET Response code: 200 OK
Provides access to aggregated subtask metrics.
Path parameters
  • jobid - description
  • vertexid - description
Query parameters
  • get (optional): description
  • agg (optional): description
  • subtasks (optional): description
            
{}            
          
            
{
  "type" : "any"
}            
          
/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex
Verb: GET Response code: 200 OK
Returns details of the current or latest execution attempt of a subtask.
Path parameters
  • jobid - description
  • vertexid - description
  • subtaskindex - description
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtaskExecutionAttemptDetailsInfo",
  "properties" : {
    "subtask" : {
      "type" : "integer"
    },
    "status" : {
      "type" : "string",
      "enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING" ]
    },
    "attempt" : {
      "type" : "integer"
    },
    "host" : {
      "type" : "string"
    },
    "start-time" : {
      "type" : "integer"
    },
    "end-time" : {
      "type" : "integer"
    },
    "duration" : {
      "type" : "integer"
    },
    "metrics" : {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:IOMetricsInfo",
      "properties" : {
        "read-bytes" : {
          "type" : "integer"
        },
        "read-bytes-complete" : {
          "type" : "boolean"
        },
        "write-bytes" : {
          "type" : "integer"
        },
        "write-bytes-complete" : {
          "type" : "boolean"
        },
        "read-records" : {
          "type" : "integer"
        },
        "read-records-complete" : {
          "type" : "boolean"
        },
        "write-records" : {
          "type" : "integer"
        },
        "write-records-complete" : {
          "type" : "boolean"
        },
        "buffers-in-pool-usage-max" : {
          "type" : "float"
        },
        "buffers-in-pool-usage-max-complete" : {
          "type" : "boolean"
        },
        "buffers-out-pool-usage-max" : {
          "type" : "float"
        },
        "buffers-out-pool-usage-max-complete" : {
          "type" : "boolean"
        },
        "tps" : {
          "type" : "float"
        },
        "tps-complete" : {
          "type" : "boolean"
        },
        "delay" : {
          "type" : "long"
        },
        "delay-complete" : {
          "type" : "boolean"
        }
    }
  }
}            
          
/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex/attempts/:attempt
Verb: GET Response code: 200 OK
Returns details of an execution attempt of a subtask. Multiple execution attempts happen in case of failure/recovery.
Path parameters
  • jobid - description
  • vertexid - description
  • subtaskindex - description
  • attempt - description
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtaskExecutionAttemptDetailsInfo",
  "properties" : {
    "subtask" : {
      "type" : "integer"
    },
    "status" : {
      "type" : "string",
      "enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING" ]
    },
    "attempt" : {
      "type" : "integer"
    },
    "host" : {
      "type" : "string"
    },
    "start-time" : {
      "type" : "integer"
    },
    "end-time" : {
      "type" : "integer"
    },
    "duration" : {
      "type" : "integer"
    },
    "metrics" : {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:IOMetricsInfo",
      "properties" : {
        "read-bytes" : {
          "type" : "integer"
        },
        "read-bytes-complete" : {
          "type" : "boolean"
        },
        "write-bytes" : {
          "type" : "integer"
        },
        "write-bytes-complete" : {
          "type" : "boolean"
        },
        "read-records" : {
          "type" : "integer"
        },
        "read-records-complete" : {
          "type" : "boolean"
        },
        "write-records" : {
          "type" : "integer"
        },
        "write-records-complete" : {
          "type" : "boolean"
        },
        "buffers-in-pool-usage-max" : {
          "type" : "float"
        },
        "buffers-in-pool-usage-max-complete" : {
          "type" : "boolean"
        },
        "buffers-out-pool-usage-max" : {
          "type" : "float"
        },
        "buffers-out-pool-usage-max-complete" : {
          "type" : "boolean"
        },
        "tps" : {
          "type" : "float"
        },
        "tps-complete" : {
          "type" : "boolean"
        },
        "delay" : {
          "type" : "long"
        },
        "delay-complete" : {
          "type" : "boolean"
        }
      }
    }
  }
}            
          
/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex/attempts/:attempt/accumulators
Verb: GET Response code: 200 OK
Returns the accumulators of an execution attempt of a subtask. Multiple execution attempts happen in case of failure/recovery.
Path parameters
  • jobid - description
  • vertexid - description
  • subtaskindex - description
  • attempt - description
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtaskExecutionAttemptAccumulatorsInfo",
  "properties" : {
    "subtask" : {
      "type" : "integer"
    },
    "attempt" : {
      "type" : "integer"
    },
    "id" : {
      "type" : "string"
    },
    "user-accumulators" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:UserAccumulator",
        "properties" : {
          "name" : {
            "type" : "string"
          },
          "type" : {
            "type" : "string"
          },
          "value" : {
            "type" : "string"
          }
        }
      }
    }
  }
}            
          
/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex/metrics
Verb: GET Response code: 200 OK
Provides access to subtask metrics.
Path parameters
  • jobid - description
  • vertexid - description
  • subtaskindex - description
Query parameters
  • get (optional): description
            
{}            
          
            
{
  "type" : "any"
}            
          
/jobs/:jobid/vertices/:vertexid/subtasktimes
Verb: GET Response code: 200 OK
Returns time-related information for all subtasks of a task.
Path parameters
  • jobid - description
  • vertexid - description
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:SubtasksTimesInfo",
  "properties" : {
    "id" : {
      "type" : "string"
    },
    "name" : {
      "type" : "string"
    },
    "now" : {
      "type" : "integer"
    },
    "subtasks" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:SubtasksTimesInfo:SubtaskTimeInfo",
        "properties" : {
          "subtask" : {
            "type" : "integer"
          },
          "host" : {
            "type" : "string"
          },
          "duration" : {
            "type" : "integer"
          },
          "timestamps" : {
            "type" : "object",
            "additionalProperties" : {
              "type" : "integer"
            }
          }
        }
      }
    }
  }
}            
          
/jobs/:jobid/vertices/:vertexid/taskmanagers
Verb: GET Response code: 200 OK
Returns task information aggregated by task manager.
Path parameters
  • jobid - description
  • vertexid - description
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexTaskManagersInfo",
  "properties" : {
    "id" : {
      "type" : "any"
    },
    "name" : {
      "type" : "string"
    },
    "now" : {
      "type" : "integer"
    },
    "taskmanagers" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexTaskManagersInfo:TaskManagersInfo",
        "properties" : {
          "host" : {
            "type" : "string"
          },
          "status" : {
            "type" : "string",
            "enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING" ]
          },
          "start-time" : {
            "type" : "integer"
          },
          "end-time" : {
            "type" : "integer"
          },
          "duration" : {
            "type" : "integer"
          },
          "metrics" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:IOMetricsInfo",
            "properties" : {
              "read-bytes" : {
                "type" : "integer"
              },
              "read-bytes-complete" : {
                "type" : "boolean"
              },
              "write-bytes" : {
                "type" : "integer"
              },
              "write-bytes-complete" : {
                "type" : "boolean"
              },
              "read-records" : {
                "type" : "integer"
              },
              "read-records-complete" : {
                "type" : "boolean"
              },
              "write-records" : {
                "type" : "integer"
              },
              "write-records-complete" : {
                "type" : "boolean"
              },
              "buffers-in-pool-usage-max" : {
                "type" : "float"
              },
              "buffers-in-pool-usage-max-complete" : {
                "type" : "boolean"
              },
              "buffers-out-pool-usage-max" : {
                "type" : "float"
              },
              "buffers-out-pool-usage-max-complete" : {
                "type" : "boolean"
              },
              "tps" : {
                "type" : "float"
              },
              "tps-complete" : {
                "type" : "boolean"
              },
              "delay" : {
                "type" : "long"
              },
              "delay-complete" : {
                "type" : "boolean"
              }
            }
          },
          "status-counts" : {
            "type" : "object",
            "additionalProperties" : {
              "type" : "integer"
            }
          }
        }
      }
    }
  }
}            
          
/jobs/:jobid/vertices/::vertexid/subtasks/:subtaskindex/attempts
Verb: GET Response code: 200 OK
Request handler providing details about all execution attempts of a subtask.
Path parameters
  • jobid - description
  • vertexid - description
  • subtaskindex - description
            
{}
            
          
            
{
    "type" : "object",
    "id" : "urn:jsonschema:org:apache:flink:runtime:messages:webmonitor:SubtaskExecutionAllAttemptsInfo",
    "properties" : {
      "attempts" : {
        "type" : "array",
        "items" : {
          "type" : "any"
        }
      }
      }
    }
}
            
          
/overview
Verb: GET Response code: 200 OK
Returns an overview over the Flink cluster.
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:legacy:messages:ClusterOverviewWithVersion",
  "properties" : {
    "taskmanagers" : {
      "type" : "integer"
    },
    "slots-total" : {
      "type" : "integer"
    },
    "slots-available" : {
      "type" : "integer"
    },
    "jobs-running" : {
      "type" : "integer"
    },
    "jobs-finished" : {
      "type" : "integer"
    },
    "jobs-cancelled" : {
      "type" : "integer"
    },
    "jobs-failed" : {
      "type" : "integer"
    },
    "flink-version" : {
      "type" : "string"
    },
    "flink-commit" : {
      "type" : "string"
    }
  }
}            
          
/savepoint-disposal
Verb: POST Response code: 200 OK
Triggers the desposal of a savepoint.
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:savepoints:SavepointDisposalRequest",
  "properties" : {
    "savepoint-path" : {
      "type" : "string"
    }
  }
}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:TriggerResponse",
  "properties" : {
    "request-id" : {
      "type" : "any"
    }
  }
}            
          
/savepoint-disposal/:triggerid
Verb: GET Response code: 200 OK
Returns the status of a savepoint disposal operation.
Path parameters
  • triggerid - description
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:AsynchronousOperationResult",
  "properties" : {
    "status" : {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:queue:QueueStatus",
      "properties" : {
        "id" : {
          "type" : "string",
          "required" : true,
          "enum" : [ "IN_PROGRESS", "COMPLETED" ]
        }
      }
    },
    "operation" : {
      "type" : "any"
    }
  }
}            
          
/taskmanagers
Verb: GET Response code: 200 OK
Returns an overview over all task managers.
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagersInfo",
  "properties" : {
    "taskmanagers" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerInfo",
        "properties" : {
          "id" : {
            "type" : "any"
          },
          "path" : {
            "type" : "string"
          },
          "dataPort" : {
            "type" : "integer"
          },
          "timeSinceLastHeartbeat" : {
            "type" : "integer"
          },
          "slotsNumber" : {
            "type" : "integer"
          },
          "freeSlots" : {
            "type" : "integer"
          },
          "hardware" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:instance:HardwareDescription",
            "properties" : {
              "cpuCores" : {
                "type" : "integer"
              },
              "physicalMemory" : {
                "type" : "integer"
              },
              "freeMemory" : {
                "type" : "integer"
              },
              "managedMemory" : {
                "type" : "integer"
              }
            }
          }
        }
      }
    }
  }
}            
          
/taskmanagers/metrics
Verb: GET Response code: 200 OK
Provides access to aggregated task manager metrics.
Query parameters
  • get (optional): description
  • agg (optional): description
  • taskmanagers (optional): description
            
{}            
          
            
{
  "type" : "any"
}            
          
/taskmanagers/:taskmanagerid
Verb: GET Response code: 200 OK
Returns details for a task manager.
Path parameters
  • taskmanagerid - description
            
{}            
          
            
{
  "type" : "object",
  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerDetailsInfo",
  "properties" : {
    "id" : {
      "type" : "any"
    },
    "path" : {
      "type" : "string"
    },
    "dataPort" : {
      "type" : "integer"
    },
    "timeSinceLastHeartbeat" : {
      "type" : "integer"
    },
    "slotsNumber" : {
      "type" : "integer"
    },
    "freeSlots" : {
      "type" : "integer"
    },
    "hardware" : {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:instance:HardwareDescription",
      "properties" : {
        "cpuCores" : {
          "type" : "integer"
        },
        "physicalMemory" : {
          "type" : "integer"
        },
        "freeMemory" : {
          "type" : "integer"
        },
        "managedMemory" : {
          "type" : "integer"
        }
      }
    },
    "metrics" : {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerMetricsInfo",
      "properties" : {
        "heapUsed" : {
          "type" : "integer"
        },
        "heapCommitted" : {
          "type" : "integer"
        },
        "heapMax" : {
          "type" : "integer"
        },
        "nonHeapUsed" : {
          "type" : "integer"
        },
        "nonHeapCommitted" : {
          "type" : "integer"
        },
        "nonHeapMax" : {
          "type" : "integer"
        },
        "directCount" : {
          "type" : "integer"
        },
        "directUsed" : {
          "type" : "integer"
        },
        "directMax" : {
          "type" : "integer"
        },
        "mappedCount" : {
          "type" : "integer"
        },
        "mappedUsed" : {
          "type" : "integer"
        },
        "mappedMax" : {
          "type" : "integer"
        },
        "memorySegmentsAvailable" : {
          "type" : "integer"
        },
        "memorySegmentsTotal" : {
          "type" : "integer"
        },
        "garbageCollectors" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerMetricsInfo:GarbageCollectorInfo",
            "properties" : {
              "name" : {
                "type" : "string"
              },
              "count" : {
                "type" : "integer"
              },
              "time" : {
                "type" : "integer"
              }
            }
          }
        }
      }
    }
  }
}            
          
/taskmanagers/:taskmanagerid/metrics
Verb: GET Response code: 200 OK
Provides access to task manager metrics.
Path parameters
  • taskmanagerid - description
Query parameters
  • get (optional): description
            
{}            
          
            
{
  "type" : "any"
}            
          
/taskmanagers/:taskmanagerid/log/:filename?start={start}&count={count}
Verb: GET Response code: 200 OK
Returns file content and length of a file in taskmanager log dir.
Path parameters
  • taskmanagerid - description
  • filename - description
Query parameters
  • start - description file read start postion
  • count - description file read size
            
{}
            
          
            
{
    "type" : "object",
    "id" : "urn:jsonschema:org:apache:flink:runtime:messages:webmonitor:LogDetail",
    "properties" : {
      "data" : {
        "type" : "string"
        },
      "data" : {
        "file_size" : "Long",
        }
      }
      }
    }
}
            
          
/taskmanagers/:taskmanagerid/logs
Verb: GET Response code: 200 OK
Returns file list in log dir of a taskmanager.
Path parameters
  • taskmanagerid - description
            
{}
            
          
            
{
    "type" : "object",
    "id" : "urn:jsonschema:org:apache:flink:runtime:messages:webmonitor:LogsInfo",
    "properties" : {
      "logs" : {
        "type" : "array",
        "items" : {
          "type" : "any"
        }
      }
      }
    }
}