github.com/ncodes/nomad@v0.5.7-0.20170403112158-97adf4a74fb3/website/source/docs/http/eval.html.md (about)

     1  ---
     2  layout: "http"
     3  page_title: "HTTP API: /v1/evaluation"
     4  sidebar_current: "docs-http-eval-"
     5  description: |-
     6    The '/v1/evaluation' endpoint is used to query a specific evaluation.
     7  ---
     8  
     9  # /v1/evaluation
    10  
    11  The `evaluation` endpoint is used to query a specific evaluations.
    12  By default, the agent's local region is used; another region can
    13  be specified using the `?region=` query parameter.
    14  
    15  ## GET
    16  
    17  <dl>
    18    <dt>Description</dt>
    19    <dd>
    20      Query a specific evaluation.
    21    </dd>
    22  
    23    <dt>Method</dt>
    24    <dd>GET</dd>
    25  
    26    <dt>URL</dt>
    27    <dd>`/v1/evaluation/<ID>`</dd>
    28  
    29    <dt>Parameters</dt>
    30    <dd>
    31      None
    32    </dd>
    33  
    34    <dt>Blocking Queries</dt>
    35    <dd>
    36      [Supported](/docs/http/index.html#blocking-queries)
    37    </dd>
    38  
    39    <dt>Returns</dt>
    40    <dd>
    41  
    42      ```javascript
    43  	{
    44      "ID": "055c0867-8bf7-5068-b3a3-d64e4e84e702",
    45      "Priority": 50,
    46      "Type": "service",
    47      "TriggeredBy": "job-register",
    48      "JobID": "example",
    49      "JobModifyIndex": 13,
    50      "NodeID": "",
    51      "NodeModifyIndex": 0,
    52      "Status": "complete",
    53      "StatusDescription": "",
    54      "Wait": 0,
    55      "NextEval": "",
    56      "PreviousEval": "",
    57      "BlockedEval": "fee40e32-aa0f-bf5e-b2fd-b08350875fdb",
    58      "FailedTGAllocs": {
    59          "cache": {
    60              "NodesEvaluated": 1,
    61              "NodesFiltered": 0,
    62              "NodesAvailable": {
    63                  "dc1": 1
    64              },
    65              "ClassFiltered": null,
    66              "ConstraintFiltered": null,
    67              "NodesExhausted": 1,
    68              "ClassExhausted": null,
    69              "DimensionExhausted": {
    70                  "memory exhausted": 1
    71              },
    72              "Scores": null,
    73              "AllocationTime": 61601,
    74              "CoalescedFailures": 2
    75          }
    76      },
    77      "CreateIndex": 14,
    78      "ModifyIndex": 17
    79  	}
    80      ```
    81  
    82    </dd>
    83  </dl>
    84  
    85  <dl>
    86    <dt>Description</dt>
    87    <dd>
    88      Query the allocations created or modified by an evaluation.
    89    </dd>
    90  
    91    <dt>Method</dt>
    92    <dd>GET</dd>
    93  
    94    <dt>URL</dt>
    95    <dd>`/v1/evaluation/<ID>/allocations`</dd>
    96  
    97    <dt>Parameters</dt>
    98    <dd>
    99      None
   100    </dd>
   101  
   102    <dt>Blocking Queries</dt>
   103    <dd>
   104      [Supported](/docs/http/index.html#blocking-queries)
   105    </dd>
   106  
   107    <dt>Returns</dt>
   108    <dd>
   109  
   110      ```javascript
   111      [
   112      {
   113          "ID": "3575ba9d-7a12-0c96-7b28-add168c67984",
   114          "EvalID": "151accaa-1ac6-90fe-d427-313e70ccbb88",
   115          "Name": "binstore-storagelocker.binsl[0]",
   116          "NodeID": "a703c3ca-5ff8-11e5-9213-970ee8879d1b",
   117          "JobID": "binstore-storagelocker",
   118          "TaskGroup": "binsl",
   119          "DesiredStatus": "run",
   120          "DesiredDescription": "",
   121          "ClientStatus": "running",
   122          "ClientDescription": "",
   123          "CreateIndex": 16,
   124          "ModifyIndex": 16
   125      },
   126      ...
   127      ]
   128      ```
   129  
   130    </dd>
   131  </dl>