Type '/' to Search

»Evaluations HTTP API

The /evaluation endpoints are used to query for and interact with evaluations.

»List Evaluations

This endpoint lists all evaluations.

MethodPathProduces
GET/v1/evaluationsapplication/json

The table below shows this endpoint's support for blocking queries and required ACLs.

Blocking QueriesACL Required
YESnamespace:read-job

»Parameters

  • 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.

»Sample Request

$ curl \
    https://localhost:4646/v1/evaluations

$ curl \    https://localhost:4646/v1/evaluations
$ curl \
    https://localhost:4646/v1/evaluations?prefix=25ba81

$ curl \    https://localhost:4646/v1/evaluations?prefix=25ba81

»Sample Response

[
  {
    "ID": "5456bd7a-9fc0-c0dd-6131-cbee77f57577",
    "Priority": 50,
    "Type": "service",
    "TriggeredBy": "job-register",
    "JobID": "example",
    "JobModifyIndex": 52,
    "NodeID": "",
    "NodeModifyIndex": 0,
    "Status": "complete",
    "StatusDescription": "",
    "Wait": 0,
    "NextEval": "",
    "PreviousEval": "",
    "BlockedEval": "",
    "FailedTGAllocs": null,
    "ClassEligibility": null,
    "EscapedComputedClass": false,
    "AnnotatePlan": false,
    "SnapshotIndex": 53,
    "QueuedAllocations": {
      "cache": 0
    },
    "CreateIndex": 53,
    "ModifyIndex": 55
  }
]

[  {    "ID": "5456bd7a-9fc0-c0dd-6131-cbee77f57577",    "Priority": 50,    "Type": "service",    "TriggeredBy": "job-register",    "JobID": "example",    "JobModifyIndex": 52,    "NodeID": "",    "NodeModifyIndex": 0,    "Status": "complete",    "StatusDescription": "",    "Wait": 0,    "NextEval": "",    "PreviousEval": "",    "BlockedEval": "",    "FailedTGAllocs": null,    "ClassEligibility": null,    "EscapedComputedClass": false,    "AnnotatePlan": false,    "SnapshotIndex": 53,    "QueuedAllocations": {      "cache": 0    },    "CreateIndex": 53,    "ModifyIndex": 55  }]

»Read Evaluation

This endpoint reads information about a specific evaluation by ID.

MethodPathProduces
GET/v1/evaluation/:eval_idapplication/json

The table below shows this endpoint's support for blocking queries and required ACLs.

Blocking QueriesACL Required
YESnamespace:read-job

»Parameters

  • :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.

»Sample Request

$ curl \
    https://localhost:4646/v1/evaluation/5456bd7a-9fc0-c0dd-6131-cbee77f57577

$ curl \    https://localhost:4646/v1/evaluation/5456bd7a-9fc0-c0dd-6131-cbee77f57577

»Sample Response

{
  "ID": "5456bd7a-9fc0-c0dd-6131-cbee77f57577",
  "Priority": 50,
  "Type": "service",
  "TriggeredBy": "job-register",
  "JobID": "example",
  "JobModifyIndex": 52,
  "NodeID": "",
  "NodeModifyIndex": 0,
  "Status": "complete",
  "StatusDescription": "",
  "Wait": 0,
  "NextEval": "",
  "PreviousEval": "",
  "BlockedEval": "",
  "FailedTGAllocs": null,
  "ClassEligibility": null,
  "EscapedComputedClass": false,
  "AnnotatePlan": false,
  "SnapshotIndex": 53,
  "QueuedAllocations": {
    "cache": 0
  },
  "CreateIndex": 53,
  "ModifyIndex": 55
}

{  "ID": "5456bd7a-9fc0-c0dd-6131-cbee77f57577",  "Priority": 50,  "Type": "service",  "TriggeredBy": "job-register",  "JobID": "example",  "JobModifyIndex": 52,  "NodeID": "",  "NodeModifyIndex": 0,  "Status": "complete",  "StatusDescription": "",  "Wait": 0,  "NextEval": "",  "PreviousEval": "",  "BlockedEval": "",  "FailedTGAllocs": null,  "ClassEligibility": null,  "EscapedComputedClass": false,  "AnnotatePlan": false,  "SnapshotIndex": 53,  "QueuedAllocations": {    "cache": 0  },  "CreateIndex": 53,  "ModifyIndex": 55}

»List Allocations for Evaluation

This endpoint lists the allocations created or modified for the given evaluation.

MethodPathProduces
GET/v1/evaluation/:eval_id/allocationsapplication/json

The table below shows this endpoint's support for blocking queries and required ACLs.

Blocking QueriesACL Required
YESnamespace:read-job

»Parameters

  • :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.

»Sample Request

$ curl \
    https://localhost:4646/v1/evaluation/5456bd7a-9fc0-c0dd-6131-cbee77f57577/allocations

$ curl \    https://localhost:4646/v1/evaluation/5456bd7a-9fc0-c0dd-6131-cbee77f57577/allocations

»Sample Response

