`/sys/health`

Конечная точка /sys/health используется для проверки состояния работоспособности StarVault.

1. Информация о работоспособности

Эта конечная точка возвращает состояние работоспособности StarVault. Это соответствует семантике HTTP-проверки работоспособности Consul и обеспечивает простой способ мониторинга работоспособности экземпляра StarVault.

Метод

Путь

HEAD

/sys/health

GET

/sys/health

Коды статуса по умолчанию:

200 если инициализирован, распечатан и активен
429 если не запечатан и находится в режиме ожидания
501 если не инициализирован
503 если запечатано

1.1. Параметры

standbyok (bool: false) – указывает, должен ли резервный сервер возвращать код активного состояния вместо кода состояния режима ожидания. Это полезно, когда StarVault находится за ненастраиваемым балансировщиком нагрузки, которому требуется только ответ уровня 200.
activecode (int: 200) – указывает код состояния, который должен быть возвращен для активного узла.
standbycode (int: 429) – указывает код состояния, который должен быть возвращен для резервного узла.
sealedcode (int: 503) – указывает код состояния, который должен быть возвращен для запечатанного узла.
uninitcode (int: 501) – указывает код состояния, который должен быть возвращен для неинициализированного узла.

Пример запроса:

curl \
  http://127.0.0.1:8200/v1/sys/health

На GET запрос возвращается следующий ответ:

Пример ответа:

{
  "initialized": true,
  "sealed": false,
  "standby": false,
  "performance_standby": false,
  "replication_performance_mode": "disabled",
  "replication_dr_mode": "disabled",
  "server_time_utc": 1516639589,
  "version": "1.1.0",
  "cluster_name": "vault-cluster-3bd69ca2",
  "cluster_id": "00af5aa8-c87d-b5fc-e82e-97cd8dfaf731"
}

Пример запроса на настройку возвращаемого кода статуса:

$ curl -i https://127.0.0.1:8200/v1/sys/health\?standbycode\=200

HTTP/2 200
cache-control: no-store
content-type: application/json
strict-transport-security: max-age=31536000; includeSubDomains
content-length: 364
date: Mon, 21 Jul 2025 11:17:56 GMT

На GET запрос возвращается следующий ответ:

Пример ответа:

{
  "initialized": true,
  "sealed": false,
  "standby": false,
  "performance_standby": false,
  "replication_performance_mode": "disabled",
  "replication_dr_mode": "disabled",
  "server_time_utc": 1706217694,
  "version": "1.1.0",
  "cluster_name": "vault-cluster-6fc973c2",
  "cluster_id": "8190fce1-679e-3a57-7d1f-f63d4851633b"
}