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

Текущая версия на 16:40, 3 октября 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	Фильтрует результирующий набор АктивныхШлюзов на те, у которых токен авторизации находится в указанном состоянии. Элемент может содержать эти значения `ABSENT` `EXPIRING` `INVALID` `UNKNOWN` `UNSUPPORTED` `VALID`	query	по желанию
tokenExpirationSet	boolean	Фильтрует результирующий набор АктивныхШлюзов на те, у которых установлена дата истечения срока действия токена авторизации.	query	по желанию

Ответ

Коды ответов

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

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

Объект _ `ActiveGateList`

Список АктивныхШлюзов.

Элемент	Тип	Описание
ActiveGate	ActiveGate []	Список АктивногоШлюза.

Объект _ `ActiveGate`

Параметры АктивногоШлюза.

Элемент	Тип	Описание
идентификатор	нить	Идентификатор АктивногоШлюза.
сетевые адреса	строка []	Список сетевых адресов АктивногоШлюза.
loadBalancerAddresses	строка []	Список адресов балансировщика нагрузки АктивногоШлюза.
тип ОС	нить	Тип ОС, на которой работает АктивныйШлюз. Элемент может содержать эти значения `LINUX` `WINDOWS`
ОСАрхитектура	нить	Архитектура ОС, на которой работает АктивныйШлюз. Элемент может содержать эти значения `S390` `X86`
осбитнесс	нить	Разрядность ОС, на которой работает АктивныйШлюз. Элемент может содержать эти значения `64`
autoUpdateStatus	нить	Текущий статус автообновлений АктивногоШлюза. Элемент может содержать эти значения `INCOMPATIBLE` `OUTDATED` `SCHEDULED` `SUPPRESSED` `UNKNOWN` `UP2DATE` `UPDATE_IN_PROGRESS` `UPDATE_PENDING` `UPDATE_PROBLEM`
offlineSince	целое число	Отметка времени с момента, когда АктивныйШлюз находится в автономном режиме. Значение `null`означает, что АктивныйШлюз находится в сети.
версия	нить	Текущая версия АктивногоШлюза в `<major>.<minor>.<revision>.<timestamp>`формате.
тип	нить	Тип АктивногоШлюза. Элемент может содержать эти значения `CLUSTER` `ENVIRONMENT` `ENVIRONMENT_MULTI`
имя хоста	нить	Имя хоста, на котором работает АктивныйШлюз.
mainEnvironment	нить	Идентификатор основной среды для АктивногоШлюза с несколькими средами.
среды	строка []	Список сред (определяемых идентификаторами), к которым может подключаться АктивныйШлюз.
автообновление настроек	Конфигурация автоматического обновления Active Gate	Настройка автообновлений АктивногоШлюза.
networkZone	нить	Сетевая зона АктивногоШлюза.
группа	нить	Группа АктивногоШлюз.
модули	Активный модуль ворот []	Список модулей АктивногоШлюза.
контейнерный	логический	АктивныйШлюз развернут в контейнере ( `true`) или нет ( `false`).
подключенные хосты	Хосты , подключенные к Active Gate	Информация о хостах, подключенных в данный момент к АктивногоШлюза
ActiveGateTokens	Информация о токене активного шлюза Dto []	Список токенов АктивногоШлюза.

Объект _ `ActiveGateAutoUpdateConfig`

Настройка автообновлений АктивногоШлюза.

Элемент	Тип	Описание
параметр	нить	Состояние автообновления АктивногоШлюза: включено, отключено или унаследовано. Если установлено значение `INHERITED`, параметр наследуется от глобального набора конфигурации на уровне среды или управляемого кластера. Элемент может содержать эти значения
эффективная настройка	нить	Фактическое состояние автообновления АктивногоШлюза. Применимо, только если для параметра настройки установлено значение `INHERITED`. В этом случае значение берется из родительской настройки. В противном случае это просто дубликат значения параметра . Элемент может содержать эти значения

Объект _ `ActiveGateModule`

Информация о модуле АктивногоШлюза

Элемент	Тип	Описание
неправильно сконфигурирован	логический	Модуль неправильно сконфигурирован ( `true`) или нет ( `false`).
версия	нить	Версия модуля АктивногоШлюза.
включено	логический	Модуль включен ( `true`) или отключен ( `false`).
тип	нить	Тип модуля АктивногоШлюза. Элемент может содержать эти значения
атрибуты	объект	Атрибуты модуля АктивногоШлюза.

Объект `ActiveGateConnectedHosts`

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

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

Объект _ `ActiveGateTokenInfoDto`

Информация о токене АктивногоШлюза.

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

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"
        }
      ]
    }
  ]
}

Пример

В этом примере в запросе перечислены все АктивныеШлюзы, доступные для среды 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

Аноним

Поиск

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

Пространства имён

Ещё

Действия на странице

Текущая версия на 16:40, 3 октября 2023

Содержание

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

Параметры

Ответ

Коды ответов

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

Объект _ `ActiveGateList`

