Получение всех синтетических нод кластера (GET все ноды)

Материал из Документация Ключ-АСТРОМ
Версия от 14:48, 23 сентября 2022; RGolovanov (обсуждение | вклад) (Новая страница: «Этот вызов API перечисляет все синтетические ноды и их параметры, доступные для вашей сре...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Этот вызов API перечисляет все синтетические ноды и их параметры, доступные для вашей среды. Запрос создает полезную нагрузку application/json.

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

Для выполнения этого запроса вам необходимо разрешение одной из областей API (ServiceProviderAPI), назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.

Конечная точка

/api/cluster/v2/synthetic/nodes

Параметры

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

Ответ

Коды ответа

Код Тип Описание
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.dyna.trace",
      "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 передается в заголовке Authorization.

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

Curl

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

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

https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/nodes

Тело ответа

{
  "nodes": [
    {
      "entityId": "3086117876",
      "hostname": "gdn.dyna.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"
    }
  ]
}

Код ответа

200