REST API

Flink has a monitoring API that can be used to query status and statistics of running jobs, as well as recent completed jobs. This monitoring API is used by Flink’s own dashboard, but is designed to be used also by custom monitoring tools.

The monitoring API is a REST-ful API that accepts HTTP requests and responds with JSON data.

Overview

The monitoring API is backed by a web server that runs as part of the JobManager. By default, this server listens at port 8081, which can be configured in flink-conf.yaml via rest.port. Note that the monitoring API web server and the web dashboard web server are currently the same and thus run together at the same port. They respond to different HTTP URLs, though.

In the case of multiple JobManagers (for high availability), each JobManager will run its own instance of the monitoring API, which offers information about completed and running job while that JobManager was elected the cluster leader.

Developing

The REST API backend is in the flink-runtime project. The core class is org.apache.flink.runtime.webmonitor.WebMonitorEndpoint, which sets up the server and the request routing.

We use Netty and the Netty Router library to handle REST requests and translate URLs. This choice was made because this combination has lightweight dependencies, and the performance of Netty HTTP is very good.

To add new requests, one needs to

  • add a new MessageHeaders class which serves as an interface for the new request,
  • add a new AbstractRestHandler class which handles the request according to the added MessageHeaders class,
  • add the handler to org.apache.flink.runtime.webmonitor.WebMonitorEndpoint#initializeHandlers().

A good example is the org.apache.flink.runtime.rest.handler.job.JobExceptionsHandler that uses the org.apache.flink.runtime.rest.messages.JobExceptionsHeaders.

API

The REST API is versioned, with specific versions being queryable by prefixing the url with the version prefix. Prefixes are always of the form v[version_number]. For example, to access version 1 of /foo/bar one would query /v1/foo/bar.

If no version is specified Flink will default to the oldest version supporting the request.

Querying unsupported/non-existing versions will return a 404 error.

There exist several async operations among these APIs, e.g. trigger savepoint, rescale a job. They would return a triggerid to identify the operation you just POST and then you need to use that triggerid to query for the status of the operation.

JobManager

/cluster
Verb: DELETEResponse code: 200 OK
Shuts down the cluster
  1.             
  2. {}            
  3.           
  1.             
  2. {}            
  3.
/config
Verb: GETResponse code: 200 OK
Returns the configuration of the WebUI.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:DashboardConfiguration”,
  5.   “properties” : {
  6.     “features” : {
  7.       “type” : “object”,
  8.       “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:DashboardConfiguration:Features”,
  9.       “properties” : {
  10.         “web-submit” : {
  11.           “type” : “boolean”
  12.         }
  13.       }
  14.     },
  15.     “flink-revision” : {
  16.       “type” : “string”
  17.     },
  18.     “flink-version” : {
  19.       “type” : “string”
  20.     },
  21.     “refresh-interval” : {
  22.       “type” : “integer”
  23.     },
  24.     “timezone-name” : {
  25.       “type” : “string”
  26.     },
  27.     “timezone-offset” : {
  28.       “type” : “integer”
  29.     }
  30.   }
  31. }            
  32.
/datasets
Verb: GETResponse code: 200 OK
Returns all cluster data sets.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:dataset:ClusterDataSetListResponseBody”,
  5.   “properties” : {
  6.     “dataSets” : {
  7.       “type” : “array”,
  8.       “items” : {
  9.         “type” : “object”,
  10.         “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:dataset:ClusterDataSetEntry”,
  11.         “properties” : {
  12.           “id” : {
  13.             “type” : “string”
  14.           },
  15.           “isComplete” : {
  16.             “type” : “boolean”
  17.           }
  18.         }
  19.       }
  20.     }
  21.   }
  22. }            
  23.
/datasets/delete/:triggerid
Verb: GETResponse code: 200 OK
Returns the status for the delete operation of a cluster data set.
Path parameters
  • triggerid - 32-character hexadecimal string that identifies an asynchronous operation trigger ID. The ID was returned then the operation was triggered.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:handler:async:AsynchronousOperationResult”,
  5.   “properties” : {
  6.     “operation” : {
  7.       “type” : “object”,
  8.       “id” : “urn:jsonschema:org:apache:flink:runtime:rest:handler:async:AsynchronousOperationInfo”,
  9.       “properties” : {
  10.         “failure-cause” : {
  11.           “type” : “any”
  12.         }
  13.       }
  14.     },
  15.     “status” : {
  16.       “type” : “object”,
  17.       “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:queue:QueueStatus”,
  18.       “properties” : {
  19.         “id” : {
  20.           “type” : “string”,
  21.           “required” : true,
  22.           “enum” : [ “IN_PROGRESS”, “COMPLETED” ]
  23.         }
  24.       }
  25.     }
  26.   }
  27. }            
  28.
/datasets/:datasetid
Verb: DELETEResponse code: 202 Accepted
Triggers the deletion of a cluster data set. This async operation would return a ‘triggerid’ for further query identifier.
Path parameters
  • datasetid - 32-character hexadecimal string value that identifies a cluster data set.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:handler:async:TriggerResponse”,
  5.   “properties” : {
  6.     “request-id” : {
  7.       “type” : “any”
  8.     }
  9.   }
  10. }            
  11.
/jars
Verb: GETResponse code: 200 OK
Returns a list of all jars previously uploaded via ‘/jars/upload’.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarListInfo”,
  5.   “properties” : {
  6.     “address” : {
  7.       “type” : “string”
  8.     },
  9.     “files” : {
  10.       “type” : “array”,
  11.       “items” : {
  12.         “type” : “object”,
  13.         “id” : “urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarListInfo:JarFileInfo”,
  14.         “properties” : {
  15.           “entry” : {
  16.             “type” : “array”,
  17.             “items” : {
  18.               “type” : “object”,
  19.               “id” : “urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarListInfo:JarEntryInfo”,
  20.               “properties” : {
  21.                 “description” : {
  22.                   “type” : “string”
  23.                 },
  24.                 “name” : {
  25.                   “type” : “string”
  26.                 }
  27.               }
  28.             }
  29.           },
  30.           “id” : {
  31.             “type” : “string”
  32.           },
  33.           “name” : {
  34.             “type” : “string”
  35.           },
  36.           “uploaded” : {
  37.             “type” : “integer”
  38.           }
  39.         }
  40.       }
  41.     }
  42.   }
  43. }            
  44.
/jars/upload
Verb: POSTResponse 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‘.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarUploadResponseBody”,
  5.   “properties” : {
  6.     “filename” : {
  7.       “type” : “string”
  8.     },
  9.     “status” : {
  10.       “type” : “string”,
  11.       “enum” : [ “success” ]
  12.     }
  13.   }
  14. }            
  15.
/jars/:jarid
Verb: DELETEResponse code: 200 OK
Deletes a jar previously uploaded via ‘/jars/upload’.
Path parameters
  • jarid - String value that identifies a jar. When uploading the jar a path is returned, where the filename is the ID. This value is equivalent to the id field in the list of uploaded jars (/jars).
  1.             
  2. {}            
  3.           
  1.             
  2. {}            
  3.
/jars/:jarid/plan
Verb: GETResponse code: 200 OK
Returns the dataflow plan of a job contained in a jar previously uploaded via ‘/jars/upload’. Program arguments can be passed both via the JSON request (recommended) or query parameters.
Path parameters
  • jarid - String value that identifies a jar. When uploading the jar a path is returned, where the filename is the ID. This value is equivalent to the id field in the list of uploaded jars (/jars).
Query parameters
  • program-args (optional): Deprecated, please use ‘programArg’ instead. String value that specifies the arguments for the program or plan
  • programArg (optional): Comma-separated list of program arguments.
  • entry-class (optional): String value that specifies the fully qualified name of the entry point class. Overrides the class defined in the jar file manifest.
  • parallelism (optional): Positive integer value that specifies the desired parallelism for the job.
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarPlanRequestBody”,
  5.   “properties” : {
  6.     “entryClass” : {
  7.       “type” : “string”
  8.     },
  9.     “jobId” : {
  10.       “type” : “any”
  11.     },
  12.     “parallelism” : {
  13.       “type” : “integer”
  14.     },
  15.     “programArgs” : {
  16.       “type” : “string”
  17.     },
  18.     “programArgsList” : {
  19.       “type” : “array”,
  20.       “items” : {
  21.         “type” : “string”
  22.       }
  23.     }
  24.   }
  25. }            
  26.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:JobPlanInfo”,
  5.   “properties” : {
  6.     “plan” : {
  7.       “type” : “any”
  8.     }
  9.   }
  10. }            
  11.
/jars/:jarid/plan
Verb: POSTResponse code: 200 OK
Returns the dataflow plan of a job contained in a jar previously uploaded via ‘/jars/upload’. Program arguments can be passed both via the JSON request (recommended) or query parameters.
Path parameters
  • jarid - String value that identifies a jar. When uploading the jar a path is returned, where the filename is the ID. This value is equivalent to the id field in the list of uploaded jars (/jars).
Query parameters
  • program-args (optional): Deprecated, please use ‘programArg’ instead. String value that specifies the arguments for the program or plan
  • programArg (optional): Comma-separated list of program arguments.
  • entry-class (optional): String value that specifies the fully qualified name of the entry point class. Overrides the class defined in the jar file manifest.
  • parallelism (optional): Positive integer value that specifies the desired parallelism for the job.
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarPlanRequestBody”,
  5.   “properties” : {
  6.     “entryClass” : {
  7.       “type” : “string”
  8.     },
  9.     “jobId” : {
  10.       “type” : “any”
  11.     },
  12.     “parallelism” : {
  13.       “type” : “integer”
  14.     },
  15.     “programArgs” : {
  16.       “type” : “string”
  17.     },
  18.     “programArgsList” : {
  19.       “type” : “array”,
  20.       “items” : {
  21.         “type” : “string”
  22.       }
  23.     }
  24.   }
  25. }            
  26.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:JobPlanInfo”,
  5.   “properties” : {
  6.     “plan” : {
  7.       “type” : “any”
  8.     }
  9.   }
  10. }            
  11.