Объект _ `ActiveGate`

Объект _ `ActiveGateAutoUpdateConfig`

Объект _ `ActiveGateModule`

Объект `ActiveGateConnectedHosts`

Объект _ `ActiveGateTokenInfoDto`

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

Пример

Curl

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

Тело ответа

Код ответа

Навигация

Навигация

Вики-инструменты

Вики-инструменты

@@ Строка 163: / Строка 163: @@
 |tokenState
 |string
-|Фильтрует результирующий набор ActiveGates на те, у которых токен авторизации находится в указанном состоянии.
+|Фильтрует результирующий набор АктивныхШлюзов на те, у которых токен авторизации находится в указанном состоянии.
 Элемент может содержать эти значения
@@ Строка 187: / Строка 187: @@
 {| class="wikitable"
 !Код
+|Тип
 !Описание
 |-
 |200
+|Список активных шлюзов
 |Успех
 |-
 |400
-|Не удалось. Введены неверные данные.
+|ErrorEnvelope
+|Неуспешный. Ввод недействителен.
 |}
-=== Тело ответа ===
+=== Объекты тела ответа ===
-* Параметры ответа
+==== Объект _ <code>ActiveGateList</code> ====
-==== ActiveGateList объект ====
 Список АктивныхШлюзов.
 {| class="wikitable"
@@ Строка 207: / Строка 208: @@
 !Описание
 |-
-|activeGates
+|ActiveGate
 |ActiveGate []
-|Список АктивныхШлюзов.
+|Список АктивногоШлюза.
 |}
-==== ActiveGate объект ====
+==== Объект _ <code>ActiveGate</code> ====
 Параметры АктивногоШлюза.
-==== ActiveGateModule объект ====
-Информация о модуле ActiveGate
 {| class="wikitable"
 !Элемент
@@ Строка 222: / Строка 220: @@
 !Описание
 |-
-|неправильно настроен
+|идентификатор
-|логический
+|нить
-|Модуль неправильно сконфигурирован ( <code>true</code>) или нет ( <code>false</code>).
+|Идентификатор АктивногоШлюза.
+|-
+|сетевые адреса
+|строка []
+|Список сетевых адресов АктивногоШлюза.
+|-
+|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>формате.
 |-
 |тип
 |нить
-|Тип модуля ActiveGate.
+|Тип АктивногоШлюза.
 Элемент может содержать эти значения
-* AWS
+* <code>CLUSTER</code>
-* ЛАЗУРНЫЙ
+* <code>ENVIRONMENT</code>
-* BEACON_FORWARDER
+* <code>ENVIRONMENT_MULTI</code>
-* CLOUD_FOUNDRY
+|-
-* DB_INSIGHT
+|имя хоста
-* EXTENSIONS_V1
+|нить
-* EXTENSIONS_V2
+|Имя хоста, на котором работает АктивныйШлюз.
-* КУБЕРНЕТЫ
+|-
-* ЖУРНАЛЫ
+|mainEnvironment
-* MEMORY_DUMPS
+|нить
-* METRIC_API
+|Идентификатор основной среды для АктивногоШлюза с несколькими средами.
-* ONE_AGENT_ROUTING
-* OTLP_INGEST
-* REST_API
-* СИНТЕТИЧЕСКИЙ
-* VMWARE
-* Z_OS
 |-
-|атрибуты
+|среды
-|объект
+|строка []
-|Атрибуты модуля ActiveGate.
+|Список сред (определяемых идентификаторами), к которым может подключаться АктивныйШлюз.
+|-
+|автообновление настроек
+|Конфигурация автоматического обновления Active Gate
+|Настройка автообновлений АктивногоШлюза.
+|-
+|networkZone
+|нить
+|Сетевая зона АктивногоШлюза.
 |-
-|версия
+|группа
 |нить
-|Версия модуля ActiveGate.
+|Группа АктивногоШлюз.
+|-
+|модули
+|Активный модуль ворот []
+|Список модулей АктивногоШлюза.
 |-
-|включено
+|контейнерный
 |логический
-|Модуль включен ( <code>true</code>) или отключен ( <code>false</code>).
+|АктивныйШлюз развернут в контейнере ( <code>true</code>) или нет ( <code>false</code>).
+|-
+|подключенные хосты
+|Хосты , подключенные к Active Gate
+|Информация о хостах, подключенных в данный момент к АктивногоШлюза
+|-
+|ActiveGateTokens
+|Информация о токене активного шлюза Dto []
+|Список токенов АктивногоШлюза.
 |}
