open-nomad/website/source/docs/http/eval.html.md
2016-12-19 10:16:49 -08:00

2.6 KiB

layout page_title sidebar_current description
http HTTP API: /v1/evaluation docs-http-eval- The '/v1/evaluation' endpoint is used to query a specific evaluation.

/v1/evaluation

The evaluation endpoint is used to query a specific evaluations. By default, the agent's local region is used; another region can be specified using the ?region= query parameter.

GET

Description
Query a specific evaluation.
Method
GET
URL
`/v1/evaluation/`
Parameters
None
Blocking Queries
[Supported](/docs/http/index.html#blocking-queries)
Returns
```javascript
{
"ID": "055c0867-8bf7-5068-b3a3-d64e4e84e702",
"Priority": 50,
"Type": "service",
"TriggeredBy": "job-register",
"JobID": "example",
"JobModifyIndex": 13,
"NodeID": "",
"NodeModifyIndex": 0,
"Status": "complete",
"StatusDescription": "",
"Wait": 0,
"NextEval": "",
"PreviousEval": "",
"BlockedEval": "fee40e32-aa0f-bf5e-b2fd-b08350875fdb",
"FailedTGAllocs": {
    "cache": {
        "NodesEvaluated": 1,
        "NodesFiltered": 0,
        "NodesAvailable": {
            "dc1": 1
        },
        "ClassFiltered": null,
        "ConstraintFiltered": null,
        "NodesExhausted": 1,
        "ClassExhausted": null,
        "DimensionExhausted": {
            "memory exhausted": 1
        },
        "Scores": null,
        "AllocationTime": 61601,
        "CoalescedFailures": 2
    }
},
"CreateIndex": 14,
"ModifyIndex": 17
}
```
Description
Query the allocations created or modified by an evaluation.
Method
GET
URL
`/v1/evaluation//allocations`
Parameters
None
Blocking Queries
[Supported](/docs/http/index.html#blocking-queries)
Returns
```javascript
[
{
    "ID": "3575ba9d-7a12-0c96-7b28-add168c67984",
    "EvalID": "151accaa-1ac6-90fe-d427-313e70ccbb88",
    "Name": "binstore-storagelocker.binsl[0]",
    "NodeID": "a703c3ca-5ff8-11e5-9213-970ee8879d1b",
    "JobID": "binstore-storagelocker",
    "TaskGroup": "binsl",
    "DesiredStatus": "run",
    "DesiredDescription": "",
    "ClientStatus": "running",
    "ClientDescription": "",
    "CreateIndex": 16,
    "ModifyIndex": 16
},
...
]
```