/jars/:jarid/run
Verb: POSTResponse code: 200 OK
Submits a job by running a jar previously uploaded via ‘/jars/upload’. Program arguments can be passed both via the JSON request (recommended) or query parameters.
Path parameters
  • jarid - String value that identifies a jar. When uploading the jar a path is returned, where the filename is the ID. This value is equivalent to the id field in the list of uploaded jars (/jars).
Query parameters
  • allowNonRestoredState (optional): Boolean value that specifies whether the job submission should be rejected if the savepoint contains state that cannot be mapped back to the job.
  • savepointPath (optional): String value that specifies the path of the savepoint to restore the job from.
  • program-args (optional): Deprecated, please use ‘programArg’ instead. String value that specifies the arguments for the program or plan
  • programArg (optional): Comma-separated list of program arguments.
  • entry-class (optional): String value that specifies the fully qualified name of the entry point class. Overrides the class defined in the jar file manifest.
  • parallelism (optional): Positive integer value that specifies the desired parallelism for the job.
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarRunRequestBody”,
  5.   “properties” : {
  6.     “allowNonRestoredState” : {
  7.       “type” : “boolean”
  8.     },
  9.     “entryClass” : {
  10.       “type” : “string”
  11.     },
  12.     “jobId” : {
  13.       “type” : “any”
  14.     },
  15.     “parallelism” : {
  16.       “type” : “integer”
  17.     },
  18.     “programArgs” : {
  19.       “type” : “string”
  20.     },
  21.     “programArgsList” : {
  22.       “type” : “array”,
  23.       “items” : {
  24.         “type” : “string”
  25.       }
  26.     },
  27.     “savepointPath” : {
  28.       “type” : “string”
  29.     }
  30.   }
  31. }            
  32.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarRunResponseBody”,
  5.   “properties” : {
  6.     “jobid” : {
  7.       “type” : “any”
  8.     }
  9.   }
  10. }            
  11.
/jobmanager/config
Verb: GETResponse code: 200 OK
Returns the cluster configuration.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “array”,
  4.   “items” : {
  5.     “type” : “object”,
  6.     “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:ClusterConfigurationInfoEntry”,
  7.     “properties” : {
  8.       “key” : {
  9.         “type” : “string”
  10.       },
  11.       “value” : {
  12.         “type” : “string”
  13.       }
  14.     }
  15.   }
  16. }            
  17.
/jobmanager/logs
Verb: GETResponse code: 200 OK
Returns the list of log files on the JobManager.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:LogListInfo”,
  5.   “properties” : {
  6.     “logs” : {
  7.       “type” : “array”,
  8.       “items” : {
  9.         “type” : “object”,
  10.         “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:LogInfo”,
  11.         “properties” : {
  12.           “name” : {
  13.             “type” : “string”
  14.           },
  15.           “size” : {
  16.             “type” : “integer”
  17.           }
  18.         }
  19.       }
  20.     }
  21.   }
  22. }            
  23.
/jobmanager/metrics
Verb: GETResponse code: 200 OK
Provides access to job manager metrics.
Query parameters
  • get (optional): Comma-separated list of string values to select specific metrics.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “any”
  4. }            
  5.
/jobs
Verb: GETResponse code: 200 OK
Returns an overview over all jobs and their current state.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:messages:webmonitor:JobIdsWithStatusOverview”,
  5.   “properties” : {
  6.     “jobs” : {
  7.       “type” : “array”,
  8.       “items” : {
  9.         “type” : “object”,
  10.         “id” : “urn:jsonschema:org:apache:flink:runtime:messages:webmonitor:JobIdsWithStatusOverview:JobIdWithStatus”,
  11.         “properties” : {
  12.           “id” : {
  13.             “type” : “any”
  14.           },
  15.           “status” : {
  16.             “type” : “string”,
  17.             “enum” : [ “INITIALIZING”, “CREATED”, “RUNNING”, “FAILING”, “FAILED”, “CANCELLING”, “CANCELED”, “FINISHED”, “RESTARTING”, “SUSPENDED”, “RECONCILING” ]
  18.           }
  19.         }
  20.       }
  21.     }
  22.   }
  23. }            
  24.
/jobs
Verb: POSTResponse code: 202 Accepted
Submits a job. This call is primarily intended to be used by the Flink client. This call expects a multipart/form-data request that consists of file uploads for the serialized JobGraph, jars and distributed cache artifacts and an attribute named “request” for the JSON payload.
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobSubmitRequestBody”,
  5.   “properties” : {
  6.     “jobArtifactFileNames” : {
  7.       “type” : “array”,
  8.       “items” : {
  9.         “type” : “object”,
  10.         “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobSubmitRequestBody:DistributedCacheFile”,
  11.         “properties” : {
  12.           “entryName” : {
  13.             “type” : “string”
  14.           },
  15.           “fileName” : {
  16.             “type” : “string”
  17.           }
  18.         }
  19.       }
  20.     },
  21.     “jobGraphFileName” : {
  22.       “type” : “string”
  23.     },
  24.     “jobJarFileNames” : {
  25.       “type” : “array”,
  26.       “items” : {
  27.         “type” : “string”
  28.       }
  29.     }
  30.   }
  31. }            
  32.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobSubmitResponseBody”,
  5.   “properties” : {
  6.     “jobUrl” : {
  7.       “type” : “string”
  8.     }
  9.   }
  10. }            
  11.
/jobs/metrics
Verb: GETResponse code: 200 OK
Provides access to aggregated job metrics.
Query parameters
  • get (optional): Comma-separated list of string values to select specific metrics.
  • agg (optional): Comma-separated list of aggregation modes which should be calculated. Available aggregations are: “min, max, sum, avg”.
  • jobs (optional): Comma-separated list of 32-character hexadecimal strings to select specific jobs.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “any”
  4. }            
  5.
/jobs/overview
Verb: GETResponse code: 200 OK
Returns an overview over all jobs.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:messages:webmonitor:MultipleJobsDetails”,
  5.   “properties” : {
  6.     “jobs” : {
  7.       “type” : “array”,
  8.       “items” : {
  9.         “type” : “any”
  10.       }
  11.     }
  12.   }
  13. }            
  14.
/jobs/:jobid
Verb: GETResponse code: 200 OK
Returns details of a job.
Path parameters
  • jobid - 32-character hexadecimal string value that identifies a job.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobDetailsInfo”,
  5.   “properties” : {
  6.     “duration” : {
  7.       “type” : “integer”
  8.     },
  9.     “end-time” : {
  10.       “type” : “integer”
  11.     },
  12.     “isStoppable” : {
  13.       “type” : “boolean”
  14.     },
  15.     “jid” : {
  16.       “type” : “any”
  17.     },
  18.     “name” : {
  19.       “type” : “string”
  20.     },
  21.     “now” : {
  22.       “type” : “integer”
  23.     },
  24.     “plan” : {
  25.       “type” : “string”
  26.     },
  27.     “start-time” : {
  28.       “type” : “integer”
  29.     },
  30.     “state” : {
  31.       “type” : “string”,
  32.       “enum” : [ “INITIALIZING”, “CREATED”, “RUNNING”, “FAILING”, “FAILED”, “CANCELLING”, “CANCELED”, “FINISHED”, “RESTARTING”, “SUSPENDED”, “RECONCILING” ]
  33.     },
  34.     “status-counts” : {
  35.       “type” : “object”,
  36.       “additionalProperties” : {
  37.         “type” : “integer”
  38.       }
  39.     },
  40.     “timestamps” : {
  41.       “type” : “object”,
  42.       “additionalProperties” : {
  43.         “type” : “integer”
  44.       }
  45.     },
  46.     “vertices” : {
  47.       “type” : “array”,
  48.       “items” : {
  49.         “type” : “object”,
  50.         “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobDetailsInfo:JobVertexDetailsInfo”,
  51.         “properties” : {
  52.           “duration” : {
  53.             “type” : “integer”
  54.           },
  55.           “end-time” : {
  56.             “type” : “integer”
  57.           },
  58.           “id” : {
  59.             “type” : “any”
  60.           },
  61.           “metrics” : {
  62.             “type” : “object”,
  63.             “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:IOMetricsInfo”,
  64.             “properties” : {
  65.               “read-bytes” : {
  66.                 “type” : “integer”
  67.               },
  68.               “read-bytes-complete” : {
  69.                 “type” : “boolean”
  70.               },
  71.               “read-records” : {
  72.                 “type” : “integer”
  73.               },
  74.               “read-records-complete” : {
  75.                 “type” : “boolean”
  76.               },
  77.               “write-bytes” : {
  78.                 “type” : “integer”
  79.               },
  80.               “write-bytes-complete” : {
  81.                 “type” : “boolean”
  82.               },
  83.               “write-records” : {
  84.                 “type” : “integer”
  85.               },
  86.               “write-records-complete” : {
  87.                 “type” : “boolean”
  88.               }
  89.             }
  90.           },
  91.           “name” : {
  92.             “type” : “string”
  93.           },
  94.           “parallelism” : {
  95.             “type” : “integer”
  96.           },
  97.           “start-time” : {
  98.             “type” : “integer”
  99.           },
  100.           “status” : {
  101.             “type” : “string”,
  102.             “enum” : [ “CREATED”, “SCHEDULED”, “DEPLOYING”, “RUNNING”, “FINISHED”, “CANCELING”, “CANCELED”, “FAILED”, “RECONCILING” ]
  103.           },
  104.           “tasks” : {
  105.             “type” : “object”,
  106.             “additionalProperties” : {
  107.               “type” : “integer”
  108.             }
  109.           }
  110.         }
  111.       }
  112.     }
  113.   }
  114. }            
  115.