-==== ActiveGateAutoUpdateConfig объект ====
+==== Объект _ <code>ActiveGateAutoUpdateConfig</code> ====
-Настройка автообновлений ActiveGate.
+Настройка автообновлений АктивногоШлюза.
 {| class="wikitable"
 !Элемент
@@ Строка 272: / Строка 344: @@
 |параметр
 |нить
-|Состояние автообновления ActiveGate: включено, отключено или унаследовано.
+|Состояние автообновления АктивногоШлюза: включено, отключено или унаследовано.
+Если установлено значение <code>INHERITED</code>, параметр наследуется от глобального набора конфигурации на уровне среды или управляемого кластера.
+Элемент может содержать эти значения
+|-
+|эффективная настройка
+|нить
+|Фактическое состояние автообновления АктивногоШлюза.
-Если установлено значение <code>INHERITED</code>, параметр наследуется из глобальной конфигурации, установленной на уровне среды или управляемого кластера.
+Применимо, только если для параметра настройки установлено значение <code>INHERITED</code>. В этом случае значение берется из родительской настройки. В противном случае это просто дубликат значения параметра .
 Элемент может содержать эти значения
+|}
-* ИНВАЛИД
+==== Объект _ <code>ActiveGateModule</code> ====
-* ВКЛЮЧЕНО
+Информация о модуле АктивногоШлюза
-* Унаследованный
+{| class="wikitable"
+!Элемент
+!Тип
+!Описание
+|-
+|неправильно сконфигурирован
+|логический
+|Модуль неправильно сконфигурирован ( <code>true</code>) или нет ( <code>false</code>).
 |-
-|EffectiveSetting
+|версия
 |нить
-|Фактическое состояние автообновления ActiveGate.
+|Версия модуля АктивногоШлюза.
+|-
-Применимо, только если параметр настройки установлен на <code>INHERITED</code>. В этом случае значение берется из родительской настройки. В противном случае это просто дубликат значения настройки .
+|включено
+|логический
+|Модуль включен ( <code>true</code>) или отключен ( <code>false</code>).
+|-
+|тип
+|нить
+|Тип модуля АктивногоШлюза.
 Элемент может содержать эти значения
+|-
+|атрибуты
+|объект
+|Атрибуты модуля АктивногоШлюза.
+|}
-* ВКЛЮЧЕНО
+==== Объект  <code>ActiveGateConnectedHosts</code> ====
-* ИНВАЛИД
+Информация о хостах, подключенных в данный момент к АктивномуШлюзу
+{| class="wikitable"
+!Элемент
+!Тип
+!Описание
+|-
+|число
+|целое число
+|Количество хостов, в настоящее время подключенных к ActiveGate
 |}
-* Модель JSON
+==== Объект _ <code>ActiveGateTokenInfoDto</code> ====
+Информация о токене АктивногоШлюза.
+{| class="wikitable"
+!Элемент
+!Тип
+!Описание
+|-
+|идентификатор среды
+|нить
+|Идентификатор среды, к которой принадлежит токен.
+Доступно, только если поддерживается более одной среды.
+|-
+|идентификатор
+|нить
+|Идентификатор токена АктивногоШлюза, состоящий из префикса и общедоступной части токена.
+|-
+|состояние
+|нить
+|Состояние токена АктивногоШлюза.
+Элемент может содержать эти значения
+|}
+=== JSON-модель тела ответа ===
   <code>{
     "activeGates": [
@@ Строка 307: / Строка 437: @@
         ],
         "osType": "WINDOWS",
+       "osArchitecture": "X86",
+       "osBitness": "64",
         "autoUpdateStatus": "OUTDATED",
         "offlineSince": 1582031917814,
@@ Строка 325: / Строка 457: @@
           {
             "misconfigured": true,
+           "version": "string",
+           "enabled": true,
             "type": "KUBERNETES",
-            "attributes": {},
+            "attributes": {}
-           "version": "string",
-           "enabled": true
           }
         ],
-        "containerized": true
+        "containerized": true,
+       "connectedHosts": {
+         "number": 150
+       },
+       "activeGateTokens": [
+         {
+           "environmentId": "string",
+           "id": "dt0g02.4KWZO5EF",
+           "state": "ABSENT"
+         }
+       ]
       }
     ]
   }</code>
 == Пример ==
-В этом примере в запросе перечислены все ActiveGates, доступные для среды mySampleEnv .
+В этом примере в запросе перечислены все АктивныеШлюзы, доступные для среды mySampleEnv .
-Токен API передается в заголовке авторизации .
+Маркер 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 запроса ====
+==== URL-адрес запроса ====
   <code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/activeGates</nowiki></code>

Аноним

Поиск

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

Текущая версия на 16:40, 3 октября 2023

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

Параметры

Ответ

Коды ответов

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

Объект _ ActiveGateList

Объект _ ActiveGate

Объект _ ActiveGateAutoUpdateConfig

Объект _ ActiveGateModule

Объект ActiveGateConnectedHosts

Объект _ ActiveGateTokenInfoDto

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

Пример

Curl

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

Тело ответа

Код ответа

Навигация

Вики-инструменты

Инструменты для страниц

Объект _ `ActiveGateList`

Объект _ `ActiveGate`

Объект _ `ActiveGateAutoUpdateConfig`

Объект _ `ActiveGateModule`

Объект `ActiveGateConnectedHosts`

Объект _ `ActiveGateTokenInfoDto`