IKuznetsov: Новая страница: «= API синтетических нодов v2 — Получить все ноды = Отображает список всех доступных для вашей среды синтетических нодов (и их параметров). Запрос формирует полезную нагрузку application/json. '''GET'''

https://{your-environment-id}.live.astromkey.com/api/v2/synthetic/nodes

'''GET''' Среда...»

2026-07-29T03:07:38Z

Новая страница: «= API синтетических нодов v2 — Получить все ноды = Отображает список всех доступных для вашей среды синтетических нодов (и их параметров). Запрос формирует полезную нагрузку <code>application/json</code>. '''GET''' <pre>https://{your-environment-id}.live.astromkey.com/api/v2/synthetic/nodes</pre> '''GET''' Среда...»

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

= API синтетических нодов v2 — Получить все ноды =

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

Запрос формирует полезную нагрузку <code>application/json</code>.

'''GET'''
<pre>https://{your-environment-id}.live.astromkey.com/api/v2/synthetic/nodes</pre>

'''GET'''
Среда АктивныйШлюз Кластер АктивныйШлюз
<pre>https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/synthetic/nodes</pre>

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

Для выполнения этого запроса вам потребуется токен доступа с областью действия <code>syntheticLocations.read</code>.

Чтобы узнать, как получить и использовать его, см. раздел «Токены и аутентификация».

= Параметры =

{| class="wikitable"
|-
! Параметр !! Тип !! Описание !! В !! Необходимый
|-
| <code>assignedToLocation</code> || string || Фильтрует полученный набор нодов, оставляя только те, которые назначены синтетическому местоположению, и те, которые не назначены. Допустимые значения: <code>TRUE</code>, <code>FALSE</code>. || запрос || Необязательный
|-
| <code>isContainerized</code> || boolean || Если установлено значение true, возвращаются только контейнеризированные ноды. || запрос || Необязательный
|}

= Ответ =

== Коды ответов ==

{| class="wikitable"
|-
! Код !! Тип !! Описание
|-
| 200 || Nodes || Успех
|-
| 4XX || ErrorEnvelope || Ошибка на стороне клиента.
|-
| 5XX || ErrorEnvelope || Ошибка на стороне сервера.
|}

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

'''Объект <code>Nodes</code>'''

Список синтетических нодов

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

'''Объект <code>NodeCollectionElement</code>'''

Краткое описание синтетического нода. Содержит только идентификатор и отображаемое имя.

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

'''Объект <code>ErrorEnvelope</code>'''

{| class="wikitable"
|-
! Элемент !! Тип !! Описание
|-
| <code>error</code> || <code>Error</code> || –
|}

'''Объект <code>Error</code>'''

{| class="wikitable"
|-
! Элемент !! Тип !! Описание
|-
| <code>code</code> || integer || Код состояния '''HTTP'''.
|-
| <code>constraintViolations</code> || <code>ConstraintViolation[]</code> || Список нарушений ограничений.
|-
| <code>message</code> || string || Сообщение об ошибке.
|}

'''Объект <code>ConstraintViolation</code>'''

Список нарушений ограничений

{| class="wikitable"
|-
! Элемент !! Тип !! Описание
|-
| <code>location</code> || string || –
|-
| <code>message</code> || string || –
|-
| <code>parameterLocation</code> || string || Допустимые значения: <code>HEADER</code>, ...
|-
| <code>path</code> || string || –
|}

== Модели JSON тела ответа ==

<pre>
{
"nodes": [
{
"activeGateVersion": "1.172.2.20190607-040913",
"autoUpdateEnabled": true,
"browserMonitorsEnabled": true,
"capabilities": [
"HTTP_HIGH_RESOURCE",
"HTTP"
],
"entityId": "3086117876",
"healthCheckStatus": "Ok",
"hostname": "gdn.astromkey.trace",
"ips": [
"238.245.160.14"
],
"oneAgentRoutingEnabled": true,
"operatingSystem": "Linux",
"playerVersion": "1.179.0.20190920-145430",
"status": "Running",
"version": "1.161.0.20181210-173639"
}
]
}
</pre>

<pre>
{
"error": {
"code": 1,
"constraintViolations": [
{
"location": "string",
"message": "string",
"parameterLocation": "HEADER",
"path": "string"
}
],
"message": "string"
}
}
</pre>

= Пример =

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

API-токен передается в заголовке '''Authorization'''.

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

'''cURL'''

<pre>
curl -X GET \
https://mySampleEnv.live.astromkey.com/api/v2/synthetic/nodes \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
</pre>

'''URL запроса'''

<pre>https://mySampleEnv.live.astromkey.com/api/v2/synthetic/nodes</pre>

'''Тело ответа'''

<pre>
{
"nodes": [
{
"entityId": "3086117876",
"hostname": "gdn.astromkey.trace",
"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"
},
{
"entityId": "1267320067",
"hostname": "244.94.30.253",
"ips": [
"244.94.30.253"
],
"version": null,
"browserMonitorsEnabled": true,
"activeGateVersion": "1.207.0.20201029-180431",
"oneAgentRoutingEnabled": false,
"operatingSystem": "Platform: Linux, Version: 4.15.0-1057-azure, Architecture: amd64, Processors: 2",
"autoUpdateEnabled": true,
"status": null,
"playerVersion": null,
"healthCheckStatus": "Offline"
}
]
}
</pre>

'''Код ответа'''

200

API синтетических нодов v2 — GET все ноды - История изменений