[
  {
    "ID": "a8198d79-cfdb-6593-a999-1e9adabcba2e",
    "EvalID": "5456bd7a-9fc0-c0dd-6131-cbee77f57577",
    "Name": "example.cache[0]",
    "NodeID": "fb2170a8-257d-3c64-b14d-bc06cc94e34c",
    "JobID": "example",
    "TaskGroup": "cache",
    "DesiredStatus": "run",
    "DesiredDescription": "",
    "ClientStatus": "running",
    "ClientDescription": "",
    "TaskStates": {
      "redis": {
        "State": "running",
        "Failed": false,
        "Events": [
          {
            "Type": "Received",
            "Time": 1495747371795703800,
            "FailsTask": false,
            "RestartReason": "",
            "SetupError": "",
            "DriverError": "",
            "ExitCode": 0,
            "Signal": 0,
            "Message": "",
            "KillTimeout": 0,
            "KillError": "",
            "KillReason": "",
            "StartDelay": 0,
            "DownloadError": "",
            "ValidationError": "",
            "DiskLimit": 0,
            "FailedSibling": "",
            "VaultError": "",
            "TaskSignalReason": "",
            "TaskSignal": "",
            "DriverMessage": ""
          },
          {
            "Type": "Driver",
            "Time": 1495747371798867200,
            "FailsTask": false,
            "RestartReason": "",
            "SetupError": "",
            "DriverError": "",
            "ExitCode": 0,
            "Signal": 0,
            "Message": "",
            "KillTimeout": 0,
            "KillError": "",
            "KillReason": "",
            "StartDelay": 0,
            "DownloadError": "",
            "ValidationError": "",
            "DiskLimit": 0,
            "FailedSibling": "",
            "VaultError": "",
            "TaskSignalReason": "",
            "TaskSignal": "",
            "DriverMessage": "Downloading image redis:3.2"
          },
          {
            "Type": "Started",
            "Time": 1495747379525667800,
            "FailsTask": false,
            "RestartReason": "",
            "SetupError": "",
            "DriverError": "",
            "ExitCode": 0,
            "Signal": 0,
            "Message": "",
            "KillTimeout": 0,
            "KillError": "",
            "KillReason": "",
            "StartDelay": 0,
            "DownloadError": "",
            "ValidationError": "",
            "DiskLimit": 0,
            "FailedSibling": "",
            "VaultError": "",
            "TaskSignalReason": "",
            "TaskSignal": "",
            "DriverMessage": ""
          }
        ]
      }
    },
    "CreateIndex": 54,
    "ModifyIndex": 57,
    "CreateTime": 1495747371794276400
  }
]

[  {    "ID": "a8198d79-cfdb-6593-a999-1e9adabcba2e",    "EvalID": "5456bd7a-9fc0-c0dd-6131-cbee77f57577",    "Name": "example.cache[0]",    "NodeID": "fb2170a8-257d-3c64-b14d-bc06cc94e34c",    "JobID": "example",    "TaskGroup": "cache",    "DesiredStatus": "run",    "DesiredDescription": "",    "ClientStatus": "running",    "ClientDescription": "",    "TaskStates": {      "redis": {        "State": "running",        "Failed": false,        "Events": [          {            "Type": "Received",            "Time": 1495747371795703800,            "FailsTask": false,            "RestartReason": "",            "SetupError": "",            "DriverError": "",            "ExitCode": 0,            "Signal": 0,            "Message": "",            "KillTimeout": 0,            "KillError": "",            "KillReason": "",            "StartDelay": 0,            "DownloadError": "",            "ValidationError": "",            "DiskLimit": 0,            "FailedSibling": "",            "VaultError": "",            "TaskSignalReason": "",            "TaskSignal": "",            "DriverMessage": ""          },          {            "Type": "Driver",            "Time": 1495747371798867200,            "FailsTask": false,            "RestartReason": "",            "SetupError": "",            "DriverError": "",            "ExitCode": 0,            "Signal": 0,            "Message": "",            "KillTimeout": 0,            "KillError": "",            "KillReason": "",            "StartDelay": 0,            "DownloadError": "",            "ValidationError": "",            "DiskLimit": 0,            "FailedSibling": "",            "VaultError": "",            "TaskSignalReason": "",            "TaskSignal": "",            "DriverMessage": "Downloading image redis:3.2"          },          {            "Type": "Started",            "Time": 1495747379525667800,            "FailsTask": false,            "RestartReason": "",            "SetupError": "",            "DriverError": "",            "ExitCode": 0,            "Signal": 0,            "Message": "",            "KillTimeout": 0,            "KillError": "",            "KillReason": "",            "StartDelay": 0,            "DownloadError": "",            "ValidationError": "",            "DiskLimit": 0,            "FailedSibling": "",            "VaultError": "",            "TaskSignalReason": "",            "TaskSignal": "",            "DriverMessage": ""          }        ]      }    },    "CreateIndex": 54,    "ModifyIndex": 57,    "CreateTime": 1495747371794276400  }]