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

Версия от 14:04, 24 декабря 2024

API АппОптима / Эндпойнты среды / АктивныеШлюзы / Информация / GET информацию о конкретном АктивномШлюзе

Получает информацию об указанном АктивномШлюзе.

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

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

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

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

Параметры

Параметр	Тип	Описание	In	необходимость
старение	string	ID необходимого АктивногоШлюза.	path	обязательный

Ответ

Коды ответов

Код	Описание
200	Успех
404	Не найден. См. Подробности в теле ответа.

Тело ответа

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

АктивныйШлюз объект

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

Элемент	Тип	Описание
id	string	Идентификатор АктивногоШлюза.
networkAddresses	string []	Список сетевых адресов АктивногоШлюза.
loadBalancerAddresses	string []	Список адресов Load Balancer АктивногоШлюза.
osType	string	Тип ОС, на которой работает АктивныйШлюз. Элемент может содержать эти значения
autoUpdateStatus	string	Текущий статус автообновлений АктивногоШлюза. Элемент может содержать эти значения
offline	целое число	Отметка времени, с которой АктивныйШлюз отключен. `null`Значение означает АктивныйШлюз онлайн.
версия	string	Текущая версия АктивногоШлюза в `<major>.<minor>.<revision>.<timestamp>`формате.
тип	string	Тип АктивногоШлюза. Элемент может содержать эти значения
имя хоста	string	Имя хоста, на котором работает АктивныйШлюз.
mainEnvironment	string	Идентификатор основной среды для АктивногоШлюза с несколькими средами.
окружающая среда	string[]	Список сред (заданных идентификаторами), к которым АктивныйШлюз может подключиться.
autoUpdateSettings	АктивныйШлюз Auto Update Config
networkZone	string	Сетевая зона АктивногоШлюза.
группа	string	Группа АктивногоШлюза.
модули	АктивныйШлюз модуль []	Список модулей АктивногоШлюза.
контейнерный	логический	АктивныйШлюз развертывается в контейнере ( `true`) или нет ( `false`).

Модуль АктивногоШлюза

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

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

ActiveGateAutoUpdateConfig объект

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

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

Модель JSON

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

Пример

В этом примере в запросе перечислены параметры АктивногоШлюза с идентификатором 876651882 .

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

Curl

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

URL запроса

https://mySampleEnv.live.AppOptima.com/api/v2/activeGates/876651882

Тело ответа

<{
  "id": "876651882",
  "networkAddresses": [
        "orange-13.easytravel.com",
        "228.245.125.39"
    ],
    "osType": "LINUX",
    "autoUpdateStatus": "UPDATE_IN_PROGRESS",
    "offlineSince": null,
    "version": "1.198.0.20200630-163221",
    "type": "ENVIRONMENT",
    "hostname": "orange-13.easytravel.com",
    "mainEnvironment": null,
    "environments": [
        "mySampleEnv"
    ],
    "networkZone": "easytravel.europe.austria.05"
}

Код ответа

200

@@ Строка 1: / Строка 1: @@
-'''''[[API АппОптима]] / Эндпойнты среды / [[API Ключ-АСТРОМ#.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 информацию о конкретном АктивномШлюзе'''''
+'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C%20%D0%BA%D0%BE%D0%B4-,%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,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C АктивныеШлюзы] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C%20%D0%BA%D0%BE%D0%B4-,%D0%98%D0%BD%D1%84%D0%BE%D1%80%D0%BC%D0%B0%D1%86%D0%B8%D1%8F,-GET%20%D0%B8%D0%BD%D1%84%D0%BE%D1%80%D0%BC%D0%B0%D1%86%D0%B8%D1%8E%20%D0%BE Информация] / GET информацию о конкретном АктивномШлюзе'''''
 Получает информацию об указанном АктивномШлюзе.
@@ Строка 199: / Строка 199: @@
     ],
     "containerized": true
-  }</code>
+  }
 ==Пример==
 В этом примере в запросе перечислены параметры АктивногоШлюза с идентификатором 876651882 .
@@ Строка 206: / Строка 206: @@
 ====Curl====
   <curl -L -X GET '<nowiki>https://mySampleEnv.live.AppOptima.com/api/v2/activeGates/876651882'</nowiki> \
-  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
+  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
 ====URL запроса====
   <code><nowiki>https://mySampleEnv.live.AppOptima.com/api/v2/activeGates/876651882</nowiki></code>
@@ Строка 227: / Строка 227: @@
       ],
       "networkZone": "easytravel.europe.austria.05"
-  }</code>
+  }
 ====Код ответа====