GET все ноды*: различия между версиями

Текущая версия от 17:13, 2 января 2025

API АппОптима / Эндпойнты среды / Развёртывание / Синтетика v1 / Синтетические ноды / GET все ноды*

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

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

GET	АппОптима	`https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/nodes`
GET	Среда АктивногоШлюза	`https://{your-activegate-domain}/e/{your-environment-id}/api/v1/synthetic/nodes`

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

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

Параметры

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

Ответ

Коды ответов

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

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

Объект `Nodes`

Список синтетических узлов

Элемент	Тип	Описание
nodes	NodeCollectionElement[]	Список синтетических узлов

Объект `NodeCollectionElement`

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

Элемент	Тип	Описание
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-модель тела ответа

<{
  "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"
    }
  ]
}

Пример

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

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

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

Curl

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

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

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

Тело ответа

<{
  "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
    }
  ]
}

Код ответа

200

@@ Строка 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=GET%20%D1%81%D1%85%D0%B5%D0%BC%D0%B0-,%D0%A1%D0%B8%D0%BD%D1%82%D0%B5%D1%82%D0%B8%D0%BA%D0%B0%20v1,-%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%BC%D0%BE%D0%BD%D0%B8%D1%82%D0%BE%D1%80%D1%8B Синтетика v1] / Синтетические ноды / GET все ноды*'''''
 Список всех синтетических нод (и их параметров), доступных для вашей среды.
@@ Строка 4: / Строка 6: @@
 {| class="wikitable"
 | rowspan="2" |GET
-|Managed
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/nodes</nowiki></code>
 |-
@@ Строка 101: / Строка 103: @@
 === JSON-модель тела ответа ===
-  <code>{
+  <{
     "nodes": [
       {
@@ Строка 120: / Строка 122: @@
       }
     ]
-  }</code>
+  }
 == Пример ==
@@ Строка 130: / Строка 132: @@
 ==== Curl ====
-  <code>curl -X GET \
+  <curl -X GET \
     <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/nodes</nowiki> \
-    -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
+    -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
 ==== URL-адрес запроса ====
@@ Строка 138: / Строка 140: @@
 ==== Тело ответа ====
-  <code>{
+  <{
     "nodes": [
       {
@@ Строка 168: / Строка 170: @@
       }
     ]
-  }</code>
+  }
 ==== Код ответа ====