github.com/kardianos/nomad@v0.1.3-0.20151022182107-b13df73ee850/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 '/1/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      Lists all the evaluations.
    21    </dd>
    22  
    23    <dt>Method</dt>
    24    <dd>GET</dd>
    25  
    26    <dt>URL</dt>
    27    <dd>`/v1/evaluations`</dd>
    28  
    29    <dt>Parameters</dt>
    30    <dd>
    31      None
    32    </dd>
    33  
    34    <dt>Returns</dt>
    35    <dd>
    36  
    37      ```javascript
    38      {
    39      "ID": "151accaa-1ac6-90fe-d427-313e70ccbb88",
    40      "Priority": 50,
    41      "Type": "service",
    42      "TriggeredBy": "job-register",
    43      "JobID": "binstore-storagelocker",
    44      "JobModifyIndex": 14,
    45      "NodeID": "",
    46      "NodeModifyIndex": 0,
    47      "Status": "complete",
    48      "StatusDescription": "",
    49      "Wait": 0,
    50      "NextEval": "",
    51      "PreviousEval": "",
    52      "CreateIndex": 15,
    53      "ModifyIndex": 17
    54      }
    55      ```
    56  
    57    </dd>
    58  </dl>
    59  
    60  # /v1/evaluation/\<ID\>/allocations
    61  ## GET
    62  
    63  <dl>
    64    <dt>Description</dt>
    65    <dd>
    66      Query the allocations created or modified by an evaluation.
    67    </dd>
    68  
    69    <dt>Method</dt>
    70    <dd>GET</dd>
    71  
    72    <dt>URL</dt>
    73    <dd>`/v1/evaluation/<id>/allocations`</dd>
    74  
    75    <dt>Parameters</dt>
    76    <dd>
    77      None
    78    </dd>
    79  
    80    <dt>Returns</dt>
    81    <dd>
    82  
    83      ```javascript
    84      [
    85      {
    86          "ID": "3575ba9d-7a12-0c96-7b28-add168c67984",
    87          "EvalID": "151accaa-1ac6-90fe-d427-313e70ccbb88",
    88          "Name": "binstore-storagelocker.binsl[0]",
    89          "NodeID": "a703c3ca-5ff8-11e5-9213-970ee8879d1b",
    90          "JobID": "binstore-storagelocker",
    91          "TaskGroup": "binsl",
    92          "DesiredStatus": "run",
    93          "DesiredDescription": "",
    94          "ClientStatus": "running",
    95          "ClientDescription": "",
    96          "CreateIndex": 16,
    97          "ModifyIndex": 16
    98      },
    99      ...
   100      ]
   101      ```
   102  
   103    </dd>
   104  </dl>
   105