mirror of https://github.com/status-im/consul.git
90 lines
2.7 KiB
Plaintext
90 lines
2.7 KiB
Plaintext
---
|
|
layout: api
|
|
page_title: Status - HTTP API
|
|
description: |-
|
|
The /status endpoints return information about the status of the Consul
|
|
cluster. This information is generally very low level and not often useful for
|
|
clients.
|
|
---
|
|
|
|
# Status HTTP API
|
|
|
|
The `/status` endpoints return information about the status of the Consul
|
|
cluster. This information is generally very low level and not often useful for
|
|
clients.
|
|
|
|
## Get Raft Leader
|
|
|
|
This endpoint returns the Raft leader for the datacenter in which the agent is
|
|
running.
|
|
|
|
| Method | Path | Produces |
|
|
| :----- | :--------------- | ------------------ |
|
|
| `GET` | `/status/leader` | `application/json` |
|
|
|
|
The table below shows this endpoint's support for
|
|
[blocking queries](/consul/api-docs/features/blocking),
|
|
[consistency modes](/consul/api-docs/features/consistency),
|
|
[agent caching](/consul/api-docs/features/caching), and
|
|
[required ACLs](/consul/api-docs/api-structure#authentication).
|
|
|
|
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
|
| ---------------- | ----------------- | ------------- | ------------ |
|
|
| `NO` | `none` | `none` | `none` |
|
|
|
|
### Query Parameters
|
|
|
|
- `dc` `(string: "")` - Specifies the datacenter to query. This will default to
|
|
the datacenter of the agent being queried.
|
|
|
|
### Sample Request
|
|
|
|
```shell-session
|
|
$ curl http://127.0.0.1:8500/v1/status/leader
|
|
```
|
|
|
|
### Sample Response
|
|
|
|
```json
|
|
"10.1.10.12:8300"
|
|
```
|
|
|
|
## List Raft Peers
|
|
|
|
This endpoint retrieves the Raft peers for the datacenter in which the the agent
|
|
is running. This list of peers is strongly consistent and can be useful in
|
|
determining when a given server has successfully joined the cluster.
|
|
|
|
| Method | Path | Produces |
|
|
| :----- | :-------------- | ------------------ |
|
|
| `GET` | `/status/peers` | `application/json` |
|
|
|
|
The table below shows this endpoint's support for
|
|
[blocking queries](/consul/api-docs/features/blocking),
|
|
[consistency modes](/consul/api-docs/features/consistency),
|
|
[agent caching](/consul/api-docs/features/caching), and
|
|
[required ACLs](/consul/api-docs/api-structure#authentication).
|
|
|
|
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
|
| ---------------- | ----------------- | ------------- | ------------ |
|
|
| `NO` | `none` | `none` | `none` |
|
|
|
|
The corresponding CLI command is [`consul operator raft list-peers`](/consul/commands/operator/raft#list-peers).
|
|
|
|
### Query Parameters
|
|
|
|
- `dc` `(string: "")` - Specifies the datacenter to query. This will default to
|
|
the datacenter of the agent being queried.
|
|
|
|
### Sample Request
|
|
|
|
```shell-session
|
|
$ curl http://127.0.0.1:8500/v1/status/peers
|
|
```
|
|
|
|
### Sample Response
|
|
|
|
```json
|
|
["10.1.10.12:8300", "10.1.10.11:8300", "10.1.10.10:8300"]
|
|
```
|