GET нода

Материал из Документация Ключ-АСТРОМ
Версия от 11:02, 21 октября 2022; ENetrebin (обсуждение | вклад) (Новая страница: «Получает все параметры указанного синтетического узла. Запрос создает в качестве полез...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Получает все параметры указанного синтетического узла.

Запрос создает в качестве полезной нагрузки application/json формат.

GET Удалось https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/nodes/{nodeId}
Среда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/v2/synthetic/nodes/{nodeId}

Аутентификация

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение синтетических местоположений ( syntheticLocations.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Параметр Тип Описание In Необходимость
nodeId string ID нужного синтетического узла. path требуется

Ответ

Коды ответов

Код Тип Описание
200 Node Успех

Объекты тела ответа

Объект Node

Конфигурация синтетического узла.

Синтетический узел — это АктивныйШлюз, способный запускать синтетические мониторы.

Элемент Тип Описание
entityId string ID синтетического узла.
hostname string Имя хоста синтетического узла.
ips string[] IP синтетического узла.
version string Версия синтетического узла.
browserMonitorsEnabled boolean Синтетический узел может выполнять мониторы браузера ( true) или нет ( false).
activeGateVersion string Версия АктивногоШлюза.
oneAgentRoutingEnabled boolean В АктивномШлюзе маршрутизация с одним агентом включена («true») или нет («false»).
operatingSystem string Операционная система хоста АктивногоШлюза.
autoUpdateEnabled boolean В АктивномШлюзе включена опция автоматического обновления («true») или нет («false»).
status string Статус синтетического узла.
playerVersion string Версия синтетического плеера.
healthCheckStatus string Статус проверки работоспособности синтетического узла.
browserType string Тип браузера.
browserVersion string Браузерная версия.

JSON-модель тела ответа

{
  "entityId": "3086117876",
  "hostname": "gdn.astrom.key",
  "ips": [
    "238.245.160.14"
  ],
  "version": "1.161.0.20181210-173639",
  "browserMonitorsEnabled": true,
  "activeGateVersion": "1.172.2.20190607-040913",
  "oneAgentRoutingEnabled": true,
  "operatingSystem": "Linux",
  "autoUpdateEnabled": true,
  "status": "Running",
  "playerVersion": "1.179.0.20190920-145430",
  "healthCheckStatus": "Ok",
  "browserType": "Chrome",
  "browserVersion": "69.0.3497.81"
}

Пример

В этом примере запрос получает параметры узла с идентификатором 3086117876 .

Маркер API передается в заголовке авторизации .

Curl

curl -X GET \
  https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/nodes/3086117876 \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

URL-адрес запроса

https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/nodes/3086117876

Тело ответа

{
  "entityId": "3086117876",
  "hostname": "gdn.astrom.key",
  "ips": [
    "238.245.160.14"
  ],
  "version": "1.207.0.20201029-141904",
  "browserMonitorsEnabled": true,
  "activeGateVersion": "1.207.0.20201029-180431",
  "oneAgentRoutingEnabled ": false,
  "operatingSystem": "Platform: Linux, Version: 4.4.0-1092-aws, Architecture: amd64, Processors: 2",
  "autoUpdateEnabled": true,
  "status": "Running",
  "playerVersion": "1.207.0.20201029-081128",
  "healthCheckStatus": "Ok"
}

Код ответа

200