Skip to content

Commit b1c858e

Browse files
RocMarshalXCompWeiZhong94mateczaganyferenc-csaky
committed
[FLINK-38895][runtime] Introduce the /jobs/:jobid/rescales/details/:rescaleuuid endpoint in the REST API
Co-authored-by: XComp <mpohl@confluent.io> Co-authored-by: WeiZhong94 <weizhong0618@gmail.com> Co-authored-by: mateczagany <czmate10@gmail.com> Co-authored-by: ferenc-csaky <fcsaky@apache.org>
1 parent 9bdd3a4 commit b1c858e

21 files changed

Lines changed: 1743 additions & 223 deletions

File tree

docs/layouts/shortcodes/generated/rest_v1_dispatcher.html

Lines changed: 190 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3643,6 +3643,196 @@
36433643
</tr>
36443644
</tbody>
36453645
</table>
3646+
<table class="rest-api table table-bordered">
3647+
<tbody>
3648+
<tr>
3649+
<td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/rescales/details/:rescaleuuid</strong></h5></td>
3650+
</tr>
3651+
<tr>
3652+
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
3653+
<td class="text-left">Response code: <code>200 OK</code></td>
3654+
</tr>
3655+
<tr>
3656+
<td colspan="2">Return a job rescale details.</td>
3657+
</tr>
3658+
<tr>
3659+
<td colspan="2">Path parameters</td>
3660+
</tr>
3661+
<tr>
3662+
<td colspan="2">
3663+
<ul>
3664+
<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
3665+
<li><code>rescaleuuid</code> - String value that identifies a job rescale.</li>
3666+
</ul>
3667+
</td>
3668+
</tr>
3669+
<tr>
3670+
<td colspan="2">
3671+
<label>
3672+
<details>
3673+
<summary>Request</summary>
3674+
<pre><code>{}</code></pre>
3675+
</label>
3676+
</td>
3677+
</tr>
3678+
<tr>
3679+
<td colspan="2">
3680+
<label>
3681+
<details>
3682+
<summary>Response</summary>
3683+
<pre><code>{
3684+
"type" : "object",
3685+
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:rescales:JobRescaleDetails",
3686+
"properties" : {
3687+
"endTimestampInMillis" : {
3688+
"type" : "integer"
3689+
},
3690+
"rescaleAttemptId" : {
3691+
"type" : "integer"
3692+
},
3693+
"rescaleUuid" : {
3694+
"type" : "string"
3695+
},
3696+
"resourceRequirementsUuid" : {
3697+
"type" : "string"
3698+
},
3699+
"schedulerStates" : {
3700+
"type" : "array",
3701+
"items" : {
3702+
"type" : "object",
3703+
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:rescales:SchedulerStateSpan",
3704+
"properties" : {
3705+
"durationInMillis" : {
3706+
"type" : "integer"
3707+
},
3708+
"enterTimestampInMillis" : {
3709+
"type" : "integer"
3710+
},
3711+
"leaveTimestampInMillis" : {
3712+
"type" : "integer"
3713+
},
3714+
"state" : {
3715+
"type" : "string"
3716+
},
3717+
"stringifiedException" : {
3718+
"type" : "string"
3719+
}
3720+
}
3721+
}
3722+
},
3723+
"slots" : {
3724+
"type" : "object",
3725+
"additionalProperties" : {
3726+
"type" : "object",
3727+
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:rescales:JobRescaleDetails:SlotSharingGroupRescaleInfo",
3728+
"properties" : {
3729+
"acquiredResourceProfile" : {
3730+
"type" : "object",
3731+
"$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:ResourceProfileInfo"
3732+
},
3733+
"desiredSlots" : {
3734+
"type" : "integer"
3735+
},
3736+
"minimalRequiredSlots" : {
3737+
"type" : "integer"
3738+
},
3739+
"postRescaleSlots" : {
3740+
"type" : "integer"
3741+
},
3742+
"preRescaleSlots" : {
3743+
"type" : "integer"
3744+
},
3745+
"requestResourceProfile" : {
3746+
"type" : "object",
3747+
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:ResourceProfileInfo",
3748+
"properties" : {
3749+
"cpuCores" : {
3750+
"type" : "number"
3751+
},
3752+
"extendedResources" : {
3753+
"type" : "object",
3754+
"additionalProperties" : {
3755+
"type" : "number"
3756+
}
3757+
},
3758+
"managedMemory" : {
3759+
"type" : "integer"
3760+
},
3761+
"networkMemory" : {
3762+
"type" : "integer"
3763+
},
3764+
"taskHeapMemory" : {
3765+
"type" : "integer"
3766+
},
3767+
"taskOffHeapMemory" : {
3768+
"type" : "integer"
3769+
}
3770+
}
3771+
},
3772+
"slotSharingGroupId" : {
3773+
"type" : "any"
3774+
},
3775+
"slotSharingGroupName" : {
3776+
"type" : "string"
3777+
}
3778+
}
3779+
}
3780+
},
3781+
"startTimestampInMillis" : {
3782+
"type" : "integer"
3783+
},
3784+
"terminalState" : {
3785+
"type" : "string",
3786+
"enum" : [ "COMPLETED", "FAILED", "IGNORED" ]
3787+
},
3788+
"terminatedReason" : {
3789+
"type" : "string",
3790+
"enum" : [ "SUCCEEDED", "EXCEPTION_OCCURRED", "RESOURCE_REQUIREMENTS_UPDATED", "NO_RESOURCES_OR_PARALLELISMS_CHANGE", "JOB_FINISHED", "JOB_FAILED", "JOB_CANCELED", "JOB_FAILOVER_RESTARTING" ]
3791+
},
3792+
"triggerCause" : {
3793+
"type" : "string",
3794+
"enum" : [ "INITIAL_SCHEDULE", "UPDATE_REQUIREMENT", "NEW_RESOURCE_AVAILABLE", "RECOVERABLE_FAILOVER" ]
3795+
},
3796+
"vertices" : {
3797+
"type" : "object",
3798+
"additionalProperties" : {
3799+
"type" : "object",
3800+
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:rescales:JobRescaleDetails:VertexParallelismRescaleInfo",
3801+
"properties" : {
3802+
"desiredParallelism" : {
3803+
"type" : "integer"
3804+
},
3805+
"jobVertexId" : {
3806+
"type" : "any"
3807+
},
3808+
"jobVertexName" : {
3809+
"type" : "string"
3810+
},
3811+
"postRescaleParallelism" : {
3812+
"type" : "integer"
3813+
},
3814+
"preRescaleParallelism" : {
3815+
"type" : "integer"
3816+
},
3817+
"slotSharingGroupId" : {
3818+
"type" : "any"
3819+
},
3820+
"slotSharingGroupName" : {
3821+
"type" : "string"
3822+
},
3823+
"sufficientParallelism" : {
3824+
"type" : "integer"
3825+
}
3826+
}
3827+
}
3828+
}
3829+
}
3830+
}</code></pre>
3831+
</label>
3832+
</td>
3833+
</tr>
3834+
</tbody>
3835+
</table>
36463836
<table class="rest-api table table-bordered">
36473837
<tbody>
36483838
<tr>

0 commit comments

Comments
 (0)