ENetrebin (обсуждение | вклад) (Новая страница: «Получает все параметры указанного синтетического узла. Запрос создает в качестве полез...») |
Нет описания правки |
||
| Строка 1: | Строка 1: | ||
'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D1%81%D0%BE%D1%81%D1%82%D0%BE%D1%8F%D0%BD%D0%B8%D1%8F%20%D0%BF%D1%80%D0%BE%D1%87%D0%B8%D1%85%20%D0%BC%D0%BE%D0%BD%D0%B8%D1%82%D0%BE%D1%80%D0%BE%D0%B2-,%D0%A1%D0%B8%D0%BD%D1%82%D0%B5%D1%82%D0%B8%D0%BA%D0%B0%20v2,-%D0%A1%D0%B8%D0%BD%D1%82%D0%B5%D1%82%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%B8%D0%B5%20%D0%BB%D0%BE%D0%BA%D0%B0%D1%86%D0%B8%D0%B8 Синтетика v2] / Синтетические ноды / GET нода''''' | |||
Получает все параметры указанного синтетического узла. | Получает все параметры указанного синтетического узла. | ||
| Строка 111: | Строка 113: | ||
=== JSON-модель тела ответа === | === JSON-модель тела ответа === | ||
< | <{ | ||
"entityId": "3086117876", | "entityId": "3086117876", | ||
"hostname": "gdn.astrom.key", | "hostname": "gdn.astrom.key", | ||
| Строка 136: | Строка 138: | ||
==== Curl ==== | ==== Curl ==== | ||
< | <curl -X GET \ | ||
<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/nodes/3086117876</nowiki> \ | <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/nodes/3086117876</nowiki> \ | ||
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code> | -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code> | ||
| Строка 144: | Строка 146: | ||
==== Тело ответа ==== | ==== Тело ответа ==== | ||
< | <{ | ||
"entityId": "3086117876", | "entityId": "3086117876", | ||
"hostname": "gdn.astrom.key", | "hostname": "gdn.astrom.key", | ||
Текущая версия от 17:20, 2 января 2025
API АппОптима / Эндпойнты среды / Развёртывание / Синтетика v2 / Синтетические ноды / GET нода
Получает все параметры указанного синтетического узла.
Запрос создает в качестве полезной нагрузки 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