Редактировать АктивныйШлюз

Материал из Документация Ключ-АСТРОМ
Версия от 18:14, 2 июня 2024; ENetrebin (обсуждение | вклад)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

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

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

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

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

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

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

Параметры

Параметр Тип Описание In необходимость
старение string ID необходимого АктивногоШлюза. path обязательный
body АктивныйШлюз Auto Update Config Тело запроса в формате JSON, содержащее параметры автообновления. body по желанию

Формат тела

  • Параметры запроса

ActiveGateAutoUpdateConfig объект

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

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

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

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

  • invalid
  • ВКЛЮЧЕНО
  • Унаследованный
обязательный
  • Модель JSON

Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.

{
  "setting": "INHERITED",
  "effectiveSetting": "ENABLED"
}

Ответ

Коды ответов

Код Описание
204 Успех. Конфигурация автообновления обновлена. У ответа нет тела.
400 Не удалось. Введены неверные данные.

Тело ответа

Успешный запрос не возвращает никакого содержания.

Проверить полезную нагрузку

Мы рекомендуем вам проверить полезную нагрузку, прежде чем отправлять ее с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку.

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

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

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

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

Ответ

Коды ответов

Код Описание
204 Подтверждено. Представленная конфигурация автообновления действительна. У ответа нет тела.
400 Не удалось. Введены неверные данные.

Тело ответа

Успешный запрос не возвращает никакого содержания.