/jobs/:jobid
Verb: PATCHResponse code: 202 Accepted
Terminates a job.
Path parameters
  • jobid - 32-character hexadecimal string value that identifies a job.
Query parameters
  • mode (optional): String value that specifies the termination mode. The only supported value is: “cancel”.
  1.             
  2. {}            
  3.           
  1.             
  2. {}            
  3.
/jobs/:jobid/accumulators
Verb: GETResponse code: 200 OK
Returns the accumulators for all tasks of a job, aggregated across the respective subtasks.
Path parameters
  • jobid - 32-character hexadecimal string value that identifies a job.
Query parameters
  • includeSerializedValue (optional): Boolean value that specifies whether serialized user task accumulators should be included in the response.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:JobAccumulatorsInfo”,
  5.   “properties” : {
  6.     “job-accumulators” : {
  7.       “type” : “array”,
  8.       “items” : {
  9.         “type” : “any”
  10.       }
  11.     },
  12.     “serialized-user-task-accumulators” : {
  13.       “type” : “object”,
  14.       “additionalProperties” : {
  15.         “type” : “any”
  16.       }
  17.     },
  18.     “user-task-accumulators” : {
  19.       “type” : “array”,
  20.       “items” : {
  21.         “type” : “object”,
  22.         “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:JobAccumulatorsInfo:UserTaskAccumulator”,
  23.         “properties” : {
  24.           “name” : {
  25.             “type” : “string”
  26.           },
  27.           “type” : {
  28.             “type” : “string”
  29.           },
  30.           “value” : {
  31.             “type” : “string”
  32.           }
  33.         }
  34.       }
  35.     }
  36.   }
  37. }            
  38.
/jobs/:jobid/checkpoints
Verb: GETResponse code: 200 OK
Returns checkpointing statistics for a job.
Path parameters
  • jobid - 32-character hexadecimal string value that identifies a job.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics”,
  5.   “properties” : {
  6.     “counts” : {
  7.       “type” : “object”,
  8.       “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics:Counts”,
  9.       “properties” : {
  10.         “completed” : {
  11.           “type” : “integer”
  12.         },
  13.         “failed” : {
  14.           “type” : “integer”
  15.         },
  16.         “in_progress” : {
  17.           “type” : “integer”
  18.         },
  19.         “restored” : {
  20.           “type” : “integer”
  21.         },
  22.         “total” : {
  23.           “type” : “integer”
  24.         }
  25.       }
  26.     },
  27.     “history” : {
  28.       “type” : “array”,
  29.       “items” : {
  30.         “type” : “object”,
  31.         “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics”,
  32.         “properties” : {
  33.           “alignment_buffered” : {
  34.             “type” : “integer”
  35.           },
  36.           “checkpoint_type” : {
  37.             “type” : “string”,
  38.             “enum” : [ “CHECKPOINT”, “SAVEPOINT”, “SYNC_SAVEPOINT” ]
  39.           },
  40.           “end_to_end_duration” : {
  41.             “type” : “integer”
  42.           },
  43.           “id” : {
  44.             “type” : “integer”
  45.           },
  46.           “is_savepoint” : {
  47.             “type” : “boolean”
  48.           },
  49.           “latest_ack_timestamp” : {
  50.             “type” : “integer”
  51.           },
  52.           “num_acknowledged_subtasks” : {
  53.             “type” : “integer”
  54.           },
  55.           “num_subtasks” : {
  56.             “type” : “integer”
  57.           },
  58.           “persisted_data” : {
  59.             “type” : “integer”
  60.           },
  61.           “processed_data” : {
  62.             “type” : “integer”
  63.           },
  64.           “state_size” : {
  65.             “type” : “integer”
  66.           },
  67.           “status” : {
  68.             “type” : “string”,
  69.             “enum” : [ “IN_PROGRESS”, “COMPLETED”, “FAILED” ]
  70.           },
  71.           “tasks” : {
  72.             “type” : “object”,
  73.             “additionalProperties” : {
  74.               “type” : “object”,
  75.               “$ref” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatistics”
  76.             }
  77.           },
  78.           “trigger_timestamp” : {
  79.             “type” : “integer”
  80.           }
  81.         }
  82.       }
  83.     },
  84.     “latest” : {
  85.       “type” : “object”,
  86.       “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics:LatestCheckpoints”,
  87.       “properties” : {
  88.         “completed” : {
  89.           “type” : “object”,
  90.           “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics:CompletedCheckpointStatistics”,
  91.           “properties” : {
  92.             “alignment_buffered” : {
  93.               “type” : “integer”
  94.             },
  95.             “checkpoint_type” : {
  96.               “type” : “string”,
  97.               “enum” : [ “CHECKPOINT”, “SAVEPOINT”, “SYNC_SAVEPOINT” ]
  98.             },
  99.             “discarded” : {
  100.               “type” : “boolean”
  101.             },
  102.             “end_to_end_duration” : {
  103.               “type” : “integer”
  104.             },
  105.             “external_path” : {
  106.               “type” : “string”
  107.             },
  108.             “id” : {
  109.               “type” : “integer”
  110.             },
  111.             “is_savepoint” : {
  112.               “type” : “boolean”
  113.             },
  114.             “latest_ack_timestamp” : {
  115.               “type” : “integer”
  116.             },
  117.             “num_acknowledged_subtasks” : {
  118.               “type” : “integer”
  119.             },
  120.             “num_subtasks” : {
  121.               “type” : “integer”
  122.             },
  123.             “persisted_data” : {
  124.               “type” : “integer”
  125.             },
  126.             “processed_data” : {
  127.               “type” : “integer”
  128.             },
  129.             “state_size” : {
  130.               “type” : “integer”
  131.             },
  132.             “status” : {
  133.               “type” : “string”,
  134.               “enum” : [ “IN_PROGRESS”, “COMPLETED”, “FAILED” ]
  135.             },
  136.             “tasks” : {
  137.               “type” : “object”,
  138.               “additionalProperties” : {
  139.                 “type” : “object”,
  140.                 “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatistics”,
  141.                 “properties” : {
  142.                   “alignment_buffered” : {
  143.                     “type” : “integer”
  144.                   },
  145.                   “end_to_end_duration” : {
  146.                     “type” : “integer”
  147.                   },
  148.                   “id” : {
  149.                     “type” : “integer”
  150.                   },
  151.                   “latest_ack_timestamp” : {
  152.                     “type” : “integer”
  153.                   },
  154.                   “num_acknowledged_subtasks” : {
  155.                     “type” : “integer”
  156.                   },
  157.                   “num_subtasks” : {
  158.                     “type” : “integer”
  159.                   },
  160.                   “persisted_data” : {
  161.                     “type” : “integer”
  162.                   },
  163.                   “processed_data” : {
  164.                     “type” : “integer”
  165.                   },
  166.                   “state_size” : {
  167.                     “type” : “integer”
  168.                   },
  169.                   “status” : {
  170.                     “type” : “string”,
  171.                     “enum” : [ “IN_PROGRESS”, “COMPLETED”, “FAILED” ]
  172.                   }
  173.                 }
  174.               }
  175.             },
  176.             “trigger_timestamp” : {
  177.               “type” : “integer”
  178.             }
  179.           }
  180.         },
  181.         “failed” : {
  182.           “type” : “object”,
  183.           “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics:FailedCheckpointStatistics”,
  184.           “properties” : {
  185.             “alignment_buffered” : {
  186.               “type” : “integer”
  187.             },
  188.             “checkpoint_type” : {
  189.               “type” : “string”,
  190.               “enum” : [ “CHECKPOINT”, “SAVEPOINT”, “SYNC_SAVEPOINT” ]
  191.             },
  192.             “end_to_end_duration” : {
  193.               “type” : “integer”
  194.             },
  195.             “failure_message” : {
  196.               “type” : “string”
  197.             },
  198.             “failure_timestamp” : {
  199.               “type” : “integer”
  200.             },
  201.             “id” : {
  202.               “type” : “integer”
  203.             },
  204.             “is_savepoint” : {
  205.               “type” : “boolean”
  206.             },
  207.             “latest_ack_timestamp” : {
  208.               “type” : “integer”
  209.             },
  210.             “num_acknowledged_subtasks” : {
  211.               “type” : “integer”
  212.             },
  213.             “num_subtasks” : {
  214.               “type” : “integer”
  215.             },
  216.             “persisted_data” : {
  217.               “type” : “integer”
  218.             },
  219.             “processed_data” : {
  220.               “type” : “integer”
  221.             },
  222.             “state_size” : {
  223.               “type” : “integer”
  224.             },
  225.             “status” : {
  226.               “type” : “string”,
  227.               “enum” : [ “IN_PROGRESS”, “COMPLETED”, “FAILED” ]
  228.             },
  229.             “tasks” : {
  230.               “type” : “object”,
  231.               “additionalProperties” : {
  232.                 “type” : “object”,
  233.                 “$ref” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatistics”
  234.               }
  235.             },
  236.             “trigger_timestamp” : {
  237.               “type” : “integer”
  238.             }
  239.           }
  240.         },
  241.         “restored” : {
  242.           “type” : “object”,
  243.           “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics:RestoredCheckpointStatistics”,
  244.           “properties” : {
  245.             “external_path” : {
  246.               “type” : “string”
  247.             },
  248.             “id” : {
  249.               “type” : “integer”
  250.             },
  251.             “is_savepoint” : {
  252.               “type” : “boolean”
  253.             },
  254.             “restore_timestamp” : {
  255.               “type” : “integer”
  256.             }
  257.           }
  258.         },
  259.         “savepoint” : {
  260.           “type” : “object”,
  261.           “$ref” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics:CompletedCheckpointStatistics”
  262.         }
  263.       }
  264.     },
  265.     “summary” : {
  266.       “type” : “object”,
  267.       “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics:Summary”,
  268.       “properties” : {
  269.         “alignment_buffered” : {
  270.           “type” : “object”,
  271.           “$ref” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics”
  272.         },
  273.         “end_to_end_duration” : {
  274.           “type” : “object”,
  275.           “$ref” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics”
  276.         },
  277.         “persisted_data” : {
  278.           “type” : “object”,
  279.           “$ref” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics”
  280.         },
  281.         “processed_data” : {
  282.           “type” : “object”,
  283.           “$ref” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics”
  284.         },
  285.         “state_size” : {
  286.           “type” : “object”,
  287.           “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics”,
  288.           “properties” : {
  289.             “avg” : {
  290.               “type” : “integer”
  291.             },
  292.             “max” : {
  293.               “type” : “integer”
  294.             },
  295.             “min” : {
  296.               “type” : “integer”
  297.             }
  298.           }
  299.         }
  300.       }
  301.     }
  302.   }
  303. }            
  304.
