mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-22 15:11:07 +02:00
0660ea6fac
* Update README Let contributors know that docs will now be located in UDR * Add comments to each mdx doc Comment has been added to all mdx docs that are not partials * chore: added changelog changelog check failure * wip: removed changelog * Fix content errors * Doc spacing * Update website/content/docs/deploy/kubernetes/vso/helm.mdx Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com> --------- Co-authored-by: jonathanfrappier <92055993+jonathanfrappier@users.noreply.github.com> Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
79 lines
2.5 KiB
Plaintext
79 lines
2.5 KiB
Plaintext
---
|
|
layout: api
|
|
page_title: /sys/ha-status - HTTP API
|
|
description: The `/sys/ha-status` endpoint is used to check the HA status of a Vault cluster.
|
|
---
|
|
|
|
> [!IMPORTANT]
|
|
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
|
|
|
|
# `/sys/ha-status`
|
|
|
|
The `/sys/ha-status` endpoint is used to check the HA status of a Vault cluster.
|
|
It lists the active node and the peers that it's heard from since it became active.
|
|
|
|
## HA status
|
|
|
|
This endpoint returns the HA status of the Vault cluster.
|
|
|
|
| Method | Path |
|
|
| :----- | :----------------- |
|
|
| `GET` | `/sys/ha-status` |
|
|
|
|
### Sample request
|
|
|
|
```shell-session
|
|
$ curl \
|
|
--header "X-Vault-Token: ..." \
|
|
http://127.0.0.1:8200/v1/sys/ha-status
|
|
```
|
|
|
|
### Sample response
|
|
|
|
```json
|
|
{
|
|
"Nodes": [
|
|
{
|
|
"active_node": true,
|
|
"api_address": "http://10.0.0.2:8200",
|
|
"clock_skew_ms": 0,
|
|
"cluster_address": "https://10.0.0.2:8201",
|
|
"echo_duration_ms": 0,
|
|
"hostname": "node1",
|
|
"last_echo": null,
|
|
"replication_primary_canary_age_ms": 0,
|
|
"version": "1.17.0",
|
|
"upgrade_version": "1.17.0",
|
|
"redundancy_zone": "a"
|
|
},
|
|
{
|
|
"active_node": false,
|
|
"api_address": "http://10.0.0.3:8200",
|
|
"clock_skew_ms": 0,
|
|
"cluster_address": "https://10.0.0.3:8201",
|
|
"echo_duration_ms": 20,
|
|
"hostname": "node2",
|
|
"last_echo": "2024-03-04T08:05:48.403148-05:00",
|
|
"replication_primary_canary_age_ms": 72,
|
|
"version": "1.17.0",
|
|
"upgrade_version": "1.17.0",
|
|
"redundancy_zone": "a"
|
|
},
|
|
{
|
|
"active_node": false,
|
|
"api_address": "http://10.0.0.4:8200",
|
|
"clock_skew_ms": -1,
|
|
"cluster_address": "https://10.0.0.4:8201",
|
|
"echo_duration_ms": 17,
|
|
"hostname": "node3",
|
|
"last_echo": "2024-03-04T08:05:48.657318-05:00",
|
|
"replication_primary_canary_age_ms": 950,
|
|
"version": "1.17.0",
|
|
"upgrade_version": "1.17.0",
|
|
"redundancy_zone": "a"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
Note that in the above sample response, `upgrade_version`, `redundancy_zone`, and `replication_primary_canary_age_ms` are Enterprise-only fields.
|