GET информацию о конкретном АктивномШлюзе

Материал из Документация Ключ-АСТРОМ

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).
тип нить Тип модуля АктивногоШлюза.

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

атрибуты объект Атрибуты модуля АктивногоШлюза.
версия нить Версия модуля АктивногоШлюза.
включено логический Модуль включен ( 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/api/v2/activeGates/876651882' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

URL запроса

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

Источник — https://doc.fit4u.kz/index.php?title=GET_информацию_о_конкретном_АктивномШлюзе&oldid=3537