/jobs/:jobid/checkpoints/config
Verb: GETResponse code: 200 OK
Returns the checkpointing configuration.
Path parameters
  • jobid - 32-character hexadecimal string value that identifies a job.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointConfigInfo”,
  5.   “properties” : {
  6.     “externalization” : {
  7.       “type” : “object”,
  8.       “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointConfigInfo:ExternalizedCheckpointInfo”,
  9.       “properties” : {
  10.         “delete_on_cancellation” : {
  11.           “type” : “boolean”
  12.         },
  13.         “enabled” : {
  14.           “type” : “boolean”
  15.         }
  16.       }
  17.     },
  18.     “interval” : {
  19.       “type” : “integer”
  20.     },
  21.     “max_concurrent” : {
  22.       “type” : “integer”
  23.     },
  24.     “min_pause” : {
  25.       “type” : “integer”
  26.     },
  27.     “mode” : {
  28.       “type” : “any”
  29.     },
  30.     “state_backend” : {
  31.       “type” : “string”
  32.     },
  33.     “timeout” : {
  34.       “type” : “integer”
  35.     },
  36.     “tolerable_failed_checkpoints” : {
  37.       “type” : “integer”
  38.     },
  39.     “unaligned_checkpoints” : {
  40.       “type” : “boolean”
  41.     }
  42.   }
  43. }            
  44.
/jobs/:jobid/checkpoints/details/:checkpointid
Verb: GETResponse code: 200 OK
Returns details for a checkpoint.
Path parameters
  • jobid - 32-character hexadecimal string value that identifies a job.
  • checkpointid - Long value that identifies a checkpoint.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics”,
  5.   “properties” : {
  6.     “alignment_buffered” : {
  7.       “type” : “integer”
  8.     },
  9.     “checkpoint_type” : {
  10.       “type” : “string”,
  11.       “enum” : [ “CHECKPOINT”, “SAVEPOINT”, “SYNC_SAVEPOINT” ]
  12.     },
  13.     “end_to_end_duration” : {
  14.       “type” : “integer”
  15.     },
  16.     “id” : {
  17.       “type” : “integer”
  18.     },
  19.     “is_savepoint” : {
  20.       “type” : “boolean”
  21.     },
  22.     “latest_ack_timestamp” : {
  23.       “type” : “integer”
  24.     },
  25.     “num_acknowledged_subtasks” : {
  26.       “type” : “integer”
  27.     },
  28.     “num_subtasks” : {
  29.       “type” : “integer”
  30.     },
  31.     “persisted_data” : {
  32.       “type” : “integer”
  33.     },
  34.     “processed_data” : {
  35.       “type” : “integer”
  36.     },
  37.     “state_size” : {
  38.       “type” : “integer”
  39.     },
  40.     “status” : {
  41.       “type” : “string”,
  42.       “enum” : [ “IN_PROGRESS”, “COMPLETED”, “FAILED” ]
  43.     },
  44.     “tasks” : {
  45.       “type” : “object”,
  46.       “additionalProperties” : {
  47.         “type” : “object”,
  48.         “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatistics”,
  49.         “properties” : {
  50.           “alignment_buffered” : {
  51.             “type” : “integer”
  52.           },
  53.           “end_to_end_duration” : {
  54.             “type” : “integer”
  55.           },
  56.           “id” : {
  57.             “type” : “integer”
  58.           },
  59.           “latest_ack_timestamp” : {
  60.             “type” : “integer”
  61.           },
  62.           “num_acknowledged_subtasks” : {
  63.             “type” : “integer”
  64.           },
  65.           “num_subtasks” : {
  66.             “type” : “integer”
  67.           },
  68.           “persisted_data” : {
  69.             “type” : “integer”
  70.           },
  71.           “processed_data” : {
  72.             “type” : “integer”
  73.           },
  74.           “state_size” : {
  75.             “type” : “integer”
  76.           },
  77.           “status” : {
  78.             “type” : “string”,
  79.             “enum” : [ “IN_PROGRESS”, “COMPLETED”, “FAILED” ]
  80.           }
  81.         }
  82.       }
  83.     },
  84.     “trigger_timestamp” : {
  85.       “type” : “integer”
  86.     }
  87.   }
  88. }            
  89.
/jobs/:jobid/checkpoints/details/:checkpointid/subtasks/:vertexid
Verb: GETResponse code: 200 OK
Returns checkpoint statistics for a task and its subtasks.
Path parameters
  • jobid - 32-character hexadecimal string value that identifies a job.
  • checkpointid - Long value that identifies a checkpoint.
  • vertexid - 32-character hexadecimal string value that identifies a job vertex.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatisticsWithSubtaskDetails”,
  5.   “properties” : {
  6.     “alignment_buffered” : {
  7.       “type” : “integer”
  8.     },
  9.     “end_to_end_duration” : {
  10.       “type” : “integer”
  11.     },
  12.     “id” : {
  13.       “type” : “integer”
  14.     },
  15.     “latest_ack_timestamp” : {
  16.       “type” : “integer”
  17.     },
  18.     “num_acknowledged_subtasks” : {
  19.       “type” : “integer”
  20.     },
  21.     “num_subtasks” : {
  22.       “type” : “integer”
  23.     },
  24.     “persisted_data” : {
  25.       “type” : “integer”
  26.     },
  27.     “processed_data” : {
  28.       “type” : “integer”
  29.     },
  30.     “state_size” : {
  31.       “type” : “integer”
  32.     },
  33.     “status” : {
  34.       “type” : “string”,
  35.       “enum” : [ “IN_PROGRESS”, “COMPLETED”, “FAILED” ]
  36.     },
  37.     “subtasks” : {
  38.       “type” : “array”,
  39.       “items” : {
  40.         “type” : “object”,
  41.         “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:SubtaskCheckpointStatistics”,
  42.         “properties” : {
  43.           “index” : {
  44.             “type” : “integer”
  45.           },
  46.           “status” : {
  47.             “type” : “string”
  48.           }
  49.         }
  50.       }
  51.     },
  52.     “summary” : {
  53.       “type” : “object”,
  54.       “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatisticsWithSubtaskDetails:Summary”,
  55.       “properties” : {
  56.         “alignment” : {
  57.           “type” : “object”,
  58.           “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatisticsWithSubtaskDetails:CheckpointAlignment”,
  59.           “properties” : {
  60.             “buffered” : {
  61.               “type” : “object”,
  62.               “$ref” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics”
  63.             },
  64.             “duration” : {
  65.               “type” : “object”,
  66.               “$ref” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics”
  67.             },
  68.             “persisted” : {
  69.               “type” : “object”,
  70.               “$ref” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics”
  71.             },
  72.             “processed” : {
  73.               “type” : “object”,
  74.               “$ref” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics”
  75.             }
  76.           }
  77.         },
  78.         “checkpoint_duration” : {
  79.           “type” : “object”,
  80.           “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatisticsWithSubtaskDetails:CheckpointDuration”,
  81.           “properties” : {
  82.             “async” : {
  83.               “type” : “object”,
  84.               “$ref” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics”
  85.             },
  86.             “sync” : {
  87.               “type” : “object”,
  88.               “$ref” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics”
  89.             }
  90.           }
  91.         },
  92.         “end_to_end_duration” : {
  93.           “type” : “object”,
  94.           “$ref” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics”
  95.         },
  96.         “start_delay” : {
  97.           “type” : “object”,
  98.           “$ref” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics”
  99.         },
  100.         “state_size” : {
  101.           “type” : “object”,
  102.           “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics”,
  103.           “properties” : {
  104.             “avg” : {
  105.               “type” : “integer”
  106.             },
  107.             “max” : {
  108.               “type” : “integer”
  109.             },
  110.             “min” : {
  111.               “type” : “integer”
  112.             }
  113.           }
  114.         }
  115.       }
  116.     }
  117.   }
  118. }            
  119.
/jobs/:jobid/config
Verb: GETResponse code: 200 OK
Returns the configuration of a job.
Path parameters
  • jobid - 32-character hexadecimal string value that identifies a job.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “any”
  4. }            
  5.
