Использование HTTP API для управления репликаторами данных¶

Настройка HTTP API¶

Включить API для отправки HTTP-запросов можно в файлах конфигурации, которые используются для настройки межкластерной репликации.

Чтобы настроить HTTP API для компонента Gateway, задайте в конфигурации опцию gateway.http_server:

gateway:
  # ...
  http_server:
    host: 192.168.64.9
    port: 10081

Чтобы настроить HTTP API для компонента Destination, задайте в конфигурации опцию destination.http_server:

destination:
  # ...
  http_server:
    host: 192.168.64.12
    port: 10082

Пример всего файла конфигурации приведен в разделе Настройка репликаторов руководства пользователя.

Больше информации можно найти в руководстве по настройке межкластерных репликаторов.

Получение метрик¶

Для получения метрик компонентов Gateway и Destination используются GET-запросы на адрес обработчика запроса вида /metrics. TCF возвращает метрики в формате Prometheus.

GET /metrics

Чтобы получать значения метрик Gateway, задайте в файле конфигурации параметр gateway.metrics_enabled:

gateway:
  # ...
  metrics_enabled: true

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

curl -X GET --location "http://192.168.64.9:10081/metrics"

Чтобы включить метрики Destination, задайте в файле конфигурации репликации параметр destination.metrics_enabled:

destination:
  # ...
  metrics_enabled: true

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

curl -X GET --location "http://192.168.64.12:10082/metrics"

Получение статуса репликатора¶

Получить статус репликатора данных можно только для компонента Destination. Для этого отправьте GET-запрос на адрес обработчика запроса вида /api/v1/status.

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

curl -X GET --location "http://192.168.64.12:10082/api/v1/status"

Запуск репликатора¶

Чтобы запустить репликатор данных Gateway или Destination, отправьте POST-запрос на адрес обработчика запроса вида /api/v1/start.

Пример запроса для Gateway:

curl -X POST --location "http://192.168.64.9:10081/api/v1/start"

Пример запроса для Destination:

curl -X POST --location "http://192.168.64.12:10082/api/v1/start"

Остановка репликатора¶

Для остановки репликатора Gateway или Destination отправьте POST-запрос на адрес обработчика запроса вида /api/v1/stop.

Пример запроса для Gateway:

curl -X POST --location "http://192.168.64.9:10081/api/v1/stop"

Пример запроса для Destination:

curl -X POST --location "http://192.168.64.12:10082/api/v1/stop"

Перезапуск репликатора¶

Перезапустить репликатор данных можно только для компонента Destination. Для этого отправьте POST-запрос на адрес обработчика запроса вида /api/v1/restart.

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

curl -X POST --location "http://192.168.64.12:10082/api/v1/restart"

Перезапуск репликатора с повторной инициализацией¶

Перезапустить репликатор с повторной инициализацией (rebootstrap) можно только для компонента Destination. Для этого отправьте POST-запрос на адрес обработчика запроса вида /api/v1/rebootstrap.

Перезапуск репликатора с повторной инициализацией используется в следующих случаях:

• для повторной синхронизации репликации после сбоев;

• в случае остановки репликации;

• при внесении изменений в конфигурацию.

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

curl -X POST --location "http://192.168.64.12:10082/api/v1/rebootstrap"