github.com/dkerwin/nomad@v0.3.3-0.20160525181927-74554135514b/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": "151accaa-1ac6-90fe-d427-313e70ccbb88",
    45      "Priority": 50,
    46      "Type": "service",
    47      "TriggeredBy": "job-register",
    48      "JobID": "binstore-storagelocker",
    49      "JobModifyIndex": 14,
    50      "NodeID": "",
    51      "NodeModifyIndex": 0,
    52      "Status": "complete",
    53      "StatusDescription": "",
    54      "Wait": 0,
    55      "NextEval": "",
    56      "PreviousEval": "",
    57      "CreateIndex": 15,
    58      "ModifyIndex": 17
    59      }
    60      ```
    61  
    62    </dd>
    63  </dl>
    64  
    65  <dl>
    66    <dt>Description</dt>
    67    <dd>
    68      Query the allocations created or modified by an evaluation.
    69    </dd>
    70  
    71    <dt>Method</dt>
    72    <dd>GET</dd>
    73  
    74    <dt>URL</dt>
    75    <dd>`/v1/evaluation/<id>/allocations`</dd>
    76  
    77    <dt>Parameters</dt>
    78    <dd>
    79      None
    80    </dd>
    81  
    82    <dt>Blocking Queries</dt>
    83    <dd>
    84      [Supported](/docs/http/index.html#blocking-queries)
    85    </dd>
    86  
    87    <dt>Returns</dt>
    88    <dd>
    89  
    90      ```javascript
    91      [
    92      {
    93          "ID": "3575ba9d-7a12-0c96-7b28-add168c67984",
    94          "EvalID": "151accaa-1ac6-90fe-d427-313e70ccbb88",
    95          "Name": "binstore-storagelocker.binsl[0]",
    96          "NodeID": "a703c3ca-5ff8-11e5-9213-970ee8879d1b",
    97          "JobID": "binstore-storagelocker",
    98          "TaskGroup": "binsl",
    99          "DesiredStatus": "run",
   100          "DesiredDescription": "",
   101          "ClientStatus": "running",
   102          "ClientDescription": "",
   103          "CreateIndex": 16,
   104          "ModifyIndex": 16
   105      },
   106      ...
   107      ]
   108      ```
   109  
   110    </dd>
   111  </dl>