Получить информацию о всех АктивныхШлюзах

Материал из Документация Ключ-АСТРОМ
Версия от 05:29, 13 декабря 2021; ENetrebin (обсуждение | вклад) (Новая страница: «Перечисляет все ActiveGates, которые в настоящее время подключены к среде или были подключены...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Перечисляет все ActiveGates, которые в настоящее время подключены к среде или были подключены в течение последних 2 часов.

Вы можете сузить вывод, указав параметры фильтрации в своем запросе.

Запрос создает application/jsonполезную нагрузку.

ПОЛУЧИТЬ
  • Удалось https: // {ваш-домен} / e / {your-environment-id} / api / v2 / activeGates
  • SaaS https: // {идентификатор-среды-вашей} .live.dynatrace.com / api / v2 / activeGates
  • Среда ActiveGate https: // {your-activegate-domain} / e / {your-environment-id} / api / v2 / activeGates

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

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

Параметры

Параметр Тип Описание В необходимые
имя хоста нить Фильтрует полученный набор ActiveGates по имени хоста, на котором он работает.

Вы можете указать частичное имя. В этом случае используется CONTAINSоператор.

запрос по желанию
osType нить Фильтрует полученный набор ActiveGates по типу ОС хоста, на котором он работает.

Элемент может содержать эти значения

запрос по желанию
сетевой адрес нить Фильтрует полученный набор ActiveGates по сетевому адресу.

Вы можете указать частичный адрес. В этом случае используется CONTAINSоператор.

запрос по желанию
loadBalancerAddress нить Фильтрует полученный набор ActiveGates по адресу Load Balancer.

Вы можете указать частичный адрес. В этом случае используется CONTAINSоператор.

запрос по желанию
тип нить Фильтрует полученный набор ActiveGate по типу ActiveGate.

Элемент может содержать эти значения

запрос по желанию
networkZone нить Фильтрует полученный набор ActiveGates по сетевой зоне.

Вы можете указать частичное имя. В этом случае используется CONTAINSоператор.

запрос по желанию
обновить статус нить Фильтрует полученный набор ActiveGates по статусу автообновления.

Элемент может содержать эти значения

запрос по желанию
versionCompareType нить Фильтрует полученный набор ActiveGates по указанной версии.

Укажите здесь оператор сравнения.

Элемент может содержать эти значения

запрос по желанию
версия нить Фильтрует полученный набор ActiveGates по указанной версии.

Здесь укажите версию в <major>.<minor>.<revision>формате (например, 1.195.0).

запрос по желанию
автоматическое обновление нить Фильтрует полученный набор ActiveGates по фактическому состоянию автообновления.

Элемент может содержать эти значения

запрос по желанию
группа нить Фильтрует результирующий набор ActiveGates по группе.

Вы можете указать частичное имя. В этом случае используется CONTAINSоператор.

запрос по желанию
онлайн логический Фильтрует полученный набор ActiveGates по статусу связи. запрос по желанию
enabledModule множество Фильтрует результирующий набор ActiveGates по включенным модулям. запрос по желанию
disabledModule множество Фильтрует полученный набор ActiveGates по отключенным модулям. запрос по желанию
контейнерный логический Отфильтровывает результирующий набор ActiveGates к тем, которые работают в контейнере ( true) или нет ( false). запрос по желанию

Ответ

Коды ответов

Код Описание
200 Успех
400 Не удалось. Введены неверные данные.

Тело ответа

  • Параметры ответа

ActiveGateList объект

Список ActiveGates.

Элемент Тип Описание
activeGates ActiveGate [] Список ActiveGates.

ActiveGate объект

Параметры ActiveGate.

Элемент Тип Описание
я бы нить Идентификатор ActiveGate.
networkAddresses нить[] Список сетевых адресов ActiveGate.
loadBalancerAddresses нить[] Список адресов Load Balancer ActiveGate.
osType нить Тип ОС, на которой работает ActiveGate.

Элемент может содержать эти значения

  • LINUX
  • ОКНА
autoUpdateStatus нить Текущий статус автообновлений ActiveGate.

Элемент может содержать эти значения

  • НЕСОВМЕСТИМО
  • УСТАРЕЛО
  • ПО РАСПИСАНИЮ
  • ПОДДЕРЖИВАЕТСЯ
  • НЕИЗВЕСТНЫЙ
  • ОБНОВЛЕНИЕ
  • ПРОИЗВОДИТСЯ ОБНОВЛЕНИЕ
  • UPDATE_PENDING
  • UPDATE_PROBLEM
offline целое число Отметка времени, с которой ActiveGate отключен.

nullЗначение означает ActiveGate онлайн.

версия нить Текущая версия ActiveGate в <major>.<minor>.<revision>.<timestamp>формате.
тип нить Тип ActiveGate.

Элемент может содержать эти значения

  • КЛАСТЕР
  • ОКРУЖАЮЩАЯ ОБСТАНОВКА
  • ENVIRONMENT_MULTI
имя хоста нить Имя хоста, на котором работает ActiveGate.
mainEnvironment нить Идентификатор основной среды для ActiveGate с несколькими средами.
окружающая среда нить[] Список сред (заданных идентификаторами), к которым ActiveGate может подключиться.
autoUpdateSettings Активный Gate Auto Update Config
networkZone нить Сетевая зона ActiveGate.
группа нить Группа ActiveGate.
модули Активный Gate модуль [] Список модулей ActiveGate.
контейнерный логический ActiveGate развертывается в контейнере ( true) или нет ( false).

ActiveGateModule объект

Информация о модуле ActiveGate

Элемент Тип Описание
неправильно настроен логический Модуль неправильно сконфигурирован ( true) или нет ( false).
тип нить Тип модуля ActiveGate.

Элемент может содержать эти значения

  • AWS
  • ЛАЗУРНЫЙ
  • BEACON_FORWARDER
  • CLOUD_FOUNDRY
  • DB_INSIGHT
  • EXTENSIONS_V1
  • EXTENSIONS_V2
  • КУБЕРНЕТЫ
  • ЖУРНАЛЫ
  • MEMORY_DUMPS
  • METRIC_API
  • ONE_AGENT_ROUTING
  • OTLP_INGEST
  • REST_API
  • СИНТЕТИЧЕСКИЙ
  • VMWARE
  • Z_OS
атрибуты объект Атрибуты модуля ActiveGate.
версия нить Версия модуля ActiveGate.
включено логический Модуль включен ( true) или отключен ( false).

ActiveGateAutoUpdateConfig объект

Настройка автообновлений ActiveGate.

Элемент Тип Описание
параметр нить Состояние автообновления ActiveGate: включено, отключено или унаследовано.

Если установлено значение INHERITED, параметр наследуется из глобальной конфигурации, установленной на уровне среды или управляемого кластера.

Элемент может содержать эти значения

  • ИНВАЛИД
  • ВКЛЮЧЕНО
  • Унаследованный
EffectiveSetting нить Фактическое состояние автообновления ActiveGate.

Применимо, только если параметр настройки установлен на INHERITED. В этом случае значение берется из родительской настройки. В противном случае это просто дубликат значения настройки .

Элемент может содержать эти значения

  • ВКЛЮЧЕНО
  • ИНВАЛИД
  • Модель JSON
{
  "activeGates": [
    {
      "id": "0x3efdd091",
      "networkAddresses": [
        "string"
      ],
      "loadBalancerAddresses": [
        "string"
      ],
      "osType": "WINDOWS",
      "autoUpdateStatus": "OUTDATED",
      "offlineSince": 1582031917814,
      "version": "1.185.0.20200201-120000",
      "type": "ENVIRONMENT",
      "hostname": "exampleHostname",
      "mainEnvironment": "d1bf4a7e-666b-43af-9f45-718g98372e2f",
      "environments": [
        "string"
      ],
      "autoUpdateSettings": {
        "setting": "INHERITED",
        "effectiveSetting": "ENABLED"
      },
      "networkZone": "exampleNetworkZone",
      "group": "default",
      "modules": [
        {
          "misconfigured": true,
          "type": "KUBERNETES",
          "attributes": {},
          "version": "string",
          "enabled": true
        }
      ],
      "containerized": true
    }
  ]
}


Пример

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

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

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

Завиток

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

URL запроса

https://mySampleEnv.live.dynatrace.com/api/v2/activeGates

Тело ответа

{
  "activeGates": [
    {
      "id": "1541791174",
      "networkAddresses": [
        "orange-15.easytravel.com",
        "150.134.11.6"
      ],
      "osType": "LINUX",
      "autoUpdateStatus": "UP2DATE",
      "offlineSince": null,
      "version": "1.193.0.20200416-144858",
      "type": "ENVIRONMENT",
      "hostname": "orange-15.easytravel.com",
      "mainEnvironment": null,
      "environments": [
        "mySampleEnv"
      ],
      "networkZone": "default"
    },
    {
      "id": "974977376",
      "networkAddresses": [
        "win-18.easytravel.com",
        "66.165.59.105"
      ],
      "osType": "WINDOWS",
      "autoUpdateStatus": "OUTDATED",
      "offlineSince": null,
      "version": "1.198.0.20200629-221007",
      "type": "ENVIRONMENT",
      "hostname": "win-18.easytravel.com",
      "mainEnvironment": null,
      "environments": [
        "mySampleEnv"
      ],
      "networkZone": "default"
    }
  ]
}

Код ответа

200

Источник — https://doc.ruscomtech.ru/index.php?title=Получить_информацию_о_всех_АктивныхШлюзах&oldid=548