/jobs/:jobid/exceptions
Verb: GETResponse 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 - 32-character hexadecimal string value that identifies a job.
Query parameters
  • maxExceptions (optional): Comma-separated list of integer values that specifies the upper limit of exceptions to return.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:JobExceptionsInfo”,
  5.   “properties” : {
  6.     “all-exceptions” : {
  7.       “type” : “array”,
  8.       “items” : {
  9.         “type” : “object”,
  10.         “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:JobExceptionsInfo:ExecutionExceptionInfo”,
  11.         “properties” : {
  12.           “exception” : {
  13.             “type” : “string”
  14.           },
  15.           “location” : {
  16.             “type” : “string”
  17.           },
  18.           “task” : {
  19.             “type” : “string”
  20.           },
  21.           “timestamp” : {
  22.             “type” : “integer”
  23.           }
  24.         }
  25.       }
  26.     },
  27.     “root-exception” : {
  28.       “type” : “string”
  29.     },
  30.     “timestamp” : {
  31.       “type” : “integer”
  32.     },
  33.     “truncated” : {
  34.       “type” : “boolean”
  35.     }
  36.   }
  37. }            
  38.
/jobs/:jobid/execution-result
Verb: GETResponse 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 - 32-character hexadecimal string value that identifies a job.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobExecutionResultResponseBody”,
  5.   “properties” : {
  6.     “job-execution-result” : {
  7.       “type” : “any”
  8.     },
  9.     “status” : {
  10.       “type” : “object”,
  11.       “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:queue:QueueStatus”,
  12.       “required” : true,
  13.       “properties” : {
  14.         “id” : {
  15.           “type” : “string”,
  16.           “required” : true,
  17.           “enum” : [ “IN_PROGRESS”, “COMPLETED” ]
  18.         }
  19.       }
  20.     }
  21.   }
  22. }            
  23.
/jobs/:jobid/metrics
Verb: GETResponse code: 200 OK
Provides access to job metrics.
Path parameters
  • jobid - 32-character hexadecimal string value that identifies a job.
Query parameters
  • get (optional): Comma-separated list of string values to select specific metrics.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “any”
  4. }            
  5.
/jobs/:jobid/plan
Verb: GETResponse code: 200 OK
Returns the dataflow plan of a job.
Path parameters
  • jobid - 32-character hexadecimal string value that identifies a job.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:JobPlanInfo”,
  5.   “properties” : {
  6.     “plan” : {
  7.       “type” : “any”
  8.     }
  9.   }
  10. }            
  11.
/jobs/:jobid/rescaling
Verb: PATCHResponse code: 200 OK
Triggers the rescaling of a job. This async operation would return a ‘triggerid’ for further query identifier.
Path parameters
  • jobid - 32-character hexadecimal string value that identifies a job.
Query parameters
  • parallelism (mandatory): Positive integer value that specifies the desired parallelism.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:handler:async:TriggerResponse”,
  5.   “properties” : {
  6.     “request-id” : {
  7.       “type” : “any”
  8.     }
  9.   }
  10. }            
  11.
/jobs/:jobid/rescaling/:triggerid
Verb: GETResponse code: 200 OK
Returns the status of a rescaling operation.
Path parameters
  • jobid - 32-character hexadecimal string value that identifies a job.
  • triggerid - 32-character hexadecimal string that identifies an asynchronous operation trigger ID. The ID was returned then the operation was triggered.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:handler:async:AsynchronousOperationResult”,
  5.   “properties” : {
  6.     “operation” : {
  7.       “type” : “object”,
  8.       “id” : “urn:jsonschema:org:apache:flink:runtime:rest:handler:async:AsynchronousOperationInfo”,
  9.       “properties” : {
  10.         “failure-cause” : {
  11.           “type” : “any”
  12.         }
  13.       }
  14.     },
  15.     “status” : {
  16.       “type” : “object”,
  17.       “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:queue:QueueStatus”,
  18.       “properties” : {
  19.         “id” : {
  20.           “type” : “string”,
  21.           “required” : true,
  22.           “enum” : [ “IN_PROGRESS”, “COMPLETED” ]
  23.         }
  24.       }
  25.     }
  26.   }
  27. }            
  28.
/jobs/:jobid/savepoints
Verb: POSTResponse code: 202 Accepted
Triggers a savepoint, and optionally cancels the job afterwards. This async operation would return a ‘triggerid’ for further query identifier.
Path parameters
  • jobid - 32-character hexadecimal string value that identifies a job.
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:job:savepoints:SavepointTriggerRequestBody”,
  5.   “properties” : {
  6.     “cancel-job” : {
  7.       “type” : “boolean”
  8.     },
  9.     “target-directory” : {
  10.       “type” : “string”
  11.     }
  12.   }
  13. }            
  14.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:handler:async:TriggerResponse”,
  5.   “properties” : {
  6.     “request-id” : {
  7.       “type” : “any”
  8.     }
  9.   }
  10. }            
  11.
/jobs/:jobid/savepoints/:triggerid
Verb: GETResponse code: 200 OK
Returns the status of a savepoint operation.
Path parameters
  • jobid - 32-character hexadecimal string value that identifies a job.
  • triggerid - 32-character hexadecimal string that identifies an asynchronous operation trigger ID. The ID was returned then the operation was triggered.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:handler:async:AsynchronousOperationResult”,
  5.   “properties” : {
  6.     “operation” : {
  7.       “type” : “object”,
  8.       “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:job:savepoints:SavepointInfo”,
  9.       “properties” : {
  10.         “failure-cause” : {
  11.           “type” : “any”
  12.         },
  13.         “location” : {
  14.           “type” : “string”
  15.         }
  16.       }
  17.     },
  18.     “status” : {
  19.       “type” : “object”,
  20.       “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:queue:QueueStatus”,
  21.       “properties” : {
  22.         “id” : {
  23.           “type” : “string”,
  24.           “required” : true,
  25.           “enum” : [ “IN_PROGRESS”, “COMPLETED” ]
  26.         }
  27.       }
  28.     }
  29.   }
  30. }            
  31.
/jobs/:jobid/stop
Verb: POSTResponse code: 202 Accepted
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.
Path parameters
  • jobid - 32-character hexadecimal string value that identifies a job.
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:job:savepoints:stop:StopWithSavepointRequestBody”,
  5.   “properties” : {
  6.     “drain” : {
  7.       “type” : “boolean”
  8.     },
  9.     “targetDirectory” : {
  10.       “type” : “string”
  11.     }
  12.   }
  13. }            
  14.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:handler:async:TriggerResponse”,
  5.   “properties” : {
  6.     “request-id” : {
  7.       “type” : “any”
  8.     }
  9.   }
  10. }            
  11.
/jobs/:jobid/vertices/:vertexid
Verb: GETResponse code: 200 OK
Returns details for a task, with a summary for each of its subtasks.
Path parameters
  • jobid - 32-character hexadecimal string value that identifies a job.
  • vertexid - 32-character hexadecimal string value that identifies a job vertex.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexDetailsInfo”,
  5.   “properties” : {
  6.     “id” : {
  7.       “type” : “any”
  8.     },
  9.     “name” : {
  10.       “type” : “string”
  11.     },
  12.     “now” : {
  13.       “type” : “integer”
  14.     },
  15.     “parallelism” : {
  16.       “type” : “integer”
  17.     },
  18.     “subtasks” : {
  19.       “type” : “array”,
  20.       “items” : {
  21.         “type” : “object”,
  22.         “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtaskExecutionAttemptDetailsInfo”,
  23.         “properties” : {
  24.           “attempt” : {
  25.             “type” : “integer”
  26.           },
  27.           “duration” : {
  28.             “type” : “integer”
  29.           },
  30.           “end-time” : {
  31.             “type” : “integer”
  32.           },
  33.           “host” : {
  34.             “type” : “string”
  35.           },
  36.           “metrics” : {
  37.             “type” : “object”,
  38.             “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:IOMetricsInfo”,
  39.             “properties” : {
  40.               “read-bytes” : {
  41.                 “type” : “integer”
  42.               },
  43.               “read-bytes-complete” : {
  44.                 “type” : “boolean”
  45.               },
  46.               “read-records” : {
  47.                 “type” : “integer”
  48.               },
  49.               “read-records-complete” : {
  50.                 “type” : “boolean”
  51.               },
  52.               “write-bytes” : {
  53.                 “type” : “integer”
  54.               },
  55.               “write-bytes-complete” : {
  56.                 “type” : “boolean”
  57.               },
  58.               “write-records” : {
  59.                 “type” : “integer”
  60.               },
  61.               “write-records-complete” : {
  62.                 “type” : “boolean”
  63.               }
  64.             }
  65.           },
  66.           “start-time” : {
  67.             “type” : “integer”
  68.           },
  69.           “start_time” : {
  70.             “type” : “integer”
  71.           },
  72.           “status” : {
  73.             “type” : “string”,
  74.             “enum” : [ “CREATED”, “SCHEDULED”, “DEPLOYING”, “RUNNING”, “FINISHED”, “CANCELING”, “CANCELED”, “FAILED”, “RECONCILING” ]
  75.           },
  76.           “subtask” : {
  77.             “type” : “integer”
  78.           },
  79.           “taskmanager-id” : {
  80.             “type” : “string”
  81.           }
  82.         }
  83.       }
  84.     }
  85.   }
  86. }            
  87.
/jobs/:jobid/vertices/:vertexid/accumulators
Verb: GETResponse code: 200 OK
Returns user-defined accumulators of a task, aggregated across all subtasks.
Path parameters
  • jobid - 32-character hexadecimal string value that identifies a job.
  • vertexid - 32-character hexadecimal string value that identifies a job vertex.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexAccumulatorsInfo”,
  5.   “properties” : {
  6.     “id” : {
  7.       “type” : “string”
  8.     },
  9.     “user-accumulators” : {
  10.       “type” : “array”,
  11.       “items” : {
  12.         “type” : “object”,
  13.         “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:job:UserAccumulator”,
  14.         “properties” : {
  15.           “name” : {
  16.             “type” : “string”
  17.           },
  18.           “type” : {
  19.             “type” : “string”
  20.           },
  21.           “value” : {
  22.             “type” : “string”
  23.           }
  24.         }
  25.       }
  26.     }
  27.   }
  28. }            
  29.
