prefix(string: "")- Specifies a string to filter evaluations based on an
ID prefix. Because the value is decoded to bytes, the prefix must have an
even number of hexadecimal characters (0-9a-f). This is specified as a query
string parameter and is used before any filter expression is applied.
next_token(string: "") - This endpoint supports paging. The
next_token parameter accepts a string which is the ID field of
the next expected evaluation. This value can be obtained from the
X-Nomad-NextToken header from the previous response.
per_page(int: 0) - Specifies a maximum number of evaluations to
return for this request. If omitted, the response is not
paginated. The ID of the last evaluation in the response can be
used as the last_token of the next request to fetch additional
pages.
filter(string: "") - Specifies the expression
used to filter the results. Consider using pagination or a query parameter to
reduce resource used to serve the request.
job(string: "") - Filter the list of evaluations to a specific
job ID.
status(string: "") - Filter the list of evaluations to a
specific evaluation status (one of blocked, pending, complete,
failed, or canceled).
namespace(string: "default") - Specifies the target namespace.
Specifying * will return all evaluations across all authorized namespaces.
This parameter is used before any filter expression is applied.
reverse(bool: false) - Specifies the list of returned evaluations should
be sorted in the reverse order. By default evaluations are returned sorted in
chronological order (older evaluations first), or in lexicographical order by
their ID if the prefix query parameter is used.
:eval_id(string: <required>)- Specifies the UUID of the evaluation. This
must be the full UUID, not the short 8-character one. This is specified as
part of the path.
related(bool: false) - Specifies if related evaluations should be
returned. Related evaluations are the ones that can be reached by following
the trail of IDs for NextEval, PreviousEval, and BlockedEval. This is
specified as a query parameter.
{"CreateIndex":28,"CreateTime":1647394818583344000,"FailedTGAllocs":{"cache":{"AllocationTime":4111,"ClassExhausted":null,"ClassFiltered":null,"CoalescedFailures":0,"ConstraintFiltered":null,"DimensionExhausted":null,"NodesAvailable":{"dc1":0},"NodesEvaluated":0,"NodesExhausted":0,"NodesFiltered":0,"QuotaExhausted":null,"ResourcesExhausted":null,"ScoreMetaData":null,"Scores":null}},"ID":"2deb5f06-a100-f01a-3316-5e501a4965e7","JobID":"example","ModifyIndex":28,"ModifyTime":1647394818583344000,"Namespace":"default","PreviousEval":"0f98f7ea-59ae-4d90-d9bd-b8ce80b9e100","Priority":50,"RelatedEvals":[{"BlockedEval":"2deb5f06-a100-f01a-3316-5e501a4965e7","CreateIndex":27,"CreateTime":1647394818582736000,"DeploymentID":"79ae0a49-acf6-0fcf-183f-8646f3167b88","ID":"0f98f7ea-59ae-4d90-d9bd-b8ce80b9e100","JobID":"example","ModifyIndex":30,"ModifyTime":1647394818583565000,"Namespace":"default","NextEval":"","NodeID":"","PreviousEval":"","Priority":50,"Status":"complete","StatusDescription":"","TriggeredBy":"node-drain","Type":"service","WaitUntil":null}],"SnapshotIndex":27,"Status":"blocked","StatusDescription":"created to place remaining allocations","TriggeredBy":"queued-allocs","Type":"service"}
{"CreateIndex":28,"CreateTime":1647394818583344000,"FailedTGAllocs":{"cache":{"AllocationTime":4111,"ClassExhausted":null,"ClassFiltered":null,"CoalescedFailures":0,"ConstraintFiltered":null,"DimensionExhausted":null,"NodesAvailable":{"dc1":0},"NodesEvaluated":0,"NodesExhausted":0,"NodesFiltered":0,"QuotaExhausted":null,"ResourcesExhausted":null,"ScoreMetaData":null,"Scores":null}},"ID":"2deb5f06-a100-f01a-3316-5e501a4965e7","JobID":"example","ModifyIndex":28,"ModifyTime":1647394818583344000,"Namespace":"default","PreviousEval":"0f98f7ea-59ae-4d90-d9bd-b8ce80b9e100","Priority":50,"RelatedEvals":[{"BlockedEval":"2deb5f06-a100-f01a-3316-5e501a4965e7","CreateIndex":27,"CreateTime":1647394818582736000,"DeploymentID":"79ae0a49-acf6-0fcf-183f-8646f3167b88","ID":"0f98f7ea-59ae-4d90-d9bd-b8ce80b9e100","JobID":"example","ModifyIndex":30,"ModifyTime":1647394818583565000,"Namespace":"default","NextEval":"","NodeID":"","PreviousEval":"","Priority":50,"Status":"complete","StatusDescription":"","TriggeredBy":"node-drain","Type":"service","WaitUntil":null}],"SnapshotIndex":27,"Status":"blocked","StatusDescription":"created to place remaining allocations","TriggeredBy":"queued-allocs","Type":"service"}
This endpoint deletes evaluations. In order to utilise this endpoint the
eval broker should be paused via the
operator scheduler update configuration API
endpoint.
This API endpoint should be used cautiously and only in outage situations where
there is a large backlog of evaluations not being processed. During most normal
and outage scenarios, Nomad's reconciliation and state management will handle
evaluations as needed.
:eval_id(string: <required>)- Specifies the UUID of the evaluation. This
must be the full UUID, not the short 8-character one. This is specified as
part of the path.
