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

Материал из Документация Ключ-АСТРОМ
Строка 485: Строка 485:
Результат усекается до двух записей.
Результат усекается до двух записей.


==== Завиток ====
==== Curl ====
  <code>curl -L -X GET '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/activeGates'</nowiki> \
  <code>curl -L -X GET '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/activeGates'</nowiki> \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>


==== URL-адрес запроса ====
==== URL-адрес запроса ====
  <code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/activeGates</nowiki></code>
  <code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/activeGates</nowiki></code>


==== Тело ответа ====
==== Тело ответа ====

Версия 17:15, 22 февраля 2023

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

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

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

GET
  • Managed https: // {ваш-домен} / e / {your-environment-id} / api / v2 / activeGates
  • Среда АктивногоШлюза https: // {your-activegate-domain} / e / {your-environment-id} / api / v2 / activeGates

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

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

Параметры

Параметр Тип Описание In необходимость
hostname string Фильтрует полученный набор АктивныхШлюзов по имени хоста, на котором он работает.

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

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

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

  • LINUX
  • WINDOWS
 query по желанию
networkAddress string Фильтрует полученный набор АктивныхШлюзов по сетевому адресу.

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

query по желанию
loadBalancerAddress string Фильтрует полученный набор АктивныхШлюзов по адресу Load Balancer.

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

query по желанию
type string Фильтрует полученный набор АктивногоШлюза по типу АктивногоШлюза.

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

  • ENVIRONMENT
  • ENVIRONMENT_MULTI
 query по желанию
networkZone string Фильтрует полученный набор АктивныхШлюзов по сетевой зоне.

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

query по желанию
updateStatus string Фильтрует полученный набор АктивныхШлюзов по статусу автообновления.

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

  • INCOMPATIBLE
  • OUTDATED
  • SCHEDULED
  • SUPPRESSED
  • UNKNOWN
  • UP2DATE
  • UPDATE_IN_PROGRESS
  • UPDATE_PENDING
  • UPDATE_PROBLEM
 query по желанию
versionCompareType string Фильтрует полученный набор АктивныхШлюзов по указанной версии.

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

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

  • EQUAL
  • GREATER
  • GREATER_EQUAL
  • LOWER
  • LOWER_EQUAL
 query по желанию
version string Фильтрует полученный набор АктивныхШлюзов по указанной версии.

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

query по желанию
autoUpdate string Фильтрует полученный набор АктивныхШлюзов по фактическому состоянию автообновления.

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

  • DISABLED
  • ENABLED
 query по желанию
group string Фильтрует результирующий набор АктивныхШлюзов по группе.

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

query по желанию
online boolean Фильтрует полученный набор АктивныхШлюзов по статусу связи. query по желанию
enabledModule string[] Фильтрует результирующий набор АктивныхШлюзов по включенным модулям. query по желанию
disabledModule string[] Фильтрует полученный набор АктивныхШлюзов по отключенным модулям. query по желанию
containerized boolean Отфильтровывает результирующий набор АктивныхШлюзов к тем, которые работают в контейнере ( true) или нет ( false). query по желанию
tokenState string Фильтрует результирующий набор ActiveGates на те, у которых токен авторизации находится в указанном состоянии.

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

  • ABSENT
  • EXPIRING
  • INVALID
  • UNKNOWN
  • UNSUPPORTED
  • VALID
 query по желанию
tokenExpirationSet boolean Фильтрует результирующий набор АктивныхШлюзов на те, у которых установлена ​​дата истечения срока действия токена авторизации. query по желанию

Ответ

Коды ответов

Код Тип Описание
200 Список активных шлюзов Успех
400 ErrorEnvelope Неуспешный. Ввод недействителен.

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

Объект _ ActiveGateList

Список ActiveGate.

Элемент Тип Описание
активные ворота Активные ворота [] Список ActiveGate.

Объект _ ActiveGate

Параметры ActiveGate.

Элемент Тип Описание
идентификатор нить Идентификатор ActiveGate.
сетевые адреса строка [] Список сетевых адресов ActiveGate.
loadBalancerAddresses строка [] Список адресов балансировщика нагрузки ActiveGate.
тип ОС нить Тип ОС, на которой работает ActiveGate.

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

  • LINUX
  • WINDOWS
ОСАрхитектура нить Архитектура ОС, на которой работает ActiveGate.

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

  • S390
  • X86
осбитнесс нить Разрядность ОС, на которой работает ActiveGate.

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

  • 64
autoUpdateStatus нить Текущий статус автообновлений ActiveGate.

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

  • INCOMPATIBLE
  • OUTDATED
  • SCHEDULED
  • SUPPRESSED
  • UNKNOWN
  • UP2DATE
  • UPDATE_IN_PROGRESS
  • UPDATE_PENDING
  • UPDATE_PROBLEM
offlineSince целое число Отметка времени с момента, когда ActiveGate находится в автономном режиме.

Значение nullозначает, что ActiveGate находится в сети.

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

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

  • CLUSTER
  • ENVIRONMENT
  • ENVIRONMENT_MULTI
имя хоста нить Имя хоста, на котором работает ActiveGate.
mainEnvironment нить Идентификатор основной среды для ActiveGate с несколькими средами.
среды строка [] Список сред (определяемых идентификаторами), к которым может подключаться ActiveGate.
автообновление настроек Конфигурация автоматического обновления Active Gate Настройка автообновлений ActiveGate.
networkZone нить Сетевая зона ActiveGate.
группа нить Группа ActiveGate.
модули Активный модуль ворот [] Список модулей ActiveGate.
контейнерный логический ActiveGate развернут в контейнере ( true) или нет ( false).
подключенные хосты Хосты , подключенные к Active Gate Информация о хостах, подключенных в данный момент к ActiveGate
ActiveGateTokens Информация о токене активного шлюза Dto [] Список токенов ActiveGate.

Объект _ ActiveGateAutoUpdateConfig

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

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

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

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

эффективная настройка нить Фактическое состояние автообновления ActiveGate.

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

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

Объект _ ActiveGateModule

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

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

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

атрибуты объект Атрибуты модуля ActiveGate.

Объект _ ActiveGateConnectedHosts

Информация о хостах, подключенных в данный момент к ActiveGate

Элемент Тип Описание
число целое число Количество хостов, в настоящее время подключенных к ActiveGate

Объект _ ActiveGateTokenInfoDto

Информация о токене ActiveGate.

Элемент Тип Описание
идентификатор среды нить Идентификатор среды, к которой принадлежит токен.

Доступно, только если поддерживается более одной среды.

идентификатор нить Идентификатор токена ActiveGate, состоящий из префикса и общедоступной части токена.
состояние нить Состояние токена ActiveGate.

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

JSON-модель тела ответа

{
  "activeGates": [
    {
      "id": "0x3efdd091",
      "networkAddresses": [
        "string"
      ],
      "loadBalancerAddresses": [
        "string"
      ],
      "osType": "WINDOWS",
      "osArchitecture": "X86",
      "osBitness": "64",
      "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,
          "version": "string",
          "enabled": true,
          "type": "KUBERNETES",
          "attributes": {}
        }
      ],
      "containerized": true,
      "connectedHosts": {
        "number": 150
      },
      "activeGateTokens": [
        {
          "environmentId": "string",
          "id": "dt0g02.4KWZO5EF",
          "state": "ABSENT"
        }
      ]
    }
  ]
}

Пример

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

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

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

Curl

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

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

https://mySampleEnv.live.ruscomtech.ru/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=2530