REST API. Начало работы с REST API компонента «Шлюз»
Формат URL-команд для компонента «Шлюз»
Общий вид URL-команд реализован следующим образом:
/api/<module>/<command>
,
где:
<module>
- наименование модуля, реализованного в REST API. В текущей версии для компонента «Шлюз» доступен модуль health
;
<command>
- наименование команды. В текущей версии для компонента «Шлюз» доступна команда metrics
.
Пример запроса через curl
:
curl -X 'GET' \ 'http://gateway.termidesk.local:8102/api/health/metrics' \ -H 'accept: application/json' \ -H 'Authorization: Token 270c1e6a4cd013a382498'
где:
gateway.termidesk.local
- сетевой адрес или полное доменное имя узла компонента «Шлюз»;
8102
- порт доступа к API компонента «Шлюз»;
270c1e6a4cd013a382498
- токен, определенный в параметре token: ${metricsAccessKey}
конфигурационного файла «Шлюза» /etc/termidesk/gateway.yaml
.
Если «Шлюз» настроен на использование SSL-сертификатов, то в запросе curl
нужно указывать соответствующий протокол для подключения: вместо http
использовать https
.