5b0d4db6bc
* 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.
2.4 KiB
2.4 KiB
| layout | page_title | sidebar_current | description |
|---|---|---|---|
| api | Status - HTTP API | api-status | 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, consistency modes, agent caching, and required ACLs.
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|---|---|---|---|
NO |
none |
none |
none |
Sample Request
$ curl http://127.0.0.1:8500/v1/status/leader
Sample Response
"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, consistency modes, agent caching, and required ACLs.
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|---|---|---|---|
NO |
none |
none |
none |
Sample Request
$ curl http://127.0.0.1:8500/v1/status/peers
Sample Response
[
"10.1.10.12:8300",
"10.1.10.11:8300",
"10.1.10.10:8300"
]