luxolus
/
open-nomad
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity
open-nomad/website/source/api/status.html.md

72 lines
1.6 KiB
Markdown
Raw Normal View History

Migrate status APIs
2017-05-26 23:17:33 +00:00
---
layout: api
page_title: Status - HTTP API
sidebar_current: api-status
description: |-
The /status endpoints query the Nomad system status.
---
# Status HTTP API
The `/status` endpoints query the Nomad system status.
## Read Leader
This endpoint returns the address of the current leader in the region.
| Method | Path | Produces |
| ------ | ---------------------------- | -------------------------- |
| `GET` | `/status/leader` | `application/json` |
The table below shows this endpoint's support for
Remove links to consistency modes
2017-05-31 01:08:23 +00:00
[blocking queries](/api/index.html#blocking-queries) and
Migrate status APIs
2017-05-26 23:17:33 +00:00
[required ACLs](/api/index.html#acls).
Remove consistency modes
2017-05-31 00:31:16 +00:00
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
| `NO` | `none` |
Migrate status APIs
2017-05-26 23:17:33 +00:00
### Sample Request
```text
$ curl \
Changed `nomad.rocks` to `localhost:4646` to align with defaults Should provide cut and paste example for most users. Advanced users should be able to correct URLs to something appropriate.
2018-01-29 16:27:52 +00:00
https://localhost:4646/v1/status/leader
Migrate status APIs
2017-05-26 23:17:33 +00:00
```
### Sample Response
```json
"127.0.0.1:4647"
```
## List Peers
This endpoint returns the set of raft peers in the region.
| Method | Path | Produces |
| ------ | ---------------------------- | -------------------------- |
| `GET` | `/status/peers` | `application/json` |
The table below shows this endpoint's support for
Remove links to consistency modes
2017-05-31 01:08:23 +00:00
[blocking queries](/api/index.html#blocking-queries) and
Migrate status APIs
2017-05-26 23:17:33 +00:00
[required ACLs](/api/index.html#acls).
Remove consistency modes
2017-05-31 00:31:16 +00:00
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
| `NO` | `none` |
Migrate status APIs
2017-05-26 23:17:33 +00:00
### Sample Request
```text
$ curl \
Changed `nomad.rocks` to `localhost:4646` to align with defaults Should provide cut and paste example for most users. Advanced users should be able to correct URLs to something appropriate.
2018-01-29 16:27:52 +00:00
https://localhost:4646/v1/status/peers
Migrate status APIs
2017-05-26 23:17:33 +00:00
```
### Sample Response
```json
[
"127.0.0.1:4647"
]
```