GET АктивныйШлюз

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

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

Получает конфигурацию автоматического обновления указанной среды АктивногоШлюза.

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

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

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

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

Параметры

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

Ответ

Коды ответов

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

Тело ответа

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

ActiveGateAutoUpdateConfig объект

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

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

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

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

  • INVALID
  • ВКЛЮЧЕНО
  • Унаследованный
EffectiveSetting string Фактическое состояние автообновления АктивногоШлюза.

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

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

  • ВКЛЮЧЕНО
  • INVALID
  • Модель JSON
{
  "setting": "INHERITED",
  "effectiveSetting": "ENABLED"
}