Google Git
Sign in
apache / flink / refs/heads/blink / . / docs / _includes / generated / rest_dispatcher.html
blob: e5e490afe8b4cdcc4ca7abc9e20a9953fdccd283 [file] [log] [blame]
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/cluster</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>DELETE</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Shuts down the cluster</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1674237828">Request</button>
<div id="-1674237828" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1489255004">Response</button>
<div id="-1489255004" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/config</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns the configuration of the WebUI.</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1131337549">Request</button>
<div id="1131337549" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1846075211">Response</button>
<div id="1846075211" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:DashboardConfiguration",
"properties" : {
"refresh-interval" : {
"type" : "integer"
},
"timezone-name" : {
"type" : "string"
},
"timezone-offset" : {
"type" : "integer"
},
"flink-version" : {
"type" : "string"
},
"flink-revision" : {
"type" : "string"
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jars</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns a list of all jars previously uploaded via '/jars/upload'.</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-525177469">Request</button>
<div id="-525177469" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1669843955">Response</button>
<div id="-1669843955" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarListInfo",
"properties" : {
"address" : {
"type" : "string"
},
"files" : {
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarListInfo:JarFileInfo",
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"uploaded" : {
"type" : "integer"
},
"entry" : {
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarListInfo:JarEntryInfo",
"properties" : {
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
}
}
}
}
}
}
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jars/upload</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>POST</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">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'.</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1290030289">Request</button>
<div id="-1290030289" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1132420209">Response</button>
<div id="1132420209" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarUploadResponseBody",
"properties" : {
"filename" : {
"type" : "string"
},
"status" : {
"type" : "string",
"enum" : [ "success" ]
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jars/:jarid</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>DELETE</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Deletes a jar previously uploaded via '/jars/upload'.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jarid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-974639435">Request</button>
<div id="-974639435" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-789656611">Response</button>
<div id="-789656611" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jars/:jarid/plan</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns the dataflow plan of a job contained in a jar previously uploaded via '/jars/upload'.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jarid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">Query parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>entry-class</code> (optional): description</li>
<li><code>parallelism</code> (optional): description</li>
<li><code>program-args</code> (optional): description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-181694384">Request</button>
<div id="-181694384" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1311035100">Response</button>
<div id="1311035100" class="collapse">
<pre>
<code>
{
"type" : "any"
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jars/:jarid/run</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>POST</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Submits a job by running a jar previously uploaded via '/jars/upload'.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jarid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">Query parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>program-args</code> (optional): description</li>
<li><code>entry-class</code> (optional): description</li>
<li><code>parallelism</code> (optional): description</li>
<li><code>allowNonRestoredState</code> (optional): description</li>
<li><code>savepointPath</code> (optional): description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#315035146">Request</button>
<div id="315035146" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarRunRequestBody",
"properties" : {
"entryClass" : {
"type" : "string"
},
"programArgs" : {
"type" : "string"
},
"parallelism" : {
"type" : "integer"
},
"allowNonRestoredState" : {
"type" : "boolean"
},
"savepointPath" : {
"type" : "string"
}
}
} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-914083094">Response</button>
<div id="-914083094" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarRunResponseBody",
"properties" : {
"jobid" : {
"type" : "any"
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobmanager/config</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns the cluster configuration.</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1135512494">Request</button>
<div id="1135512494" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#816073812">Response</button>
<div id="816073812" class="collapse">
<pre>
<code>
{
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:ClusterConfigurationInfoEntry",
"properties" : {
"key" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobmanager/metrics</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Provides access to job manager metrics.</td>
</tr>
<tr>
<td colspan="2">Query parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>get</code> (optional): description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#821119119">Request</button>
<div id="821119119" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1131847480">Response</button>
<div id="1131847480" class="collapse">
<pre>
<code>
{
"type" : "any"
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns an overview over all jobs and their current state.</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-525164511">Request</button>
<div id="-525164511" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-176199833">Response</button>
<div id="-176199833" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:messages:webmonitor:JobIdsWithStatusOverview",
"properties" : {
"jobs" : {
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:messages:webmonitor:JobIdsWithStatusOverview:JobIdWithStatus",
"properties" : {
"id" : {
"type" : "any"
},
"status" : {
"type" : "string",
"enum" : [ "CREATED", "RUNNING", "FAILING", "FAILED", "CANCELLING", "CANCELED", "FINISHED", "RESTARTING", "SUSPENDING", "SUSPENDED", "RECONCILING" ]
}
}
}
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>POST</code></td>
<td class="text-left">Response code: <code>202 Accepted</code></td>
</tr>
<tr>
<td colspan="2">Submits a job. This call is primarily intended to be used by the Flink client. This call expects amultipart/form-data request that consists of file uploads for the serialized JobGraph, jars anddistributed cache artifacts and an attribute named "request"for the JSON payload.</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#972993332">Request</button>
<div id="972993332" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobSubmitRequestBody",
"properties" : {
"jobGraphFileName" : {
"type" : "string"
},
"jobJarFileNames" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1213670870">Response</button>
<div id="-1213670870" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobSubmitResponseBody",
"properties" : {
"jobUrl" : {
"type" : "string"
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/metrics</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Provides access to aggregated job metrics.</td>
</tr>
<tr>
<td colspan="2">Query parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>get</code> (optional): description</li>
<li><code>agg</code> (optional): description</li>
<li><code>jobs</code> (optional): description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-790902571">Request</button>
<div id="-790902571" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#128306770">Response</button>
<div id="128306770" class="collapse">
<pre>
<code>
{
"type" : "any"
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/overview</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns an overview over all jobs.</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-2103612833">Request</button>
<div id="-2103612833" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#2114114357">Response</button>
<div id="2114114357" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:messages:webmonitor:MultipleJobsDetails",
"properties" : {
"jobs" : {
"type" : "array",
"items" : {
"type" : "any"
}
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns details of a job.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1706240260">Request</button>
<div id="1706240260" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#481009572">Response</button>
<div id="481009572" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobDetailsInfo",
"properties" : {
"jid" : {
"type" : "any"
},
"name" : {
"type" : "string"
},
"isStoppable" : {
"type" : "boolean"
},
"state" : {
"type" : "string",
"enum" : [ "CREATED", "RUNNING", "FAILING", "FAILED", "CANCELLING", "CANCELED", "FINISHED", "RESTARTING", "SUSPENDING", "SUSPENDED", "RECONCILING" ]
},
"start-time" : {
"type" : "integer"
},
"end-time" : {
"type" : "integer"
},
"duration" : {
"type" : "integer"
},
"now" : {
"type" : "integer"
},
"timestamps" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer"
}
},
"vertices" : {
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobDetailsInfo:JobVertexDetailsInfo",
"properties" : {
"id" : {
"type" : "any"
},
"name" : {
"type" : "string"
},
"parallelism" : {
"type" : "integer"
},
"status" : {
"type" : "string",
"enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING" ]
},
"start-time" : {
"type" : "integer"
},
"end-time" : {
"type" : "integer"
},
"duration" : {
"type" : "integer"
},
"tasks" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer"
}
},
"metrics" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:IOMetricsInfo",
"properties" : {
"read-bytes" : {
"type" : "integer"
},
"read-bytes-complete" : {
"type" : "boolean"
},
"write-bytes" : {
"type" : "integer"
},
"write-bytes-complete" : {
"type" : "boolean"
},
"read-records" : {
"type" : "integer"
},
"read-records-complete" : {
"type" : "boolean"
},
"write-records" : {
"type" : "integer"
},
"write-records-complete" : {
"type" : "boolean"
},
"buffers-in-pool-usage-max" : {
"type" : "float"
},
"buffers-in-pool-usage-max-complete" : {
"type" : "boolean"
},
"buffers-out-pool-usage-max" : {
"type" : "float"
},
"buffers-out-pool-usage-max-complete" : {
"type" : "boolean"
},
"tps" : {
"type" : "float"
},
"tps-complete" : {
"type" : "boolean"
},
"delay" : {
"type" : "long"
},
"delay-complete" : {
"type" : "boolean"
}
}
}
}
},
"status-counts" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer"
}
},
"plan" : {
"type" : "string"
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>PATCH</code></td>
<td class="text-left">Response code: <code>202 Accepted</code></td>
</tr>
<tr>
<td colspan="2">Terminates a job.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">Query parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>mode</code> (optional): description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1782070774">Request</button>
<div id="1782070774" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1967053598">Response</button>
<div id="1967053598" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/accumulators</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns the accumulators for all tasks of a job, aggregated across the respective subtasks.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">Query parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>includeSerializedValue</code> (optional): description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1713172624">Request</button>
<div id="1713172624" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#2033336224">Response</button>
<div id="2033336224" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobAccumulatorsInfo",
"properties" : {
"job-accumulators" : {
"type" : "array",
"items" : {
"type" : "any"
}
},
"user-task-accumulators" : {
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobAccumulatorsInfo:UserTaskAccumulator",
"properties" : {
"name" : {
"type" : "string"
},
"type" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
},
"serialized-user-task-accumulators" : {
"type" : "object",
"additionalProperties" : {
"type" : "any"
}
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/checkpoints</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns checkpointing statistics for a job.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1935063712">Request</button>
<div id="-1935063712" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1368158030">Response</button>
<div id="-1368158030" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics",
"properties" : {
"counts" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics:Counts",
"properties" : {
"restored" : {
"type" : "integer"
},
"total" : {
"type" : "integer"
},
"in_progress" : {
"type" : "integer"
},
"completed" : {
"type" : "integer"
},
"failed" : {
"type" : "integer"
}
}
},
"summary" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics:Summary",
"properties" : {
"state_size" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics",
"properties" : {
"min" : {
"type" : "integer"
},
"max" : {
"type" : "integer"
},
"avg" : {
"type" : "integer"
}
}
},
"end_to_end_duration" : {
"type" : "object",
"$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics"
},
"alignment_buffered" : {
"type" : "object",
"$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics"
}
}
},
"latest" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics:LatestCheckpoints",
"properties" : {
"completed" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics:CompletedCheckpointStatistics",
"properties" : {
"id" : {
"type" : "integer"
},
"status" : {
"type" : "string",
"enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
},
"is_savepoint" : {
"type" : "boolean"
},
"trigger_timestamp" : {
"type" : "integer"
},
"latest_ack_timestamp" : {
"type" : "integer"
},
"state_size" : {
"type" : "integer"
},
"end_to_end_duration" : {
"type" : "integer"
},
"alignment_buffered" : {
"type" : "integer"
},
"num_subtasks" : {
"type" : "integer"
},
"num_acknowledged_subtasks" : {
"type" : "integer"
},
"tasks" : {
"type" : "object",
"additionalProperties" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatistics",
"properties" : {
"id" : {
"type" : "integer"
},
"status" : {
"type" : "string",
"enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
},
"latest_ack_timestamp" : {
"type" : "integer"
},
"state_size" : {
"type" : "integer"
},
"end_to_end_duration" : {
"type" : "integer"
},
"alignment_buffered" : {
"type" : "integer"
},
"num_subtasks" : {
"type" : "integer"
},
"num_acknowledged_subtasks" : {
"type" : "integer"
}
}
}
},
"external_path" : {
"type" : "string"
},
"discarded" : {
"type" : "boolean"
}
}
},
"savepoint" : {
"type" : "object",
"$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics:CompletedCheckpointStatistics"
},
"failed" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics:FailedCheckpointStatistics",
"properties" : {
"id" : {
"type" : "integer"
},
"status" : {
"type" : "string",
"enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
},
"is_savepoint" : {
"type" : "boolean"
},
"trigger_timestamp" : {
"type" : "integer"
},
"latest_ack_timestamp" : {
"type" : "integer"
},
"state_size" : {
"type" : "integer"
},
"end_to_end_duration" : {
"type" : "integer"
},
"alignment_buffered" : {
"type" : "integer"
},
"num_subtasks" : {
"type" : "integer"
},
"num_acknowledged_subtasks" : {
"type" : "integer"
},
"tasks" : {
"type" : "object",
"additionalProperties" : {
"type" : "object",
"$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatistics"
}
},
"failure_timestamp" : {
"type" : "integer"
},
"failure_message" : {
"type" : "string"
}
}
},
"restored" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics:RestoredCheckpointStatistics",
"properties" : {
"id" : {
"type" : "integer"
},
"restore_timestamp" : {
"type" : "integer"
},
"is_savepoint" : {
"type" : "boolean"
},
"external_path" : {
"type" : "string"
}
}
}
}
},
"history" : {
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics",
"properties" : {
"id" : {
"type" : "integer"
},
"status" : {
"type" : "string",
"enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
},
"is_savepoint" : {
"type" : "boolean"
},
"trigger_timestamp" : {
"type" : "integer"
},
"latest_ack_timestamp" : {
"type" : "integer"
},
"state_size" : {
"type" : "integer"
},
"end_to_end_duration" : {
"type" : "integer"
},
"alignment_buffered" : {
"type" : "integer"
},
"num_subtasks" : {
"type" : "integer"
},
"num_acknowledged_subtasks" : {
"type" : "integer"
},
"tasks" : {
"type" : "object",
"additionalProperties" : {
"type" : "object",
"$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatistics"
}
}
}
}
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/checkpoints/config</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns the checkpointing configuration.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1905242249">Request</button>
<div id="1905242249" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#808099872">Response</button>
<div id="808099872" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointConfigInfo",
"properties" : {
"mode" : {
"type" : "any"
},
"interval" : {
"type" : "integer"
},
"timeout" : {
"type" : "integer"
},
"min_pause" : {
"type" : "integer"
},
"max_concurrent" : {
"type" : "integer"
},
"externalization" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointConfigInfo:ExternalizedCheckpointInfo",
"properties" : {
"enabled" : {
"type" : "boolean"
},
"delete_on_cancellation" : {
"type" : "boolean"
}
}
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/checkpoints/details/:checkpointid</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns details for a checkpoint.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
<li><code>checkpointid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#2082812513">Request</button>
<div id="2082812513" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#59893771">Response</button>
<div id="59893771" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics",
"properties" : {
"id" : {
"type" : "integer"
},
"status" : {
"type" : "string",
"enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
},
"is_savepoint" : {
"type" : "boolean"
},
"trigger_timestamp" : {
"type" : "integer"
},
"latest_ack_timestamp" : {
"type" : "integer"
},
"state_size" : {
"type" : "integer"
},
"end_to_end_duration" : {
"type" : "integer"
},
"alignment_buffered" : {
"type" : "integer"
},
"num_subtasks" : {
"type" : "integer"
},
"num_acknowledged_subtasks" : {
"type" : "integer"
},
"tasks" : {
"type" : "object",
"additionalProperties" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatistics",
"properties" : {
"id" : {
"type" : "integer"
},
"status" : {
"type" : "string",
"enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
},
"latest_ack_timestamp" : {
"type" : "integer"
},
"state_size" : {
"type" : "integer"
},
"end_to_end_duration" : {
"type" : "integer"
},
"alignment_buffered" : {
"type" : "integer"
},
"num_subtasks" : {
"type" : "integer"
},
"num_acknowledged_subtasks" : {
"type" : "integer"
}
}
}
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/checkpoints/details/:checkpointid/subtasks/:vertexid</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns checkpoint statistics for a task and its subtasks.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
<li><code>checkpointid</code> - description</li>
<li><code>vertexid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#206551710">Request</button>
<div id="206551710" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#147094768">Response</button>
<div id="147094768" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatisticsWithSubtaskDetails",
"properties" : {
"id" : {
"type" : "integer"
},
"status" : {
"type" : "string",
"enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
},
"latest_ack_timestamp" : {
"type" : "integer"
},
"state_size" : {
"type" : "integer"
},
"end_to_end_duration" : {
"type" : "integer"
},
"alignment_buffered" : {
"type" : "integer"
},
"num_subtasks" : {
"type" : "integer"
},
"num_acknowledged_subtasks" : {
"type" : "integer"
},
"summary" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatisticsWithSubtaskDetails:Summary",
"properties" : {
"state_size" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics",
"properties" : {
"min" : {
"type" : "integer"
},
"max" : {
"type" : "integer"
},
"avg" : {
"type" : "integer"
}
}
},
"end_to_end_duration" : {
"type" : "object",
"$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics"
},
"checkpoint_duration" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatisticsWithSubtaskDetails:CheckpointDuration",
"properties" : {
"sync" : {
"type" : "object",
"$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics"
},
"async" : {
"type" : "object",
"$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics"
}
}
},
"alignment" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatisticsWithSubtaskDetails:CheckpointAlignment",
"properties" : {
"buffered" : {
"type" : "object",
"$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics"
},
"duration" : {
"type" : "object",
"$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics"
}
}
}
}
},
"subtasks" : {
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:SubtaskCheckpointStatistics",
"properties" : {
"index" : {
"type" : "integer"
},
"status" : {
"type" : "string"
}
}
}
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/config</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns the configuration of a job.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1131490405">Request</button>
<div id="1131490405" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1732781110">Response</button>
<div id="-1732781110" class="collapse">
<pre>
<code>
{
"type" : "any"
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/exceptions</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">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.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1011644505">Request</button>
<div id="-1011644505" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1982519474">Response</button>
<div id="-1982519474" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobExceptionsInfo",
"properties" : {
"root-exception" : {
"type" : "string"
},
"timestamp" : {
"type" : "integer"
},
"all-exceptions" : {
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobExceptionsInfo:ExecutionExceptionInfo",
"properties" : {
"exception" : {
"type" : "string"
},
"task" : {
"type" : "string"
},
"location" : {
"type" : "string"
},
"timestamp" : {
"type" : "integer"
}
}
}
},
"truncated" : {
"type" : "boolean"
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/execution-result</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns the result of a job execution. Gives access to the execution time of the job and to all accumulators created by this job.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1658976043">Request</button>
<div id="-1658976043" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1929690333">Response</button>
<div id="1929690333" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobExecutionResultResponseBody",
"properties" : {
"status" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:queue:QueueStatus",
"required" : true,
"properties" : {
"id" : {
"type" : "string",
"required" : true,
"enum" : [ "IN_PROGRESS", "COMPLETED" ]
}
}
},
"job-execution-result" : {
"type" : "any"
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/metrics</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Provides access to job metrics.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">Query parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>get</code> (optional): description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#696434360">Request</button>
<div id="696434360" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1007162721">Response</button>
<div id="1007162721" class="collapse">
<pre>
<code>
{
"type" : "any"
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/plan</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns the dataflow plan of a job.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1593444876">Request</button>
<div id="1593444876" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1208792936">Response</button>
<div id="-1208792936" class="collapse">
<pre>
<code>
{
"type" : "any"
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/vertices/details</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns the detail contains vertices and operators of a job.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1545980313">Request</button>
<div id="1545980313" class="collapse">
<pre>
<code>
{}
</code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1545980354">Response</button>
<div id="-1545980354" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:messages:webmonitor:JobVerticesInfo",
"properties" : {
"vertices" : {
"type" : "array",
"items" : {
"type" : "any"
}
},
"operators" : {
"type" : "array",
"items" : {
"type" : "any"
}
}
}
}
</code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/taskmanagers</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns an overview over all registered TaskManagers of a job.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1546002630">Request</button>
<div id="1546002630" class="collapse">
<pre>
<code>
{}
</code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1546002645">Response</button>
<div id="-1546002645" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagersInfo",
"properties" : {
"taskmanagers" : {
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerInfo",
"properties" : {
"id" : {
"type" : "any"
},
"path" : {
"type" : "string"
},
"dataPort" : {
"type" : "integer"
},
"timeSinceLastHeartbeat" : {
"type" : "integer"
},
"slotsNumber" : {
"type" : "integer"
},
"freeSlots" : {
"type" : "integer"
},
"hardware" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:instance:HardwareDescription",
"properties" : {
"cpuCores" : {
"type" : "integer"
},
"physicalMemory" : {
"type" : "integer"
},
"freeMemory" : {
"type" : "integer"
},
"managedMemory" : {
"type" : "integer"
}
}
}
}
}
}
}
}
</code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/rescaling</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>PATCH</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Triggers the rescaling of a job.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">Query parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>parallelism</code> (mandatory): description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1066262171">Request</button>
<div id="1066262171" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#436242360">Response</button>
<div id="436242360" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:TriggerResponse",
"properties" : {
"request-id" : {
"type" : "any"
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/pendingslotrequest</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns pending slot resuests for a job.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1547202486">Request</button>
<div id="1547202486" class="collapse">
<pre>
<code>
{}
</code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1547202516">Response</button>
<div id="-1547202516" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobPendingSlotRequestsInfo",
"properties" : {
"taskmanagers" : {
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobPendingSlotRequestDetail",
"properties" : {
"id" : {
"type" : "any"
},
"resource_profile" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:clusterframework:types:ResourceProfile",
"properties" : {
"cpuCores" : {
"type" : "double"
},
"heapMemoryInMB" : {
"type" : "integer"
},
"directMemoryInMB" : {
"type" : "integer"
},
"nativeMemoryInMB" : {
"type" : "integer"
},
"networkMemoryInMB" : {
"type" : "integer"
},
"extendedResources" : {
"type" : "any"
}
}
},
"sharing_id" : {
"type" : "any"
},
"co-location_id" : {
"type" : "any"
},
"tasks" : {
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobPendingSlotRequestDetail:VertexTaskInfo",
"properties" : {
"vertex_id" : {
"type" : "any"
},
"task_name" : {
"type" : "string"
},
"subtask" : {
"type" : "integer"
},
"attempt" : {
"type" : "integer"
}
}
}
}
"start_time" : {
"type" : "integer"
}
}
}
}
}
}
</code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/rescaling/:triggerid</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns the status of a rescaling operation.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
<li><code>triggerid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#879212983">Request</button>
<div id="879212983" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-953870153">Response</button>
<div id="-953870153" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:AsynchronousOperationResult",
"properties" : {
"status" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:queue:QueueStatus",
"properties" : {
"id" : {
"type" : "string",
"required" : true,
"enum" : [ "IN_PROGRESS", "COMPLETED" ]
}
}
},
"operation" : {
"type" : "any"
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/savepoints</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>POST</code></td>
<td class="text-left">Response code: <code>202 Accepted</code></td>
</tr>
<tr>
<td colspan="2">Triggers a savepoint, and optionally cancels the job afterwards.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1876528584">Request</button>
<div id="-1876528584" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:savepoints:SavepointTriggerRequestBody",
"properties" : {
"target-directory" : {
"type" : "string"
},
"cancel-job" : {
"type" : "boolean"
}
}
} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1570291914">Response</button>
<div id="1570291914" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:TriggerResponse",
"properties" : {
"request-id" : {
"type" : "any"
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/savepoints/:triggerid</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns the status of a savepoint operation.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
<li><code>triggerid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1196792611">Request</button>
<div id="-1196792611" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1265091549">Response</button>
<div id="1265091549" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:AsynchronousOperationResult",
"properties" : {
"status" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:queue:QueueStatus",
"properties" : {
"id" : {
"type" : "string",
"required" : true,
"enum" : [ "IN_PROGRESS", "COMPLETED" ]
}
}
},
"operation" : {
"type" : "any"
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/vertices/:vertexid</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns details for a task, with a summary for each of its subtasks.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
<li><code>vertexid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-361288698">Request</button>
<div id="-361288698" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1698651823">Response</button>
<div id="-1698651823" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexDetailsInfo",
"properties" : {
"id" : {
"type" : "any"
},
"name" : {
"type" : "string"
},
"parallelism" : {
"type" : "integer"
},
"now" : {
"type" : "integer"
},
"subtasks" : {
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexDetailsInfo:VertexTaskDetail",
"properties" : {
"subtask" : {
"type" : "integer"
},
"status" : {
"type" : "string",
"enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING" ]
},
"attempt" : {
"type" : "integer"
},
"host" : {
"type" : "string"
},
"start_time" : {
"type" : "integer"
},
"end-time" : {
"type" : "integer"
},
"duration" : {
"type" : "integer"
},
"log-file-name" : {
"type" : "string"
},
"stdout-file-name" : {
"type" : "string"
},
"metrics" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:IOMetricsInfo",
"properties" : {
"read-bytes" : {
"type" : "integer"
},
"read-bytes-complete" : {
"type" : "boolean"
},
"write-bytes" : {
"type" : "integer"
},
"write-bytes-complete" : {
"type" : "boolean"
},
"read-records" : {
"type" : "integer"
},
"read-records-complete" : {
"type" : "boolean"
},
"write-records" : {
"type" : "integer"
},
"write-records-complete" : {
"type" : "boolean"
},
"buffers-in-pool-usage-max" : {
"type" : "float"
},
"buffers-in-pool-usage-max-complete" : {
"type" : "boolean"
},
"buffers-out-pool-usage-max" : {
"type" : "float"
},
"buffers-out-pool-usage-max-complete" : {
"type" : "boolean"
},
"tps" : {
"type" : "float"
},
"tps-complete" : {
"type" : "boolean"
},
"delay" : {
"type" : "long"
},
"delay-complete" : {
"type" : "boolean"
}
}
}
}
}
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/vertices/:vertexid/accumulators</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns user-defined accumulators of a task, aggregated across all subtasks.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
<li><code>vertexid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#485581006">Request</button>
<div id="485581006" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1070353054">Response</button>
<div id="-1070353054" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexAccumulatorsInfo",
"properties" : {
"id" : {
"type" : "string"
},
"user-accumulators" : {
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:UserAccumulator",
"properties" : {
"name" : {
"type" : "string"
},
"type" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/vertices/:vertexid/backpressure</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns back-pressure information for a job, and may initiate back-pressure sampling if necessary.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
<li><code>vertexid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1104577459">Request</button>
<div id="-1104577459" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#870803712">Response</button>
<div id="870803712" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexBackPressureInfo",
"properties" : {
"status" : {
"type" : "string",
"enum" : [ "deprecated", "ok" ]
},
"backpressure-level" : {
"type" : "string",
"enum" : [ "ok", "low", "high" ]
},
"end-timestamp" : {
"type" : "integer"
},
"subtasks" : {
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexBackPressureInfo:SubtaskBackPressureInfo",
"properties" : {
"subtask" : {
"type" : "integer"
},
"backpressure-level" : {
"type" : "string",
"enum" : [ "ok", "low", "high" ]
},
"ratio" : {
"type" : "number"
}
}
}
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/vertices/:vertexid/metrics</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Provides access to task metrics.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
<li><code>vertexid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">Query parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>get</code> (optional): description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1608736838">Request</button>
<div id="-1608736838" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1298008477">Response</button>
<div id="-1298008477" class="collapse">
<pre>
<code>
{
"type" : "any"
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/vertices/:vertexid/subtasks/accumulators</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns all user-defined accumulators for all subtasks of a task.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
<li><code>vertexid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-886388859">Request</button>
<div id="-886388859" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#112317594">Response</button>
<div id="112317594" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtasksAllAccumulatorsInfo",
"properties" : {
"id" : {
"type" : "any"
},
"parallelism" : {
"type" : "integer"
},
"subtasks" : {
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtasksAllAccumulatorsInfo:SubtaskAccumulatorsInfo",
"properties" : {
"subtask" : {
"type" : "integer"
},
"attempt" : {
"type" : "integer"
},
"host" : {
"type" : "string"
},
"user-accumulators" : {
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:UserAccumulator",
"properties" : {
"name" : {
"type" : "string"
},
"type" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
}
}
}
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/vertices/:vertexid/subtasks/metrics</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Provides access to aggregated subtask metrics.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
<li><code>vertexid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">Query parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>get</code> (optional): description</li>
<li><code>agg</code> (optional): description</li>
<li><code>subtasks</code> (optional): description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#265134755">Request</button>
<div id="265134755" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1184344096">Response</button>
<div id="1184344096" class="collapse">
<pre>
<code>
{
"type" : "any"
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns details of the current or latest execution attempt of a subtask.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
<li><code>vertexid</code> - description</li>
<li><code>subtaskindex</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-2021515193">Request</button>
<div id="-2021515193" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#254718090">Response</button>
<div id="254718090" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtaskExecutionAttemptDetailsInfo",
"properties" : {
"subtask" : {
"type" : "integer"
},
"status" : {
"type" : "string",
"enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING" ]
},
"attempt" : {
"type" : "integer"
},
"host" : {
"type" : "string"
},
"start-time" : {
"type" : "integer"
},
"end-time" : {
"type" : "integer"
},
"duration" : {
"type" : "integer"
},
"metrics" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:IOMetricsInfo",
"properties" : {
"read-bytes" : {
"type" : "integer"
},
"read-bytes-complete" : {
"type" : "boolean"
},
"write-bytes" : {
"type" : "integer"
},
"write-bytes-complete" : {
"type" : "boolean"
},
"read-records" : {
"type" : "integer"
},
"read-records-complete" : {
"type" : "boolean"
},
"write-records" : {
"type" : "integer"
},
"write-records-complete" : {
"type" : "boolean"
},
"buffers-in-pool-usage-max" : {
"type" : "float"
},
"buffers-in-pool-usage-max-complete" : {
"type" : "boolean"
},
"buffers-out-pool-usage-max" : {
"type" : "float"
},
"buffers-out-pool-usage-max-complete" : {
"type" : "boolean"
},
"tps" : {
"type" : "float"
},
"tps-complete" : {
"type" : "boolean"
},
"delay" : {
"type" : "long"
},
"delay-complete" : {
"type" : "boolean"
}
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex/attempts/:attempt</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns details of an execution attempt of a subtask. Multiple execution attempts happen in case of failure/recovery.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
<li><code>vertexid</code> - description</li>
<li><code>subtaskindex</code> - description</li>
<li><code>attempt</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#168850740">Request</button>
<div id="168850740" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1849883273">Response</button>
<div id="-1849883273" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtaskExecutionAttemptDetailsInfo",
"properties" : {
"subtask" : {
"type" : "integer"
},
"status" : {
"type" : "string",
"enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING" ]
},
"attempt" : {
"type" : "integer"
},
"host" : {
"type" : "string"
},
"start-time" : {
"type" : "integer"
},
"end-time" : {
"type" : "integer"
},
"duration" : {
"type" : "integer"
},
"metrics" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:IOMetricsInfo",
"properties" : {
"read-bytes" : {
"type" : "integer"
},
"read-bytes-complete" : {
"type" : "boolean"
},
"write-bytes" : {
"type" : "integer"
},
"write-bytes-complete" : {
"type" : "boolean"
},
"read-records" : {
"type" : "integer"
},
"read-records-complete" : {
"type" : "boolean"
},
"write-records" : {
"type" : "integer"
},
"write-records-complete" : {
"type" : "boolean"
},
"buffers-in-pool-usage-max" : {
"type" : "float"
},
"buffers-in-pool-usage-max-complete" : {
"type" : "boolean"
},
"buffers-out-pool-usage-max" : {
"type" : "float"
},
"buffers-out-pool-usage-max-complete" : {
"type" : "boolean"
},
"tps" : {
"type" : "float"
},
"tps-complete" : {
"type" : "boolean"
},
"delay" : {
"type" : "long"
},
"delay-complete" : {
"type" : "boolean"
}
}
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex/attempts/:attempt/accumulators</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns the accumulators of an execution attempt of a subtask. Multiple execution attempts happen in case of failure/recovery.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
<li><code>vertexid</code> - description</li>
<li><code>subtaskindex</code> - description</li>
<li><code>attempt</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1303317920">Request</button>
<div id="-1303317920" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1455274244">Response</button>
<div id="-1455274244" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtaskExecutionAttemptAccumulatorsInfo",
"properties" : {
"subtask" : {
"type" : "integer"
},
"attempt" : {
"type" : "integer"
},
"id" : {
"type" : "string"
},
"user-accumulators" : {
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:UserAccumulator",
"properties" : {
"name" : {
"type" : "string"
},
"type" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex/metrics</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Provides access to subtask metrics.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
<li><code>vertexid</code> - description</li>
<li><code>subtaskindex</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">Query parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>get</code> (optional): description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1918092027">Request</button>
<div id="1918092027" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-2066146908">Response</button>
<div id="-2066146908" class="collapse">
<pre>
<code>
{
"type" : "any"
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/vertices/:vertexid/subtasktimes</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns time-related information for all subtasks of a task.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
<li><code>vertexid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1307377346">Request</button>
<div id="1307377346" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#285340640">Response</button>
<div id="285340640" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:SubtasksTimesInfo",
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"now" : {
"type" : "integer"
},
"subtasks" : {
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:SubtasksTimesInfo:SubtaskTimeInfo",
"properties" : {
"subtask" : {
"type" : "integer"
},
"host" : {
"type" : "string"
},
"duration" : {
"type" : "integer"
},
"timestamps" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer"
}
}
}
}
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/vertices/:vertexid/taskmanagers</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns task information aggregated by task manager.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
<li><code>vertexid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-525795572">Request</button>
<div id="-525795572" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1406727934">Response</button>
<div id="1406727934" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexTaskManagersInfo",
"properties" : {
"id" : {
"type" : "any"
},
"name" : {
"type" : "string"
},
"now" : {
"type" : "integer"
},
"taskmanagers" : {
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexTaskManagersInfo:TaskManagersInfo",
"properties" : {
"host" : {
"type" : "string"
},
"status" : {
"type" : "string",
"enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING" ]
},
"start-time" : {
"type" : "integer"
},
"end-time" : {
"type" : "integer"
},
"duration" : {
"type" : "integer"
},
"metrics" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:IOMetricsInfo",
"properties" : {
"read-bytes" : {
"type" : "integer"
},
"read-bytes-complete" : {
"type" : "boolean"
},
"write-bytes" : {
"type" : "integer"
},
"write-bytes-complete" : {
"type" : "boolean"
},
"read-records" : {
"type" : "integer"
},
"read-records-complete" : {
"type" : "boolean"
},
"write-records" : {
"type" : "integer"
},
"write-records-complete" : {
"type" : "boolean"
},
"buffers-in-pool-usage-max" : {
"type" : "float"
},
"buffers-in-pool-usage-max-complete" : {
"type" : "boolean"
},
"buffers-out-pool-usage-max" : {
"type" : "float"
},
"buffers-out-pool-usage-max-complete" : {
"type" : "boolean"
},
"tps" : {
"type" : "float"
},
"tps-complete" : {
"type" : "boolean"
},
"delay" : {
"type" : "long"
},
"delay-complete" : {
"type" : "boolean"
}
}
},
"status-counts" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer"
}
}
}
}
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/jobs/:jobid/vertices/::vertexid/subtasks/:subtaskindex/attempts</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Request handler providing details about all execution attempts of a subtask.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - description</li>
<li><code>vertexid</code> - description</li>
<li><code>subtaskindex</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1546002537">Request</button>
<div id="1546002537" class="collapse">
<pre>
<code>
{}
</code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1546002549">Response</button>
<div id="-1546002549" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:messages:webmonitor:SubtaskExecutionAllAttemptsInfo",
"properties" : {
"attempts" : {
"type" : "array",
"items" : {
"type" : "any"
}
}
}
}
}
</code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/overview</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns an overview over the Flink cluster.</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#907264452">Request</button>
<div id="907264452" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1156936926">Response</button>
<div id="1156936926" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:legacy:messages:ClusterOverviewWithVersion",
"properties" : {
"taskmanagers" : {
"type" : "integer"
},
"slots-total" : {
"type" : "integer"
},
"slots-available" : {
"type" : "integer"
},
"jobs-running" : {
"type" : "integer"
},
"jobs-finished" : {
"type" : "integer"
},
"jobs-cancelled" : {
"type" : "integer"
},
"jobs-failed" : {
"type" : "integer"
},
"flink-version" : {
"type" : "string"
},
"flink-commit" : {
"type" : "string"
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/savepoint-disposal</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>POST</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Triggers the desposal of a savepoint.</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#969125696">Request</button>
<div id="969125696" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:savepoints:SavepointDisposalRequest",
"properties" : {
"savepoint-path" : {
"type" : "string"
}
}
} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-171672547">Response</button>
<div id="-171672547" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:TriggerResponse",
"properties" : {
"request-id" : {
"type" : "any"
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/savepoint-disposal/:triggerid</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns the status of a savepoint disposal operation.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>triggerid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#704931754">Request</button>
<div id="704931754" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1128151382">Response</button>
<div id="-1128151382" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:AsynchronousOperationResult",
"properties" : {
"status" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:queue:QueueStatus",
"properties" : {
"id" : {
"type" : "string",
"required" : true,
"enum" : [ "IN_PROGRESS", "COMPLETED" ]
}
}
},
"operation" : {
"type" : "any"
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/taskmanagers</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns an overview over all task managers.</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1276144566">Request</button>
<div id="1276144566" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-112101263">Response</button>
<div id="-112101263" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagersInfo",
"properties" : {
"taskmanagers" : {
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerInfo",
"properties" : {
"id" : {
"type" : "any"
},
"path" : {
"type" : "string"
},
"dataPort" : {
"type" : "integer"
},
"timeSinceLastHeartbeat" : {
"type" : "integer"
},
"slotsNumber" : {
"type" : "integer"
},
"freeSlots" : {
"type" : "integer"
},
"hardware" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:instance:HardwareDescription",
"properties" : {
"cpuCores" : {
"type" : "integer"
},
"physicalMemory" : {
"type" : "integer"
},
"freeMemory" : {
"type" : "integer"
},
"managedMemory" : {
"type" : "integer"
}
}
}
}
}
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/taskmanagers/metrics</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Provides access to aggregated task manager metrics.</td>
</tr>
<tr>
<td colspan="2">Query parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>get</code> (optional): description</li>
<li><code>agg</code> (optional): description</li>
<li><code>taskmanagers</code> (optional): description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#521351018">Request</button>
<div id="521351018" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1440560359">Response</button>
<div id="1440560359" class="collapse">
<pre>
<code>
{
"type" : "any"
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/taskmanagers/:taskmanagerid</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns details for a task manager.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>taskmanagerid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1279146202">Request</button>
<div id="1279146202" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#761739204">Response</button>
<div id="761739204" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerDetailsInfo",
"properties" : {
"id" : {
"type" : "any"
},
"path" : {
"type" : "string"
},
"dataPort" : {
"type" : "integer"
},
"timeSinceLastHeartbeat" : {
"type" : "integer"
},
"slotsNumber" : {
"type" : "integer"
},
"freeSlots" : {
"type" : "integer"
},
"hardware" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:instance:HardwareDescription",
"properties" : {
"cpuCores" : {
"type" : "integer"
},
"physicalMemory" : {
"type" : "integer"
},
"freeMemory" : {
"type" : "integer"
},
"managedMemory" : {
"type" : "integer"
}
}
},
"metrics" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerMetricsInfo",
"properties" : {
"heapUsed" : {
"type" : "integer"
},
"heapCommitted" : {
"type" : "integer"
},
"heapMax" : {
"type" : "integer"
},
"nonHeapUsed" : {
"type" : "integer"
},
"nonHeapCommitted" : {
"type" : "integer"
},
"nonHeapMax" : {
"type" : "integer"
},
"directCount" : {
"type" : "integer"
},
"directUsed" : {
"type" : "integer"
},
"directMax" : {
"type" : "integer"
},
"mappedCount" : {
"type" : "integer"
},
"mappedUsed" : {
"type" : "integer"
},
"mappedMax" : {
"type" : "integer"
},
"memorySegmentsAvailable" : {
"type" : "integer"
},
"memorySegmentsTotal" : {
"type" : "integer"
},
"garbageCollectors" : {
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerMetricsInfo:GarbageCollectorInfo",
"properties" : {
"name" : {
"type" : "string"
},
"count" : {
"type" : "integer"
},
"time" : {
"type" : "integer"
}
}
}
}
}
}
}
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/taskmanagers/:taskmanagerid/metrics</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Provides access to task manager metrics.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>taskmanagerid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">Query parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>get</code> (optional): description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1220778126">Request</button>
<div id="1220778126" class="collapse">
<pre>
<code>
{} </code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1531506487">Response</button>
<div id="1531506487" class="collapse">
<pre>
<code>
{
"type" : "any"
} </code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/taskmanagers/:taskmanagerid/log/:filename?start={start}&count={count}</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns file content and length of a file in taskmanager log dir.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>taskmanagerid</code> - description</li>
<li><code>filename</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">Query parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>start</code> - description file read start postion</li>
<li><code>count</code> - description file read size</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1546002248">Request</button>
<div id="1546002248" class="collapse">
<pre>
<code>
{}
</code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1546002271">Response</button>
<div id="-1546002271" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:messages:webmonitor:LogDetail",
"properties" : {
"data" : {
"type" : "string"
},
"data" : {
"file_size" : "Long",
}
}
}
}
}
</code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><strong>/taskmanagers/:taskmanagerid/logs</strong></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns file list in log dir of a taskmanager.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>taskmanagerid</code> - description</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#1546002405">Request</button>
<div id="1546002405" class="collapse">
<pre>
<code>
{}
</code>
</pre>
</div>
</td>
</tr>
<tr>
<td colspan="2">
<button data-toggle="collapse" data-target="#-1546002426">Response</button>
<div id="-1546002426" class="collapse">
<pre>
<code>
{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:messages:webmonitor:LogsInfo",
"properties" : {
"logs" : {
"type" : "array",
"items" : {
"type" : "any"
}
}
}
}
}
</code>
</pre>
</div>
</td>
</tr>
</tbody>
</table>