Skip to content

[FLINK-38893][runtime/rest] Introduce the /jobs/:jobid/rescales/overview endpoint in the REST API #27891

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RocMarshal wants to merge 1 commit into
base: master
Choose a base branch
from
+1,054 −0
Open

[FLINK-38893][runtime/rest] Introduce the /jobs/:jobid/rescales/overview endpoint in the REST API #27891

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
227 changes: 227 additions & 0 deletions docs/layouts/shortcodes/generated/rest_v1_dispatcher.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4025,6 +4025,233 @@
</tr>
</tbody>
</table>
<table class="rest-api table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/rescales/overview</strong></h5></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">Return job rescales overview.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<label>
<details>
<summary>Request</summary>
<pre><code>{}</code></pre>
</label>
</td>
</tr>
<tr>
<td colspan="2">
<label>
<details>
<summary>Response</summary>
<pre><code>{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:rescales:JobRescalesOverview",
"properties" : {
"latest" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:rescales:JobRescalesOverview:LatestRescales",
"properties" : {
"completed" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:rescales:JobRescaleDetails",
"properties" : {
"endTimestampInMillis" : {
"type" : "integer"
},
"rescaleAttemptId" : {
"type" : "integer"
},
"rescaleUuid" : {
"type" : "string"
},
"resourceRequirementsUuid" : {
"type" : "string"
},
"schedulerStates" : {
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:rescales:SchedulerStateSpan",
"properties" : {
"durationInMillis" : {
"type" : "integer"
},
"enterTimestampInMillis" : {
"type" : "integer"
},
"leaveTimestampInMillis" : {
"type" : "integer"
},
"state" : {
"type" : "string"
},
"stringifiedException" : {
"type" : "string"
}
}
}
},
"slots" : {
"type" : "object",
"additionalProperties" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:rescales:JobRescaleDetails:SlotSharingGroupRescaleInfo",
"properties" : {
"acquiredResourceProfile" : {
"type" : "object",
"$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:ResourceProfileInfo"
},
"desiredSlots" : {
"type" : "integer"
},
"minimalRequiredSlots" : {
"type" : "integer"
},
"postRescaleSlots" : {
"type" : "integer"
},
"preRescaleSlots" : {
"type" : "integer"
},
"requestResourceProfile" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:ResourceProfileInfo",
"properties" : {
"cpuCores" : {
"type" : "number"
},
"extendedResources" : {
"type" : "object",
"additionalProperties" : {
"type" : "number"
}
},
"managedMemory" : {
"type" : "integer"
},
"networkMemory" : {
"type" : "integer"
},
"taskHeapMemory" : {
"type" : "integer"
},
"taskOffHeapMemory" : {
"type" : "integer"
}
}
},
"slotSharingGroupId" : {
"type" : "any"
},
"slotSharingGroupName" : {
"type" : "string"
}
}
}
},
"startTimestampInMillis" : {
"type" : "integer"
},
"terminalState" : {
"type" : "string",
"enum" : [ "COMPLETED", "FAILED", "IGNORED" ]
},
"terminatedReason" : {
"type" : "string",
"enum" : [ "SUCCEEDED", "EXCEPTION_OCCURRED", "RESOURCE_REQUIREMENTS_UPDATED", "NO_RESOURCES_OR_PARALLELISMS_CHANGE", "JOB_FINISHED", "JOB_FAILED", "JOB_CANCELED", "JOB_FAILOVER_RESTARTING" ]
},
"triggerCause" : {
"type" : "string",
"enum" : [ "INITIAL_SCHEDULE", "UPDATE_REQUIREMENT", "NEW_RESOURCE_AVAILABLE", "RECOVERABLE_FAILOVER" ]
},
"vertices" : {
"type" : "object",
"additionalProperties" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:rescales:JobRescaleDetails:VertexParallelismRescaleInfo",
"properties" : {
"desiredParallelism" : {
"type" : "integer"
},
"jobVertexId" : {
"type" : "any"
},
"jobVertexName" : {
"type" : "string"
},
"postRescaleParallelism" : {
"type" : "integer"
},
"preRescaleParallelism" : {
"type" : "integer"
},
"slotSharingGroupId" : {
"type" : "any"
},
"slotSharingGroupName" : {
"type" : "string"
},
"sufficientParallelism" : {
"type" : "integer"
}
}
}
}
}
},
"failed" : {
"type" : "object",
"$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:rescales:JobRescaleDetails"
},
"ignored" : {
"type" : "object",
"$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:rescales:JobRescaleDetails"
}
}
},
"rescalesCounts" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:rescales:JobRescalesOverview:RescalesCounts",
"properties" : {
"completed" : {
"type" : "integer"
},
"failed" : {
"type" : "integer"
},
"ignored" : {
"type" : "integer"
},
"inProgress" : {
"type" : "integer"
}
}
}
}
}</code></pre>
</label>
</td>
</tr>
</tbody>
</table>
<table class="rest-api table table-bordered">
<tbody>
<tr>
Expand Down
49 changes: 49 additions & 0 deletions docs/static/generated/rest_v1_dispatcher.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -978,6 +978,24 @@ paths:
type: array
items:
$ref: "#/components/schemas/JobRescaleDetails"
/jobs/{jobid}/rescales/overview:
get:
description: Return job rescales overview.
operationId: getJobRescalesOverview
parameters:
- name: jobid
in: path
description: 32-character hexadecimal string value that identifies a job.
required: true
schema:
$ref: "#/components/schemas/JobID"
responses:
"200":
description: The request was successful.
content:
application/json:
schema:
$ref: "#/components/schemas/JobRescalesOverview"
/jobs/{jobid}/rescaling:
patch:
description: Triggers the rescaling of a job. This async operation would return
Expand Down Expand Up @@ -2850,6 +2868,13 @@ components:
type: array
items:
$ref: "#/components/schemas/JobRescaleDetails"
JobRescalesOverview:
type: object
properties:
latest:
$ref: "#/components/schemas/LatestRescales"
rescalesCounts:
$ref: "#/components/schemas/RescalesCounts"
JobResourceRequirementsBody:
type: object
additionalProperties:
Expand Down Expand Up @@ -3011,6 +3036,15 @@ components:
$ref: "#/components/schemas/RestoredCheckpointStatistics"
savepoint:
$ref: "#/components/schemas/CompletedCheckpointStatistics"
LatestRescales:
type: object
properties:
completed:
$ref: "#/components/schemas/JobRescaleDetails"
failed:
$ref: "#/components/schemas/JobRescaleDetails"
ignored:
$ref: "#/components/schemas/JobRescaleDetails"
LogInfo:
type: object
properties:
Expand Down Expand Up @@ -3158,6 +3192,21 @@ components:
upperPart:
type: integer
format: int64
RescalesCounts:
type: object
properties:
completed:
type: integer
format: int64
failed:
type: integer
format: int64
ignored:
type: integer
format: int64
inProgress:
type: integer
format: int64
ResourceID:
pattern: "[0-9a-f]{32}"
type: string
Expand Down
Loading