REST API. Начало работы с REST API компонента «Агент виртуального рабочего места»
Формат URL-команд для компонента «Агент виртуального рабочего места»
Общий вид URL-команд реализован следующим образом:
/<uuid>/<module>/<command>
,
где:
<uuid>
- случайное значение, генерируемое компонентом «Агент виртуального рабочего места»;
<module>
- наименование модуля, реализованного в REST API. В текущей версии для компонента «Агент виртуального рабочего места» доступен модуль health
;
<command>
- наименование команды. В текущей версии для компонента «Агент виртуального рабочего места» доступна команда metrics
.
Пример запроса через curl
:
curl -k https://agent.termidesk.local:43969/97jbI6HiRePIbYowVnsYGZyBZp4UJz29PEkzG29nEyuNmITE/health/metrics
где:
agent.termidesk.local
- сетевой адрес или полное доменное имя узла компонента «Агент виртуального рабочего места»;
43969
- порт компонента «Агент виртуального рабочего места»;
97jbI6Hi...
- случайное значение, генерируемое компонентом «Агент виртуального рабочего места».
Значение порта и случайного значения можно получить из журнала работы компонента «Клиент», оно будет храниться в строке вида: «https://agent.termidesk.local:43969/HN4PlWm0wc8ZyPndsczqvXkpbDsXu44ITrdIE4WC0mLnp68W/sso_login». В приведенном примере случайное значение - «HN4PlWm0wc8ZyPndsczqvXkpbDsXu44ITrdIE4WC0mLnp68W», значение порта - «43969».