github.com/quite/nomad@v0.8.6/website/source/api/ui.html.md (about) 1 --- 2 layout: api 3 page_title: UI 4 sidebar_current: ui 5 description: |- 6 The /ui namespace is used to access the Nomad web user interface. 7 --- 8 9 # Nomad Web UI 10 11 Starting in v0.7, the Nomad UI is accessible at `/ui`. It is not namespaced by version. A request to `/` 12 will also redirect to `/ui`. 13 14 15 ## List Jobs 16 17 This page lists all known jobs in a paginated, searchable, and sortable table. 18 19 | Path | Produces | 20 | ---------- | ----------- | 21 | `/ui/jobs` | `text/html` | 22 23 ### Parameters 24 25 - `namespace` `(string: "")` - Specifies the namespace all jobs should be a member 26 of. This is specified as a querystring parameter. Namespaces are an enterprise feature. 27 28 - `sort` `(string: "")` - Specifies the property the list of jobs should be sorted by. 29 This is specified as a querystring parameter. 30 31 - `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending 32 or ascending. This is specified as a querystring parameter. 33 34 - `search` `(string: "")` - Specifies a regular expression uses to filter the list of 35 visible jobs. This is specified as a querystring parameter. 36 37 - `page` `(int: 0)` - Specifies the page in the jobs list that should be visible. This 38 is specified as a querystring parameter. 39 40 41 ## Job Detail 42 43 This page shows an overview of a specific job. Details include name, status, type, 44 priority, allocation statuses, and task groups. Additionally, if there is a running 45 deployment for the job, it will be shown on the overview. 46 47 This page shows an overview of a specific job. The exact information shown varies 48 based on the type of job. 49 50 - **Service Job** - Includes job metadata (name, status, priority, namespace), allocation 51 statuses, placement failures, active deployment, task groups, and evaluations. 52 53 - **Batch Job** - Includes job metadata, allocation statuses, placement failures, task 54 groups, and evaluations. 55 56 - **System Job** - Includes job metadata, allocation statuses, placement failures, task 57 groups, and evaluations. 58 59 - **Periodic Job** - Includes job metadata, cron information force launch action, children statuses, 60 and children list. 61 62 - **Parameterized Job** - Includes job metadata, children statuses, and children list. 63 64 - **Periodic Child** - Includes job metadata, link to parent job, allocation statuses, placement 65 failures, task groups, and evaluations. 66 67 - **Parameterized Child** - Includes job metadata, link to parent job, allocation statuses, 68 placement failures, task groups, evaluations, and dispatch payload. 69 70 | Path | Produces | 71 | ------------------ | ----------- | 72 | `/ui/jobs/:job_id` | `text/html` | 73 74 ### Parameters 75 76 - `sort` `(string: "")` - Specifies the property the list of task groups should be 77 sorted by. This is specified as a querystring parameter. 78 79 - `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending 80 or ascending. This is specified as a querystring parameter. 81 82 - `page` `(int: 0)` - Specifies the page in the task groups list that should be visible. This 83 is specified as a querystring parameter. 84 85 86 ### Job Definition 87 88 This page shows the definition of a job as pretty-printed, syntax-highlighted, JSON. 89 90 | Path | Produces | 91 | ----------------------------- | ----------- | 92 | `/ui/jobs/:job_id/definition` | `text/html` | 93 94 95 ### Job Versions 96 97 This page lists all available versions for a job in a timeline view. Each version in 98 the timeline can be expanded to show a pretty-printed, syntax-highlighted diff between 99 job versions. 100 101 | Path | Produces | 102 | ----------------------------- | ----------- | 103 | `/ui/jobs/:job_id/versions` | `text/html` | 104 105 106 ### Job Deployments 107 108 This page lists all available deployments for a job when the job has deployments. The 109 deployments are listed in a timeline view. Each deployment shows pertinent information 110 such as deployment ID, status, associated version, and submit time. Each deployment can 111 also be expanded to show detail information regarding canary placements, allocation 112 placements, healthy and unhealthy allocations, as well the current description for the 113 status. A table of task groups is also present in the detail view, which shows allocation 114 metrics by task group. Lastly, each expanded deployment lists all associated allocations 115 in a table to drill into for task events. 116 117 | Path | Produces | 118 | -------------------------------- | ----------- | 119 | `/ui/jobs/:job_id/deployments` | `text/html` | 120 121 122 ## Task Group Detail 123 124 This page shows an overview of a specific task group. Details include the number of tasks, the aggregated amount of reserved CPU, memory, and disk, all associated allocations broken 125 down by status, and a list of allocations. The list of allocations include details such as 126 status, the node the allocation was placed on, and the current CPU and Memory usage of the 127 allocations. 128 129 | Path | Produces | 130 | ----------------------------------- | ----------- | 131 | `/ui/jobs/:job_id/:task_group_name` | `text/html` | 132 133 ### Parameters 134 135 - `sort` `(string: "")` - Specifies the property the list of allocations should be sorted by. 136 This is specified as a querystring parameter. 137 138 - `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending 139 or ascending. This is specified as a querystring parameter. 140 141 - `search` `(string: "")` - Specifies a regular expression uses to filter the list of 142 visible allocations. This is specified as a querystring parameter. 143 144 - `page` `(int: 0)` - Specifies the page in the allocations list that should be visible. This 145 is specified as a querystring parameter. 146 147 148 ## Allocation Detail 149 150 This page shows details and events for an allocation. Details include the job the allocation 151 belongs to, the node the allocation is placed on, a list of all tasks, and lists of task 152 events per task. Each task in the task list includes the task name, state, last event, time, 153 and addresses. Each task event in a task history list includes the time, type, and 154 description of the event. 155 156 | Path | Produces | 157 | --------------------------- | ----------- | 158 | `/ui/allocations/:alloc_id` | `text/html` | 159 160 ### Parameters 161 162 - `sort` `(string: "")` - Specifies the property the list of tasks should be sorted by. 163 This is specified as a querystring parameter. 164 165 - `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending 166 or ascending. This is specified as a querystring parameter. 167 168 169 ## Task Detail 170 171 This page shows details and events for a specific task. Details include when the task started 172 and stopped, all static and dynamic addresses, and all recent events. 173 174 | Path | Produces | 175 | -------------------------------------- | ----------- | 176 | `/ui/allocations/:alloc_id/:task_name` | `text/html` | 177 178 179 ## Task Logs 180 181 This page streams `stdout` and `stderr` logs for a task. By default, `stdout` is tailed, but 182 there are available actions to see the head of the log, pause and play streaming, and switching 183 to `stderr`. 184 185 | Path | Produces | 186 | ------------------------------------------- | ----------- | 187 | `/ui/allocations/:alloc_id/:task_name/logs` | `text/html` | 188 189 190 ## Nodes List 191 192 This page lists all nodes in the Nomad cluster in a sortable, searchable, paginated 193 table. 194 195 | Path | Produces | 196 | ----------- | ----------- | 197 | `/ui/nodes` | `text/html` | 198 199 ### Parameters 200 201 - `sort` `(string: "")` - Specifies the property the list of client nodes should be sorted by. 202 This is specified as a querystring parameter. 203 204 - `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending 205 or ascending. This is specified as a querystring parameter. 206 207 - `search` `(string: "")` - Specifies a regular expression uses to filter the list of 208 visible client nodes. This is specified as a querystring parameter. 209 210 - `page` `(int: 0)` - Specifies the page in the client nodes list that should be visible. This 211 is specified as a querystring parameter. 212 213 214 ## Node Detail 215 216 This page shows the details of a node, including the node name, status, full ID, 217 address, port, datacenter, allocations, and attributes. 218 219 | Path | Produces | 220 | -------------------- | ----------- | 221 | `/ui/nodes/:node_id` | `text/html` | 222 223 ### Parameters 224 225 - `sort` `(string: "")` - Specifies the property the list of allocations should be sorted by. 226 This is specified as a querystring parameter. 227 228 - `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending 229 or ascending. This is specified as a querystring parameter. 230 231 - `search` `(string: "")` - Specifies a regular expression uses to filter the list of 232 visible allocations. This is specified as a querystring parameter. 233 234 - `page` `(int: 0)` - Specifies the page in the allocations list that should be visible. This 235 is specified as a querystring parameter. 236 237 238 ## Servers List 239 240 This page lists all servers in the Nomad cluster in a sortable table. Details for each 241 server include the server status, address, port, datacenter, and whether or not it is 242 the leader. 243 244 | Path | Produces | 245 | ------------- | ----------- | 246 | `/ui/servers` | `text/html` | 247 248 ### Parameters 249 250 - `sort` `(string: "")` - Specifies the property the list of server agents should be sorted by. 251 This is specified as a querystring parameter. 252 253 - `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending 254 or ascending. This is specified as a querystring parameter. 255 256 - `page` `(int: 0)` - Specifies the page in the server agents list that should be visible. This 257 is specified as a querystring parameter. 258 259 260 ## Server Detail 261 262 This page lists all tags associated with a server. 263 264 | Path | Produces | 265 | ------------------------ | ----------- | 266 | `/ui/servers/:server_id` | `text/html` | 267 268 269 ## ACL Tokens 270 271 This page lets you enter an ACL token (both accessor ID and secret ID) to use with the UI. 272 If the cluster does not have ACLs enabled, this page is unnecessary. If the cluster has an 273 anonymous policy that grants cluster-wide read access, this page is unnecessary. If the 274 anonymous policy only grants partial read access, then providing an ACL Token will 275 authenticate all future requests to allow read access to additional resources. 276 277 | Path | Produces | 278 | --------------------- | ----------- | 279 | `/ui/settings/tokens` | `text/html` |