/jobs/:jobid/vertices/:vertexid/backpressure
Verb: GETResponse code: 200 OK
Returns back-pressure information for a job, and may initiate back-pressure sampling if necessary.
Path parameters
  • jobid - 32-character hexadecimal string value that identifies a job.
  • vertexid - 32-character hexadecimal string value that identifies a job vertex.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexBackPressureInfo”,
  5.   “properties” : {
  6.     “backpressure-level” : {
  7.       “type” : “string”,
  8.       “enum” : [ “ok”, “low”, “high” ]
  9.     },
  10.     “end-timestamp” : {
  11.       “type” : “integer”
  12.     },
  13.     “status” : {
  14.       “type” : “string”,
  15.       “enum” : [ “deprecated”, “ok” ]
  16.     },
  17.     “subtasks” : {
  18.       “type” : “array”,
  19.       “items” : {
  20.         “type” : “object”,
  21.         “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexBackPressureInfo:SubtaskBackPressureInfo”,
  22.         “properties” : {
  23.           “backpressure-level” : {
  24.             “type” : “string”,
  25.             “enum” : [ “ok”, “low”, “high” ]
  26.           },
  27.           “ratio” : {
  28.             “type” : “number”
  29.           },
  30.           “subtask” : {
  31.             “type” : “integer”
  32.           }
  33.         }
  34.       }
  35.     }
  36.   }
  37. }            
  38.
/jobs/:jobid/vertices/:vertexid/metrics
Verb: GETResponse code: 200 OK
Provides access to task metrics.
Path parameters
  • jobid - 32-character hexadecimal string value that identifies a job.
  • vertexid - 32-character hexadecimal string value that identifies a job vertex.
Query parameters
  • get (optional): Comma-separated list of string values to select specific metrics.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “any”
  4. }            
  5.
/jobs/:jobid/vertices/:vertexid/subtasks/accumulators
Verb: GETResponse code: 200 OK
Returns all user-defined accumulators for all subtasks of a task.
Path parameters
  • jobid - 32-character hexadecimal string value that identifies a job.
  • vertexid - 32-character hexadecimal string value that identifies a job vertex.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtasksAllAccumulatorsInfo”,
  5.   “properties” : {
  6.     “id” : {
  7.       “type” : “any”
  8.     },
  9.     “parallelism” : {
  10.       “type” : “integer”
  11.     },
  12.     “subtasks” : {
  13.       “type” : “array”,
  14.       “items” : {
  15.         “type” : “object”,
  16.         “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtasksAllAccumulatorsInfo:SubtaskAccumulatorsInfo”,
  17.         “properties” : {
  18.           “attempt” : {
  19.             “type” : “integer”
  20.           },
  21.           “host” : {
  22.             “type” : “string”
  23.           },
  24.           “subtask” : {
  25.             “type” : “integer”
  26.           },
  27.           “user-accumulators” : {
  28.             “type” : “array”,
  29.             “items” : {
  30.               “type” : “object”,
  31.               “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:job:UserAccumulator”,
  32.               “properties” : {
  33.                 “name” : {
  34.                   “type” : “string”
  35.                 },
  36.                 “type” : {
  37.                   “type” : “string”
  38.                 },
  39.                 “value” : {
  40.                   “type” : “string”
  41.                 }
  42.               }
  43.             }
  44.           }
  45.         }
  46.       }
  47.     }
  48.   }
  49. }            
  50.
/jobs/:jobid/vertices/:vertexid/subtasks/metrics
Verb: GETResponse code: 200 OK
Provides access to aggregated subtask metrics.
Path parameters
  • jobid - 32-character hexadecimal string value that identifies a job.
  • vertexid - 32-character hexadecimal string value that identifies a job vertex.
Query parameters
  • get (optional): Comma-separated list of string values to select specific metrics.
  • agg (optional): Comma-separated list of aggregation modes which should be calculated. Available aggregations are: “min, max, sum, avg”.
  • subtasks (optional): Comma-separated list of integer ranges (e.g. “1,3,5-9”) to select specific subtasks.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “any”
  4. }            
  5.
/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex
Verb: GETResponse code: 200 OK
Returns details of the current or latest execution attempt of a subtask.
Path parameters
  • jobid - 32-character hexadecimal string value that identifies a job.
  • vertexid - 32-character hexadecimal string value that identifies a job vertex.
  • subtaskindex - Positive integer value that identifies a subtask.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtaskExecutionAttemptDetailsInfo”,
  5.   “properties” : {
  6.     “attempt” : {
  7.       “type” : “integer”
  8.     },
  9.     “duration” : {
  10.       “type” : “integer”
  11.     },
  12.     “end-time” : {
  13.       “type” : “integer”
  14.     },
  15.     “host” : {
  16.       “type” : “string”
  17.     },
  18.     “metrics” : {
  19.       “type” : “object”,
  20.       “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:IOMetricsInfo”,
  21.       “properties” : {
  22.         “read-bytes” : {
  23.           “type” : “integer”
  24.         },
  25.         “read-bytes-complete” : {
  26.           “type” : “boolean”
  27.         },
  28.         “read-records” : {
  29.           “type” : “integer”
  30.         },
  31.         “read-records-complete” : {
  32.           “type” : “boolean”
  33.         },
  34.         “write-bytes” : {
  35.           “type” : “integer”
  36.         },
  37.         “write-bytes-complete” : {
  38.           “type” : “boolean”
  39.         },
  40.         “write-records” : {
  41.           “type” : “integer”
  42.         },
  43.         “write-records-complete” : {
  44.           “type” : “boolean”
  45.         }
  46.       }
  47.     },
  48.     “start-time” : {
  49.       “type” : “integer”
  50.     },
  51.     “start_time” : {
  52.       “type” : “integer”
  53.     },
  54.     “status” : {
  55.       “type” : “string”,
  56.       “enum” : [ “CREATED”, “SCHEDULED”, “DEPLOYING”, “RUNNING”, “FINISHED”, “CANCELING”, “CANCELED”, “FAILED”, “RECONCILING” ]
  57.     },
  58.     “subtask” : {
  59.       “type” : “integer”
  60.     },
  61.     “taskmanager-id” : {
  62.       “type” : “string”
  63.     }
  64.   }
  65. }            
  66.
/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex/attempts/:attempt
Verb: GETResponse code: 200 OK
Returns details of an execution attempt of a subtask. Multiple execution attempts happen in case of failure/recovery.
Path parameters
  • jobid - 32-character hexadecimal string value that identifies a job.
  • vertexid - 32-character hexadecimal string value that identifies a job vertex.
  • subtaskindex - Positive integer value that identifies a subtask.
  • attempt - Positive integer value that identifies an execution attempt.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtaskExecutionAttemptDetailsInfo”,
  5.   “properties” : {
  6.     “attempt” : {
  7.       “type” : “integer”
  8.     },
  9.     “duration” : {
  10.       “type” : “integer”
  11.     },
  12.     “end-time” : {
  13.       “type” : “integer”
  14.     },
  15.     “host” : {
  16.       “type” : “string”
  17.     },
  18.     “metrics” : {
  19.       “type” : “object”,
  20.       “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:IOMetricsInfo”,
  21.       “properties” : {
  22.         “read-bytes” : {
  23.           “type” : “integer”
  24.         },
  25.         “read-bytes-complete” : {
  26.           “type” : “boolean”
  27.         },
  28.         “read-records” : {
  29.           “type” : “integer”
  30.         },
  31.         “read-records-complete” : {
  32.           “type” : “boolean”
  33.         },
  34.         “write-bytes” : {
  35.           “type” : “integer”
  36.         },
  37.         “write-bytes-complete” : {
  38.           “type” : “boolean”
  39.         },
  40.         “write-records” : {
  41.           “type” : “integer”
  42.         },
  43.         “write-records-complete” : {
  44.           “type” : “boolean”
  45.         }
  46.       }
  47.     },
  48.     “start-time” : {
  49.       “type” : “integer”
  50.     },
  51.     “start_time” : {
  52.       “type” : “integer”
  53.     },
  54.     “status” : {
  55.       “type” : “string”,
  56.       “enum” : [ “CREATED”, “SCHEDULED”, “DEPLOYING”, “RUNNING”, “FINISHED”, “CANCELING”, “CANCELED”, “FAILED”, “RECONCILING” ]
  57.     },
  58.     “subtask” : {
  59.       “type” : “integer”
  60.     },
  61.     “taskmanager-id” : {
  62.       “type” : “string”
  63.     }
  64.   }
  65. }            
  66.
/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex/attempts/:attempt/accumulators
Verb: GETResponse 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 - 32-character hexadecimal string value that identifies a job.
  • vertexid - 32-character hexadecimal string value that identifies a job vertex.
  • subtaskindex - Positive integer value that identifies a subtask.
  • attempt - Positive integer value that identifies an execution attempt.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtaskExecutionAttemptAccumulatorsInfo”,
  5.   “properties” : {
  6.     “attempt” : {
  7.       “type” : “integer”
  8.     },
  9.     “id” : {
  10.       “type” : “string”
  11.     },
  12.     “subtask” : {
  13.       “type” : “integer”
  14.     },
  15.     “user-accumulators” : {
  16.       “type” : “array”,
  17.       “items” : {
  18.         “type” : “object”,
  19.         “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:job:UserAccumulator”,
  20.         “properties” : {
  21.           “name” : {
  22.             “type” : “string”
  23.           },
  24.           “type” : {
  25.             “type” : “string”
  26.           },
  27.           “value” : {
  28.             “type” : “string”
  29.           }
  30.         }
  31.       }
  32.     }
  33.   }
  34. }            
  35.
