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

Материал из Документация Ключ-АСТРОМ
(Новая страница: «Перечисляет все АктивныеШлюзы, которые в настоящее время подключены к среде или были по...»)
 
 
(не показаны 2 промежуточные версии этого же участника)
Строка 1: Строка 1:
'''''[https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C API Ключ-АСТРОМ] / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B_.D1.81.D1.80.D0.B5.D0.B4.D1.8B Эндпойнты среды] / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C#.D0.90.D0.BA.D1.82.D0.B8.D0.B2.D0.BD.D1.8B.D0.B5.D0.A8.D0.BB.D1.8E.D0.B7.D1.8B АктивныеШлюзы] / Информация / GET информацию о всех АктивныхШлюзах'''''
Перечисляет все АктивныеШлюзы, которые в настоящее время подключены к среде или были подключены в течение последних 2 часов.
Перечисляет все АктивныеШлюзы, которые в настоящее время подключены к среде или были подключены в течение последних 2 часов.


Строка 175: Строка 177:
|400
|400
|ErrorEnvelope
|ErrorEnvelope
|Неуспешный. Ввод недействителен.
|Неуспешно. Ввод недействителен.
|}
|}
===Объекты тела ответа===
===Объекты тела ответа===
====Объект _ <code>ActiveGateList</code>====
====Объект <code>ActiveGateList</code>====
Список АктивныхШлюзов.
Список АктивныхШлюзов.
{| class="wikitable"
{| class="wikitable"
Строка 189: Строка 191:
|Список АктивногоШлюза.
|Список АктивногоШлюза.
|}
|}
====Объект _ <code>ActiveGate</code>====
====Объект <code>ActiveGate</code>====
Параметры АктивногоШлюза.
Параметры АктивногоШлюза.
{| class="wikitable"
{| class="wikitable"
Строка 197: Строка 199:
|-
|-
|идентификатор
|идентификатор
|нить
|string
|Идентификатор АктивногоШлюза.
|Идентификатор АктивногоШлюза.
|-
|-
|сетевые адреса
|сетевые адреса
|строка []
|string []
|Список сетевых адресов АктивногоШлюза.
|Список сетевых адресов АктивногоШлюза.
|-
|-
|loadBalancerAddresses
|loadBalancerAddresses
|строка []
|string []
|Список адресов балансировщика нагрузки АктивногоШлюза.
|Список адресов балансировщика нагрузки АктивногоШлюза.
|-
|-
|тип ОС
|тип ОС
|нить
|string
|Тип ОС, на которой работает АктивныйШлюз.
|Тип ОС, на которой работает АктивныйШлюз.
Элемент может содержать эти значения
Элемент может содержать эти значения
Строка 216: Строка 218:
|-
|-
|ОСАрхитектура
|ОСАрхитектура
|нить
|string
|Архитектура ОС, на которой работает АктивныйШлюз.
|Архитектура ОС, на которой работает АктивныйШлюз.
Элемент может содержать эти значения
Элемент может содержать эти значения
Строка 223: Строка 225:
|-
|-
|осбитнесс
|осбитнесс
|нить
|string
|Разрядность ОС, на которой работает АктивныйШлюз.
|Разрядность ОС, на которой работает АктивныйШлюз.
Элемент может содержать эти значения
Элемент может содержать эти значения
Строка 229: Строка 231:
|-
|-
|autoUpdateStatus
|autoUpdateStatus
|нить
|string
|Текущий статус автообновлений АктивногоШлюза.
|Текущий статус автообновлений АктивногоШлюза.
Элемент может содержать эти значения
Элемент может содержать эти значения
Строка 248: Строка 250:
|-
|-
|версия
|версия
|нить
|string
|Текущая версия АктивногоШлюза в <code><major>.<minor>.<revision>.<timestamp></code>формате.
|Текущая версия АктивногоШлюза в <code><major>.<minor>.<revision>.<timestamp></code>формате.
|-
|-
|тип
|тип
|нить
|string
|Тип АктивногоШлюза.
|Тип АктивногоШлюза.
Элемент может содержать эти значения
Элемент может содержать эти значения
Строка 260: Строка 262:
|-
|-
|имя хоста
|имя хоста
|нить
|string
|Имя хоста, на котором работает АктивныйШлюз.
|Имя хоста, на котором работает АктивныйШлюз.
|-
|-
|mainEnvironment
|mainEnvironment
|нить
|string
|Идентификатор основной среды для АктивногоШлюза с несколькими средами.
|Идентификатор основной среды для АктивногоШлюза с несколькими средами.
|-
|-
|среды
|среды
|строка []
|string []
|Список сред (определяемых идентификаторами), к которым может подключаться АктивныйШлюз.
|Список сред (определяемых идентификаторами), к которым может подключаться АктивныйШлюз.
|-
|-
|автообновление настроек
|автообновление настроек
|Конфигурация автоматического обновления Active Gate
|Конфигурация автоматического обновления АктивногоШлюза
|Настройка автообновлений АктивногоШлюза.
|Настройка автообновлений АктивногоШлюза.
|-
|-
|networkZone
|networkZone
|нить
|string
|Сетевая зона АктивногоШлюза.
|Сетевая зона АктивногоШлюза.
|-
|-
|группа
|группа
|нить
|string
|Группа АктивногоШлюз.
|Группа АктивногоШлюз.
|-
|-
|модули
|модули
|Активный модуль ворот []
|Модуль АктивногоШлюза []
|Список модулей АктивногоШлюза.
|Список модулей АктивногоШлюза.
|-
|-
Строка 292: Строка 294:
|-
|-
|подключенные хосты
|подключенные хосты
|Хосты , подключенные к Active Gate
|Хосты , подключенные к АктивномуШлюзу
|Информация о хостах, подключенных в данный момент к АктивногоШлюза
|Информация о хостах, подключенных в данный момент к АктивногоШлюза
|-
|-
|ActiveGateTokens
|ActiveGateTokens
|Информация о токене активного шлюза Dto []
|Информация о токене АктивногоШлюза Dto []
|Список токенов АктивногоШлюза.
|Список токенов АктивногоШлюза.
|}
|}
====Объект _ <code>ActiveGateAutoUpdateConfig</code>====
====Объект <code>ActiveGateAutoUpdateConfig</code>====
Настройка автообновлений АктивногоШлюза.
Настройка автообновлений АктивногоШлюза.
{| class="wikitable"
{| class="wikitable"
Строка 307: Строка 309:
|-
|-
|параметр
|параметр
|нить
|string
|Состояние автообновления АктивногоШлюза: включено, отключено или унаследовано.
|Состояние автообновления АктивногоШлюза: включено, отключено или унаследовано.
Если установлено значение <code>INHERITED</code>, параметр наследуется от глобального набора конфигурации на уровне среды или управляемого кластера.
Если установлено значение <code>INHERITED</code>, параметр наследуется от глобального набора конфигурации на уровне среды или управляемого кластера.
Элемент может содержать эти значения
|-
|-
|эффективная настройка
|эффективная настройка
|нить
|string
|Фактическое состояние автообновления АктивногоШлюза.
|Фактическое состояние автообновления АктивногоШлюза.
Применимо, только если для параметра настройки установлено значение <code>INHERITED</code>. В этом случае значение берется из родительской настройки. В противном случае это просто дубликат значения параметра .
Применимо, только если для параметра настройки установлено значение <code>INHERITED</code>. В этом случае значение берется из родительской настройки. В противном случае это просто дубликат значения параметра .
Элемент может содержать эти значения
|}
|}
====Объект _ <code>ActiveGateModule</code>====
====Объект <code>ActiveGateModule</code>====
Информация о модуле АктивногоШлюза
Информация о модуле АктивногоШлюза
{| class="wikitable"
{| class="wikitable"
Строка 332: Строка 330:
|-
|-
|версия
|версия
|нить
|string
|Версия модуля АктивногоШлюза.
|Версия модуля АктивногоШлюза.
|-
|-
Строка 340: Строка 338:
|-
|-
|тип
|тип
|нить
|string
|Тип модуля АктивногоШлюза.
|Тип модуля АктивногоШлюза.
Элемент может содержать эти значения
Элемент может содержать эти значения
Строка 357: Строка 355:
|число
|число
|целое число
|целое число
|Количество хостов, в настоящее время подключенных к ActiveGate
|Количество хостов, в настоящее время подключенных к АктивномуШлюзу
|}
|}
====Объект _ <code>ActiveGateTokenInfoDto</code>====
====Объект <code>ActiveGateTokenInfoDto</code>====
Информация о токене АктивногоШлюза.
Информация о токене АктивногоШлюза.
{| class="wikitable"
{| class="wikitable"
Строка 367: Строка 365:
|-
|-
|идентификатор среды
|идентификатор среды
|нить
|string
|Идентификатор среды, к которой принадлежит токен.
|Идентификатор среды, к которой принадлежит токен.
Доступно, только если поддерживается более одной среды.
Доступно, только если поддерживается более одной среды.
|-
|-
|идентификатор
|идентификатор
|нить
|string
|Идентификатор токена АктивногоШлюза, состоящий из префикса и общедоступной части токена.
|Идентификатор токена АктивногоШлюза, состоящий из префикса и общедоступной части токена.
|-
|-
|состояние
|состояние
|нить
|string
|Состояние токена АктивногоШлюза.
|Состояние токена АктивногоШлюза.
Элемент может содержать эти значения
Элемент может содержать эти значения
Строка 439: Строка 437:
Результат усекается до двух записей.
Результат усекается до двух записей.
====Curl====
====Curl====
  <code>curl -L -X GET '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/activeGates'</nowiki> \
  <code>curl -L -X GET '<nowiki>https://mySampleEnv.live.astromkey.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.ruscomtech.ru/api/v2/activeGates</nowiki></code>
  <code><nowiki>https://mySampleEnv.live.astromkey.ru/api/v2/activeGates</nowiki></code>
====Тело ответа====
====Тело ответа====
  <code>{
  <code>{

Текущая версия на 14:59, 5 июня 2024

API Ключ-АСТРОМ / Эндпойнты среды / АктивныеШлюзы / Информация / GET информацию о всех АктивныхШлюзах

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

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

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

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

  • LINUX
  • WINDOWS
ОСАрхитектура string Архитектура ОС, на которой работает АктивныйШлюз.

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

  • S390
  • X86
осбитнесс string Разрядность ОС, на которой работает АктивныйШлюз.

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

  • 64
autoUpdateStatus string Текущий статус автообновлений АктивногоШлюза.

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

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

Значение nullозначает, что АктивныйШлюз находится в сети.

версия string Текущая версия АктивногоШлюза в <major>.<minor>.<revision>.<timestamp>формате.
тип string Тип АктивногоШлюза.

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

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

Объект ActiveGateAutoUpdateConfig

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

Элемент Тип Описание
параметр string Состояние автообновления АктивногоШлюза: включено, отключено или унаследовано.

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

эффективная настройка string Фактическое состояние автообновления АктивногоШлюза.

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

Объект ActiveGateModule

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

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

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

атрибуты объект Атрибуты модуля АктивногоШлюза.

Объект ActiveGateConnectedHosts

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

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

Объект ActiveGateTokenInfoDto

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

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

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

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

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

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.astromkey.ru/api/v2/activeGates' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

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

https://mySampleEnv.live.astromkey.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