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

Текущая версия от 08:54, 26 декабря 2024

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

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

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

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

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

Параметры

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

Ответ

Коды ответов

Код	Тип	Описание
200	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/v2/synthetic/nodes \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

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

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

Тело ответа

<{
  "nodes": [
    {
      "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"
    },
    {
      "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"
    }
  ]
}

Код ответа

200

@@ Строка 4: / Строка 4: @@
 {| class="wikitable"
 | rowspan="2" |GET
-|Managed
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/nodes</nowiki></code>
 |-
@@ Строка 101: / Строка 101: @@
 === JSON-модель тела ответа ===
-  <code>{
+  <{
     "nodes": [
       {
@@ Строка 130: / Строка 130: @@
 ==== Curl ====
-  <code>curl -X GET \
+  <curl -X GET \
     <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/nodes</nowiki> \
     -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
@@ Строка 138: / Строка 138: @@
 ==== Тело ответа ====
-  <code>{
+  <{
     "nodes": [
       {