/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex/metrics
Verb: GETResponse code: 200 OK
Provides access to subtask metrics.
Path parameters
  • jobid - 32-character hexadecimal string value that identifies a job.
  • vertexid - 32-character hexadecimal string value that identifies a job vertex.
  • subtaskindex - Positive integer value that identifies a subtask.
Query parameters
  • get (optional): Comma-separated list of string values to select specific metrics.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “any”
  4. }            
  5.
/jobs/:jobid/vertices/:vertexid/subtasktimes
Verb: GETResponse code: 200 OK
Returns time-related information for all subtasks of a task.
Path parameters
  • jobid - 32-character hexadecimal string value that identifies a job.
  • vertexid - 32-character hexadecimal string value that identifies a job vertex.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:SubtasksTimesInfo”,
  5.   “properties” : {
  6.     “id” : {
  7.       “type” : “string”
  8.     },
  9.     “name” : {
  10.       “type” : “string”
  11.     },
  12.     “now” : {
  13.       “type” : “integer”
  14.     },
  15.     “subtasks” : {
  16.       “type” : “array”,
  17.       “items” : {
  18.         “type” : “object”,
  19.         “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:SubtasksTimesInfo:SubtaskTimeInfo”,
  20.         “properties” : {
  21.           “duration” : {
  22.             “type” : “integer”
  23.           },
  24.           “host” : {
  25.             “type” : “string”
  26.           },
  27.           “subtask” : {
  28.             “type” : “integer”
  29.           },
  30.           “timestamps” : {
  31.             “type” : “object”,
  32.             “additionalProperties” : {
  33.               “type” : “integer”
  34.             }
  35.           }
  36.         }
  37.       }
  38.     }
  39.   }
  40. }            
  41.
/jobs/:jobid/vertices/:vertexid/taskmanagers
Verb: GETResponse code: 200 OK
Returns task information aggregated by task manager.
Path parameters
  • jobid - 32-character hexadecimal string value that identifies a job.
  • vertexid - 32-character hexadecimal string value that identifies a job vertex.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexTaskManagersInfo”,
  5.   “properties” : {
  6.     “id” : {
  7.       “type” : “any”
  8.     },
  9.     “name” : {
  10.       “type” : “string”
  11.     },
  12.     “now” : {
  13.       “type” : “integer”
  14.     },
  15.     “taskmanagers” : {
  16.       “type” : “array”,
  17.       “items” : {
  18.         “type” : “object”,
  19.         “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexTaskManagersInfo:TaskManagersInfo”,
  20.         “properties” : {
  21.           “duration” : {
  22.             “type” : “integer”
  23.           },
  24.           “end-time” : {
  25.             “type” : “integer”
  26.           },
  27.           “host” : {
  28.             “type” : “string”
  29.           },
  30.           “metrics” : {
  31.             “type” : “object”,
  32.             “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:IOMetricsInfo”,
  33.             “properties” : {
  34.               “read-bytes” : {
  35.                 “type” : “integer”
  36.               },
  37.               “read-bytes-complete” : {
  38.                 “type” : “boolean”
  39.               },
  40.               “read-records” : {
  41.                 “type” : “integer”
  42.               },
  43.               “read-records-complete” : {
  44.                 “type” : “boolean”
  45.               },
  46.               “write-bytes” : {
  47.                 “type” : “integer”
  48.               },
  49.               “write-bytes-complete” : {
  50.                 “type” : “boolean”
  51.               },
  52.               “write-records” : {
  53.                 “type” : “integer”
  54.               },
  55.               “write-records-complete” : {
  56.                 “type” : “boolean”
  57.               }
  58.             }
  59.           },
  60.           “start-time” : {
  61.             “type” : “integer”
  62.           },
  63.           “status” : {
  64.             “type” : “string”,
  65.             “enum” : [ “CREATED”, “SCHEDULED”, “DEPLOYING”, “RUNNING”, “FINISHED”, “CANCELING”, “CANCELED”, “FAILED”, “RECONCILING” ]
  66.           },
  67.           “status-counts” : {
  68.             “type” : “object”,
  69.             “additionalProperties” : {
  70.               “type” : “integer”
  71.             }
  72.           },
  73.           “taskmanager-id” : {
  74.             “type” : “string”
  75.           }
  76.         }
  77.       }
  78.     }
  79.   }
  80. }            
  81.
/jobs/:jobid/vertices/:vertexid/watermarks
Verb: GETResponse code: 200 OK
Returns the watermarks for all subtasks of a task.
Path parameters
  • jobid - 32-character hexadecimal string value that identifies a job.
  • vertexid - 32-character hexadecimal string value that identifies a job vertex.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “any”
  4. }            
  5.
/overview
Verb: GETResponse code: 200 OK
Returns an overview over the Flink cluster.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:handler:legacy:messages:ClusterOverviewWithVersion”,
  5.   “properties” : {
  6.     “flink-commit” : {
  7.       “type” : “string”
  8.     },
  9.     “flink-version” : {
  10.       “type” : “string”
  11.     },
  12.     “jobs-cancelled” : {
  13.       “type” : “integer”
  14.     },
  15.     “jobs-failed” : {
  16.       “type” : “integer”
  17.     },
  18.     “jobs-finished” : {
  19.       “type” : “integer”
  20.     },
  21.     “jobs-running” : {
  22.       “type” : “integer”
  23.     },
  24.     “slots-available” : {
  25.       “type” : “integer”
  26.     },
  27.     “slots-total” : {
  28.       “type” : “integer”
  29.     },
  30.     “taskmanagers” : {
  31.       “type” : “integer”
  32.     }
  33.   }
  34. }            
  35.
/savepoint-disposal
Verb: POSTResponse code: 200 OK
Triggers the desposal of a savepoint. This async operation would return a ‘triggerid’ for further query identifier.
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:job:savepoints:SavepointDisposalRequest”,
  5.   “properties” : {
  6.     “savepoint-path” : {
  7.       “type” : “string”
  8.     }
  9.   }
  10. }            
  11.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:handler:async:TriggerResponse”,
  5.   “properties” : {
  6.     “request-id” : {
  7.       “type” : “any”
  8.     }
  9.   }
  10. }            
  11.
/savepoint-disposal/:triggerid
Verb: GETResponse code: 200 OK
Returns the status of a savepoint disposal operation.
Path parameters
  • triggerid - 32-character hexadecimal string that identifies an asynchronous operation trigger ID. The ID was returned then the operation was triggered.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:handler:async:AsynchronousOperationResult”,
  5.   “properties” : {
  6.     “operation” : {
  7.       “type” : “object”,
  8.       “id” : “urn:jsonschema:org:apache:flink:runtime:rest:handler:async:AsynchronousOperationInfo”,
  9.       “properties” : {
  10.         “failure-cause” : {
  11.           “type” : “any”
  12.         }
  13.       }
  14.     },
  15.     “status” : {
  16.       “type” : “object”,
  17.       “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:queue:QueueStatus”,
  18.       “properties” : {
  19.         “id” : {
  20.           “type” : “string”,
  21.           “required” : true,
  22.           “enum” : [ “IN_PROGRESS”, “COMPLETED” ]
  23.         }
  24.       }
  25.     }
  26.   }
  27. }            
  28.
/taskmanagers
Verb: GETResponse code: 200 OK
Returns an overview over all task managers.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagersInfo”,
  5.   “properties” : {
  6.     “taskmanagers” : {
  7.       “type” : “array”,
  8.       “items” : {
  9.         “type” : “object”,
  10.         “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerInfo”,
  11.         “properties” : {
  12.           “dataPort” : {
  13.             “type” : “integer”
  14.           },
  15.           “freeResource” : {
  16.             “type” : “object”,
  17.             “$ref” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:ResourceProfileInfo”
  18.           },
  19.           “freeSlots” : {
  20.             “type” : “integer”
  21.           },
  22.           “hardware” : {
  23.             “type” : “object”,
  24.             “id” : “urn:jsonschema:org:apache:flink:runtime:instance:HardwareDescription”,
  25.             “properties” : {
  26.               “cpuCores” : {
  27.                 “type” : “integer”
  28.               },
  29.               “freeMemory” : {
  30.                 “type” : “integer”
  31.               },
  32.               “managedMemory” : {
  33.                 “type” : “integer”
  34.               },
  35.               “physicalMemory” : {
  36.                 “type” : “integer”
  37.               }
  38.             }
  39.           },
  40.           “id” : {
  41.             “type” : “any”
  42.           },
  43.           “jmxPort” : {
  44.             “type” : “integer”
  45.           },
  46.           “memoryConfiguration” : {
  47.             “type” : “object”,
  48.             “id” : “urn:jsonschema:org:apache:flink:runtime:taskexecutor:TaskExecutorMemoryConfiguration”,
  49.             “properties” : {
  50.               “frameworkHeap” : {
  51.                 “type” : “integer”
  52.               },
  53.               “frameworkOffHeap” : {
  54.                 “type” : “integer”
  55.               },
  56.               “jvmMetaspace” : {
  57.                 “type” : “integer”
  58.               },
  59.               “jvmOverhead” : {
  60.                 “type” : “integer”
  61.               },
  62.               “managedMemory” : {
  63.                 “type” : “integer”
  64.               },
  65.               “networkMemory” : {
  66.                 “type” : “integer”
  67.               },
  68.               “taskHeap” : {
  69.                 “type” : “integer”
  70.               },
  71.               “taskOffHeap” : {
  72.                 “type” : “integer”
  73.               },
  74.               “totalFlinkMemory” : {
  75.                 “type” : “integer”
  76.               },
  77.               “totalProcessMemory” : {
  78.                 “type” : “integer”
  79.               }
  80.             }
  81.           },
  82.           “path” : {
  83.             “type” : “string”
  84.           },
  85.           “slotsNumber” : {
  86.             “type” : “integer”
  87.           },
  88.           “timeSinceLastHeartbeat” : {
  89.             “type” : “integer”
  90.           },
  91.           “totalResource” : {
  92.             “type” : “object”,
  93.             “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:ResourceProfileInfo”,
  94.             “properties” : {
  95.               “cpuCores” : {
  96.                 “type” : “number”
  97.               },
  98.               “extendedResources” : {
  99.                 “type” : “object”,
  100.                 “additionalProperties” : {
  101.                   “type” : “number”
  102.                 }
  103.               },
  104.               “managedMemory” : {
  105.                 “type” : “integer”
  106.               },
  107.               “networkMemory” : {
  108.                 “type” : “integer”
  109.               },
  110.               “taskHeapMemory” : {
  111.                 “type” : “integer”
  112.               },
  113.               “taskOffHeapMemory” : {
  114.                 “type” : “integer”
  115.               }
  116.             }
  117.           }
  118.         }
  119.       }
  120.     }
  121.   }
  122. }            
  123.
