/health

Содержание раздела

1. URL
2. Заголовки запроса
3. Тело запроса
4. Примеры

GET-метод возвращает информацию об общем состоянии ноды.

Успешный ответ означает, что нода доступна, успешно запущена и полностью готова к обработке запросов. Неуспешный ответ означает, что необходим перезапуск ноды или перебалансировка запросов на другие ноды.

URL

{host}:{port}/actuator/health

Параметры:

• host — IP-адрес или доменное имя ноды;
• port — номер порта, равный значению параметра DTM_METRICS_PORT в конфигурации ноды.

Заголовки запроса

Опциональные заголовки отсутствуют.

Тело запроса

Тело запроса отсутствует.

Примеры

cURL-запрос:

curl -X 'GET' \
  'http://localhost:8080/actuator/health'

Успешный ответ:

{
  "status": "UP",
  "components": {
    "diskSpace": {
      "status": "UP"
    },
    "dtmState": {
      "status": "UP"
    },
    "livenessState": {
      "status": "UP"
    },
    "ping": {
      "status": "UP"
    },
    "readinessState": {
      "status": "UP"
    }
  },
  "groups": [
    "liveness",
    "readiness",
    "startup"
  ]
}

Неуспешный ответ с первым состоянием:

{
  "status": "DOWN",
  "components": {
    "diskSpace": {
      "status": "UP"
    },
    "dtmState": {
      "status": "DOWN",
      "details": {
        "exception": "Query processing verticle is not running"
      }
    },
    "livenessState": {
      "status": "UP"
    },
    "ping": {
      "status": "UP"
    },
    "readinessState": {
      "status": "OUT_OF_SERVICE"
    }
  },
  "groups": [
    "liveness",
    "readiness",
    "startup"
  ]
}

Неуспешный ответ со вторым состоянием:

{
  "status": "DOWN",
  "components": {
    "diskSpace": {
      "status": "UP"
    },
    "dtmState": {
      "status": "UP"
    },
    "livenessState": {
      "status": "UP"
    },
    "ping": {
      "status": "UP"
    },
    "readinessState": {
      "status": "OUT_OF_SERVICE"
    }
  },
  "groups": [
    "liveness",
    "readiness",
    "startup"
  ]
}