github.com/huiliang/nomad@v0.2.1-0.20151124023127-7a8b664699ff/website/source/docs/http/nodes.html.md (about) 1 --- 2 layout: "http" 3 page_title: "HTTP API: /v1/nodes" 4 sidebar_current: "docs-http-nodes" 5 description: |- 6 The '/1/nodes' endpoint is used to list the client nodes. 7 --- 8 9 # /v1/nodes 10 11 The `nodes` endpoint is used to query the status of client nodes. 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 client nodes registered with Nomad. 21 </dd> 22 23 <dt>Method</dt> 24 <dd>GET</dd> 25 26 <dt>URL</dt> 27 <dd>`/v1/nodes`</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": "c9972143-861d-46e6-df73-1d8287bc3e66", 46 "Datacenter": "dc1", 47 "Name": "web-8e40e308", 48 "NodeClass": "", 49 "Drain": false, 50 "Status": "ready", 51 "StatusDescription": "", 52 "CreateIndex": 3, 53 "ModifyIndex": 4 54 }, 55 ... 56 ] 57 ``` 58 59 </dd> 60 </dl>