/taskmanagers/metrics
Verb: GETResponse code: 200 OK
Provides access to aggregated task manager metrics.
Query parameters
  • get (optional): Comma-separated list of string values to select specific metrics.
  • agg (optional): Comma-separated list of aggregation modes which should be calculated. Available aggregations are: “min, max, sum, avg”.
  • taskmanagers (optional): Comma-separated list of 32-character hexadecimal strings to select specific task managers.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “any”
  4. }            
  5.
/taskmanagers/:taskmanagerid
Verb: GETResponse code: 200 OK
Returns details for a task manager. “metrics.memorySegmentsAvailable” and “metrics.memorySegmentsTotal” are deprecated. Please use “metrics.nettyShuffleMemorySegmentsAvailable” and “metrics.nettyShuffleMemorySegmentsTotal” instead.
Path parameters
  • taskmanagerid - 32-character hexadecimal string that identifies a task manager.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerDetailsInfo”,
  5.   “properties” : {
  6.     “dataPort” : {
  7.       “type” : “integer”
  8.     },
  9.     “freeResource” : {
  10.       “type” : “object”,
  11.       “$ref” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:ResourceProfileInfo”
  12.     },
  13.     “freeSlots” : {
  14.       “type” : “integer”
  15.     },
  16.     “hardware” : {
  17.       “type” : “object”,
  18.       “id” : “urn:jsonschema:org:apache:flink:runtime:instance:HardwareDescription”,
  19.       “properties” : {
  20.         “cpuCores” : {
  21.           “type” : “integer”
  22.         },
  23.         “freeMemory” : {
  24.           “type” : “integer”
  25.         },
  26.         “managedMemory” : {
  27.           “type” : “integer”
  28.         },
  29.         “physicalMemory” : {
  30.           “type” : “integer”
  31.         }
  32.       }
  33.     },
  34.     “id” : {
  35.       “type” : “any”
  36.     },
  37.     “jmxPort” : {
  38.       “type” : “integer”
  39.     },
  40.     “memoryConfiguration” : {
  41.       “type” : “object”,
  42.       “id” : “urn:jsonschema:org:apache:flink:runtime:taskexecutor:TaskExecutorMemoryConfiguration”,
  43.       “properties” : {
  44.         “frameworkHeap” : {
  45.           “type” : “integer”
  46.         },
  47.         “frameworkOffHeap” : {
  48.           “type” : “integer”
  49.         },
  50.         “jvmMetaspace” : {
  51.           “type” : “integer”
  52.         },
  53.         “jvmOverhead” : {
  54.           “type” : “integer”
  55.         },
  56.         “managedMemory” : {
  57.           “type” : “integer”
  58.         },
  59.         “networkMemory” : {
  60.           “type” : “integer”
  61.         },
  62.         “taskHeap” : {
  63.           “type” : “integer”
  64.         },
  65.         “taskOffHeap” : {
  66.           “type” : “integer”
  67.         },
  68.         “totalFlinkMemory” : {
  69.           “type” : “integer”
  70.         },
  71.         “totalProcessMemory” : {
  72.           “type” : “integer”
  73.         }
  74.       }
  75.     },
  76.     “metrics” : {
  77.       “type” : “object”,
  78.       “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerMetricsInfo”,
  79.       “properties” : {
  80.         “directCount” : {
  81.           “type” : “integer”
  82.         },
  83.         “directMax” : {
  84.           “type” : “integer”
  85.         },
  86.         “directUsed” : {
  87.           “type” : “integer”
  88.         },
  89.         “garbageCollectors” : {
  90.           “type” : “array”,
  91.           “items” : {
  92.             “type” : “object”,
  93.             “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerMetricsInfo:GarbageCollectorInfo”,
  94.             “properties” : {
  95.               “count” : {
  96.                 “type” : “integer”
  97.               },
  98.               “name” : {
  99.                 “type” : “string”
  100.               },
  101.               “time” : {
  102.                 “type” : “integer”
  103.               }
  104.             }
  105.           }
  106.         },
  107.         “heapCommitted” : {
  108.           “type” : “integer”
  109.         },
  110.         “heapMax” : {
  111.           “type” : “integer”
  112.         },
  113.         “heapUsed” : {
  114.           “type” : “integer”
  115.         },
  116.         “mappedCount” : {
  117.           “type” : “integer”
  118.         },
  119.         “mappedMax” : {
  120.           “type” : “integer”
  121.         },
  122.         “mappedUsed” : {
  123.           “type” : “integer”
  124.         },
  125.         “memorySegmentsAvailable” : {
  126.           “type” : “integer”
  127.         },
  128.         “memorySegmentsTotal” : {
  129.           “type” : “integer”
  130.         },
  131.         “nettyShuffleMemoryAvailable” : {
  132.           “type” : “integer”
  133.         },
  134.         “nettyShuffleMemorySegmentsAvailable” : {
  135.           “type” : “integer”
  136.         },
  137.         “nettyShuffleMemorySegmentsTotal” : {
  138.           “type” : “integer”
  139.         },
  140.         “nettyShuffleMemorySegmentsUsed” : {
  141.           “type” : “integer”
  142.         },
  143.         “nettyShuffleMemoryTotal” : {
  144.           “type” : “integer”
  145.         },
  146.         “nettyShuffleMemoryUsed” : {
  147.           “type” : “integer”
  148.         },
  149.         “nonHeapCommitted” : {
  150.           “type” : “integer”
  151.         },
  152.         “nonHeapMax” : {
  153.           “type” : “integer”
  154.         },
  155.         “nonHeapUsed” : {
  156.           “type” : “integer”
  157.         }
  158.       }
  159.     },
  160.     “path” : {
  161.       “type” : “string”
  162.     },
  163.     “slotsNumber” : {
  164.       “type” : “integer”
  165.     },
  166.     “timeSinceLastHeartbeat” : {
  167.       “type” : “integer”
  168.     },
  169.     “totalResource” : {
  170.       “type” : “object”,
  171.       “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:ResourceProfileInfo”,
  172.       “properties” : {
  173.         “cpuCores” : {
  174.           “type” : “number”
  175.         },
  176.         “extendedResources” : {
  177.           “type” : “object”,
  178.           “additionalProperties” : {
  179.             “type” : “number”
  180.           }
  181.         },
  182.         “managedMemory” : {
  183.           “type” : “integer”
  184.         },
  185.         “networkMemory” : {
  186.           “type” : “integer”
  187.         },
  188.         “taskHeapMemory” : {
  189.           “type” : “integer”
  190.         },
  191.         “taskOffHeapMemory” : {
  192.           “type” : “integer”
  193.         }
  194.       }
  195.     }
  196.   }
  197. }            
  198.
/taskmanagers/:taskmanagerid/logs
Verb: GETResponse code: 200 OK
Returns the list of log files on a TaskManager.
Path parameters
  • taskmanagerid - 32-character hexadecimal string that identifies a task manager.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:LogListInfo”,
  5.   “properties” : {
  6.     “logs” : {
  7.       “type” : “array”,
  8.       “items” : {
  9.         “type” : “object”,
  10.         “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:LogInfo”,
  11.         “properties” : {
  12.           “name” : {
  13.             “type” : “string”
  14.           },
  15.           “size” : {
  16.             “type” : “integer”
  17.           }
  18.         }
  19.       }
  20.     }
  21.   }
  22. }            
  23.
/taskmanagers/:taskmanagerid/metrics
Verb: GETResponse code: 200 OK
Provides access to task manager metrics.
Path parameters
  • taskmanagerid - 32-character hexadecimal string that identifies a task manager.
Query parameters
  • get (optional): Comma-separated list of string values to select specific metrics.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “any”
  4. }            
  5.
/taskmanagers/:taskmanagerid/thread-dump
Verb: GETResponse code: 200 OK
Returns the thread dump of the requested TaskManager.
Path parameters
  • taskmanagerid - 32-character hexadecimal string that identifies a task manager.
  1.             
  2. {}            
  3.           
  1.             
  2. {
  3.   “type” : “object”,
  4.   “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:ThreadDumpInfo”,
  5.   “properties” : {
  6.     “threadInfos” : {
  7.       “type” : “array”,
  8.       “items” : {
  9.         “type” : “object”,
  10.         “id” : “urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:ThreadDumpInfo:ThreadInfo”,
  11.         “properties” : {
  12.           “stringifiedThreadInfo” : {
  13.             “type” : “string”
  14.           },
  15.           “threadName” : {
  16.             “type” : “string”
  17.           }
  18.         }
  19.       }
  20.     }
  21.   }
  22. }            
  23.