ENetrebin: Новая страница: «Список всех синтетических нод (и их параметров), доступных для вашей среды. Запрос созда...»

2022-10-24T15:47:09Z

Новая страница: «Список всех синтетических нод (и их параметров), доступных для вашей среды. Запрос созда...»

Новая страница

Список всех синтетических нод (и их параметров), доступных для вашей среды.

Запрос создает в качестве полезной нагрузки<code>application/json</code> формат.
{| class="wikitable"
| rowspan="2" |GET
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/nodes</nowiki></code>
|-
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/synthetic/nodes</nowiki></code>
|}

== Аутентификация ==
Чтобы выполнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( <code>DataExport</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .

== Параметры ==
Запрос не предоставляет никаких настраиваемых параметров.

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|Nodes
|Успех
|}

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

==== Объект <code>Nodes</code> ====
Список синтетических узлов
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|nodes
|NodeCollectionElement[]
|Список синтетических узлов
|}

==== Объект <code>NodeCollectionElement</code> ====
Краткое представление синтетического объекта. Содержит только идентификатор и отображаемое имя.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|entityId
|string
|Идентификатор ноды.
|-
|hostname
|string
|Имя хоста ноды.
|-
|ips
|string[]
|IP ноды.
|-
|version
|string
|Версия ноды
|-
|browserMonitorsEnabled
|boolean
|Флаг включенных возможностей проверки браузера.
|-
|activeGateVersion
|string
|Версия АктивногоШлюза.
|-
|oneAgentRoutingEnabled
|boolean
|В АктивномШлюзе маршрутизация с одним агентом включена («true») или нет («false»).
|-
|operatingSystem
|string
|Операционная система хоста АктивногоШлюза.
|-
|autoUpdateEnabled
|boolean
|В АктивномШлюзе включена опция автоматического обновления («true») или нет («false»).
|-
|status
|string
|Статус синтетической ноды.
|-
|playerVersion
|string
|Версия синтетического плеера.
|-
|healthCheckStatus
|string
|Статус проверки работоспособности синтетической ноды.
|}

=== JSON-модель тела ответа ===
<code>{
"nodes": [
{
"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"
}
]
}</code>

== Пример ==
В этом примере в запросе перечислены все искусственные узлы, доступные в <code>mySampleEnv</code>среде.

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

Результат усекается до трех записей.

==== Curl ====
<code>curl -X GET \
<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/nodes</nowiki> \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>

==== URL-адрес запроса ====
<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/nodes</nowiki></code>

==== Тело ответа ====
<code>{
"nodes": [
{
"entityId": "3086117876",
"hostname": "gdn.astrom.key",
"ips": [
"238.245.160.14"
],
"version": "1.164.0.20190205-184318",
"browserMonitorsEnabled": false
},
{
"entityId": "1267320067",
"hostname": "244.94.30.253",
"ips": [
"244.94.30.253"
],
"version": "1.161.0.20181210-173639",
"browserMonitorsEnabled": false
},
{
"entityId": "353074222",
"hostname": "GDN-007",
"ips": [
"132.46.87.141"
],
"version": "1.166.0.20190311-110828",
"browserMonitorsEnabled": true
}
]
}</code>

==== Код ответа ====
200

GET все ноды* - История изменений

ENetrebin: Новая страница: «Список всех синтетических нод (и их параметров), доступных для вашей среды. Запрос созда...»