github.com/huiliang/nomad@v0.2.1-0.20151124023127-7a8b664699ff/website/source/docs/http/allocs.html.md (about)

     1  ---
     2  layout: "http"
     3  page_title: "HTTP API: /v1/allocations"
     4  sidebar_current: "docs-http-allocs"
     5  description: |-
     6    The '/1/allocations' endpoint is used to list the allocations.
     7  ---
     8  
     9  # /v1/allocations
    10  
    11  The `allocations` endpoint is used to query the status of allocations.
    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 allocations.
    21    </dd>
    22  
    23    <dt>Method</dt>
    24    <dd>GET</dd>
    25  
    26    <dt>URL</dt>
    27    <dd>`/v1/allocations`</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      {
    45        "ID": "203266e5-e0d6-9486-5e05-397ed2b184af",
    46        "EvalID": "e68125ed-3fba-fb46-46cc-291addbc4455",
    47        "Name": "example.cache[0]",
    48        "NodeID": "e02b6169-83bd-9df6-69bd-832765f333eb",
    49        "JobID": "example",
    50        "TaskGroup": "cache",
    51        "DesiredStatus": "run",
    52        "DesiredDescription": ""
    53        "ClientDescription": "",
    54        "ClientStatus": "running",
    55        "TaskStates": {
    56          "redis": {
    57            "Events": [
    58              {
    59                "KillError": "",
    60                "Message": "",
    61                "Signal": 0,
    62                "ExitCode": 0,
    63                "DriverError": "",
    64                "Time": 1447806038427841000,
    65                "Type": "Started"
    66              }
    67            ],
    68            "State": "running"
    69          }
    70        },
    71        "CreateIndex": 7,
    72        "ModifyIndex": 9,
    73      }
    74      ...
    75      ]
    76      ```
    77  
    78    </dd>
    79  </dl>