status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
consul/website/content/api-docs/status.mdx

90 lines
2.7 KiB
Plaintext
Raw Normal View History

Update API docs
2017-04-04 16:33:22 +00:00
---
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.
initial
2020-04-06 20:27:35 +00:00
| Method | Path | Produces |
| :----- | :--------------- | ------------------ |
| `GET` | `/status/leader` | `application/json` |
Update API docs
2017-04-04 16:33:22 +00:00
The table below shows this endpoint's support for
website: redirect /api to /api-docs (#12660)
2022-03-30 21:16:26 +00:00
[blocking queries](/api-docs/features/blocking),
[consistency modes](/api-docs/features/consistency),
[agent caching](/api-docs/features/caching), and
docs: fix api docs anchor links
2022-10-18 19:49:07 +00:00
[required ACLs](/api-docs/api-structure#authentication).
Update API docs
2017-04-04 16:33:22 +00:00
Support Agent Caching for Service Discovery Results (#4541) * Add cache types for catalog/services and health/services and basic test that caching works * Support non-blocking cache types with Cache-Control semantics. * Update API docs to include caching info for every endpoint. * Comment updates per PR feedback. * Add note on caching to the 10,000 foot view on the architecture page to make the new data path more clear. * Document prepared query staleness quirk and force all background requests to AllowStale so we can spread service discovery load across servers.
2018-09-06 10:34:28 +00:00
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `none` |
Update API docs
2017-04-04 16:33:22 +00:00
docs: split HTTP API params into sections by type Path parameters, query parameters, and request body parameters are now shown in separate sections rather than combined into one general parameters section. This makes it much easier to understand quickly where a parameter should be provided.
2022-05-10 15:51:11 +00:00
### Query Parameters
Allow forwarding of some status RPCs (#6198) * Allow forwarding of some status RPCs * Update docs * add comments about not using the regular forward
2019-07-25 18:26:22 +00:00
- `dc` `(string: "")` - Specifies the datacenter to query. This will default to
docs: split HTTP API params into sections by type Path parameters, query parameters, and request body parameters are now shown in separate sections rather than combined into one general parameters section. This makes it much easier to understand quickly where a parameter should be provided.
2022-05-10 15:51:11 +00:00
the datacenter of the agent being queried.
Allow forwarding of some status RPCs (#6198) * Allow forwarding of some status RPCs * Update docs * add comments about not using the regular forward
2019-07-25 18:26:22 +00:00
Update API docs
2017-04-04 16:33:22 +00:00
### Sample Request
update dependencies
2020-05-19 18:32:38 +00:00
```shell-session
website: use 127.0.0.1 instead of consul.rocks (#4523) By default, the Consul agent listens on the local interface at port 8500 for API requests. This change makes the API examples using `curl` copy-pasteable for this default configuration.
2018-08-28 16:07:15 +00:00
$ curl http://127.0.0.1:8500/v1/status/leader
Update API docs
2017-04-04 16:33:22 +00:00
```
### 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.
initial
2020-04-06 20:27:35 +00:00
| Method | Path | Produces |
| :----- | :-------------- | ------------------ |
| `GET` | `/status/peers` | `application/json` |
Update API docs
2017-04-04 16:33:22 +00:00
The table below shows this endpoint's support for
website: redirect /api to /api-docs (#12660)
2022-03-30 21:16:26 +00:00
[blocking queries](/api-docs/features/blocking),
[consistency modes](/api-docs/features/consistency),
[agent caching](/api-docs/features/caching), and
docs: fix api docs anchor links
2022-10-18 19:49:07 +00:00
[required ACLs](/api-docs/api-structure#authentication).
Update API docs
2017-04-04 16:33:22 +00:00
Support Agent Caching for Service Discovery Results (#4541) * Add cache types for catalog/services and health/services and basic test that caching works * Support non-blocking cache types with Cache-Control semantics. * Update API docs to include caching info for every endpoint. * Comment updates per PR feedback. * Add note on caching to the 10,000 foot view on the architecture page to make the new data path more clear. * Document prepared query staleness quirk and force all background requests to AllowStale so we can spread service discovery load across servers.
2018-09-06 10:34:28 +00:00
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `none` |
Update API docs
2017-04-04 16:33:22 +00:00
docs: don't treat CLI cmd cross-ref as info box
2022-01-15 17:29:35 +00:00
The corresponding CLI command is [`consul operator raft list-peers`](/commands/operator/raft#list-peers).
Editing links and grammer changes
2022-01-10 19:21:32 +00:00
docs: split HTTP API params into sections by type Path parameters, query parameters, and request body parameters are now shown in separate sections rather than combined into one general parameters section. This makes it much easier to understand quickly where a parameter should be provided.
2022-05-10 15:51:11 +00:00
### Query Parameters
Allow forwarding of some status RPCs (#6198) * Allow forwarding of some status RPCs * Update docs * add comments about not using the regular forward
2019-07-25 18:26:22 +00:00
- `dc` `(string: "")` - Specifies the datacenter to query. This will default to
docs: split HTTP API params into sections by type Path parameters, query parameters, and request body parameters are now shown in separate sections rather than combined into one general parameters section. This makes it much easier to understand quickly where a parameter should be provided.
2022-05-10 15:51:11 +00:00
the datacenter of the agent being queried.
Allow forwarding of some status RPCs (#6198) * Allow forwarding of some status RPCs * Update docs * add comments about not using the regular forward
2019-07-25 18:26:22 +00:00
Update API docs
2017-04-04 16:33:22 +00:00
### Sample Request
update dependencies
2020-05-19 18:32:38 +00:00
```shell-session
website: use 127.0.0.1 instead of consul.rocks (#4523) By default, the Consul agent listens on the local interface at port 8500 for API requests. This change makes the API examples using `curl` copy-pasteable for this default configuration.
2018-08-28 16:07:15 +00:00
$ curl http://127.0.0.1:8500/v1/status/peers
Update API docs
2017-04-04 16:33:22 +00:00
```
### Sample Response
```json
initial
2020-04-06 20:27:35 +00:00
["10.1.10.12:8300", "10.1.10.11:8300", "10.1.10.10:8300"]
Update API docs
2017-04-04 16:33:22 +00:00
```