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

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

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

Запрос создает в качестве полезной нагрузки <code>application/json</code>формат.
{| class="wikitable"
|GET
|
* Managed https: // {ваш-домен} / e / {your-environment-id} / api / v2 / activeGates
* Среда АктивногоШлюза https: // {your-activegate-domain} / e / {your-environment-id} / api / v2 / activeGates
|}

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

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

Вы можете указать частичное имя. В этом случае используется <code>CONTAINS</code>оператор.
|query
|по желанию
|-
|osType
|string
|Фильтрует полученный набор АктивныхШлюзов по типу ОС хоста, на котором он работает.

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

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

Вы можете указать частичный адрес. В этом случае используется <code>CONTAINS</code>оператор.
|query
|по желанию
|-
|loadBalancerAddress
|string
|Фильтрует полученный набор АктивныхШлюзов по адресу Load Balancer.

Вы можете указать частичный адрес. В этом случае используется <code>CONTAINS</code>оператор.
|query
|по желанию
|-
|type
|string
|Фильтрует полученный набор АктивногоШлюза по типу АктивногоШлюза.

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

* <code>ENVIRONMENT</code>
* <code>ENVIRONMENT_MULTI</code>
|query
|по желанию
|-
|networkZone
|string
|Фильтрует полученный набор АктивныхШлюзов по сетевой зоне.

Вы можете указать частичное имя. В этом случае используется <code>CONTAINS</code>оператор.
|query
|по желанию
|-
|updateStatus
|string
|Фильтрует полученный набор АктивныхШлюзов по статусу автообновления.

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

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

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

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

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

Здесь укажите версию в <code><major>.<minor>.<revision></code>формате (например, <code>1.195.0</code>).
|query
|по желанию
|-
|autoUpdate
|string
|Фильтрует полученный набор АктивныхШлюзов по фактическому состоянию автообновления.

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

* <code>DISABLED</code>
* <code>ENABLED</code>
|query
|по желанию
|-
|group
|string
|Фильтрует результирующий набор АктивныхШлюзов по группе.

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

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

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|Список активных шлюзов
|Успех
|-
|400
|ErrorEnvelope
|Неуспешный. Ввод недействителен.
|}

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

==== Объект _ <code>ActiveGateList</code> ====
Список АктивныхШлюзов.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|ActiveGate
|ActiveGate []
|Список АктивногоШлюза.
|}

==== Объект _ <code>ActiveGate</code> ====
Параметры АктивногоШлюза.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|идентификатор
|нить
|Идентификатор АктивногоШлюза.
|-
|сетевые адреса
|строка []
|Список сетевых адресов АктивногоШлюза.
|-
|loadBalancerAddresses
|строка []
|Список адресов балансировщика нагрузки АктивногоШлюза.
|-
|тип ОС
|нить
|Тип ОС, на которой работает АктивныйШлюз.

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

* <code>LINUX</code>
* <code>WINDOWS</code>
|-
|ОСАрхитектура
|нить
|Архитектура ОС, на которой работает АктивныйШлюз.

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

* <code>S390</code>
* <code>X86</code>
|-
|осбитнесс
|нить
|Разрядность ОС, на которой работает АктивныйШлюз.

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

* <code>64</code>
|-
|autoUpdateStatus
|нить
|Текущий статус автообновлений АктивногоШлюза.

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

* <code>INCOMPATIBLE</code>
* <code>OUTDATED</code>
* <code>SCHEDULED</code>
* <code>SUPPRESSED</code>
* <code>UNKNOWN</code>
* <code>UP2DATE</code>
* <code>UPDATE_IN_PROGRESS</code>
* <code>UPDATE_PENDING</code>
* <code>UPDATE_PROBLEM</code>
|-
|offlineSince
|целое число
|Отметка времени с момента, когда АктивныйШлюз находится в автономном режиме.

Значение <code>null</code>означает, что АктивныйШлюз находится в сети.
|-
|версия
|нить
|Текущая версия АктивногоШлюза в <code><major>.<minor>.<revision>.<timestamp></code>формате.
|-
|тип
|нить
|Тип АктивногоШлюза.

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

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

==== Объект _ <code>ActiveGateAutoUpdateConfig</code> ====
Настройка автообновлений АктивногоШлюза.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|параметр
|нить
|Состояние автообновления АктивногоШлюза: включено, отключено или унаследовано.

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

Элемент может содержать эти значения
|-
|эффективная настройка
|нить
|Фактическое состояние автообновления АктивногоШлюза.

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

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

==== Объект _ <code>ActiveGateModule</code> ====
Информация о модуле АктивногоШлюза
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|неправильно сконфигурирован
|логический
|Модуль неправильно сконфигурирован ( <code>true</code>) или нет ( <code>false</code>).
|-
|версия
|нить
|Версия модуля АктивногоШлюза.
|-
|включено
|логический
|Модуль включен ( <code>true</code>) или отключен ( <code>false</code>).
|-
|тип
|нить
|Тип модуля АктивногоШлюза.

Элемент может содержать эти значения
|-
|атрибуты
|объект
|Атрибуты модуля АктивногоШлюза.
|}

==== Объект  <code>ActiveGateConnectedHosts</code> ====
Информация о хостах, подключенных в данный момент к АктивномуШлюзу
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|число
|целое число
|Количество хостов, в настоящее время подключенных к ActiveGate
|}

==== Объект _ <code>ActiveGateTokenInfoDto</code> ====
Информация о токене АктивногоШлюза.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|идентификатор среды
|нить
|Идентификатор среды, к которой принадлежит токен.

Доступно, только если поддерживается более одной среды.
|-
|идентификатор
|нить
|Идентификатор токена АктивногоШлюза, состоящий из префикса и общедоступной части токена.
|-
|состояние
|нить
|Состояние токена АктивногоШлюза.

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

=== JSON-модель тела ответа ===
 <code>{
   "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"
         }
       ]
     }
   ]
 }</code>

== Пример ==
В этом примере в запросе перечислены все АктивныеШлюзы, доступные для среды mySampleEnv .

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

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

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

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

==== Тело ответа ====
 <code>{
   "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"
     }
   ]
 }</code>

==== Код ответа ====
200