Редактировать глобальную конфигурацию

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

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

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

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

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

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

Параметры

Параметр Тип Описание В необходимые
тело Конфигурация глобального автоматического обновления Active Gate Тело запроса в формате JSON, содержащее глобальные параметры автообновления. тело по желанию

Формат тела

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

ActiveGateGlobalAutoUpdateConfig объект

Глобальная конфигурация автообновления АктивныхШлюзов.

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

Этот параметр наследуется всеми АктивныхШлюзов, у которых есть этот INHERITEDпараметр.

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

  • ВКЛЮЧЕНО
  • ИНВАЛИД
обязательный
  • Модель JSON

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

{
  "globalSetting": "ENABLED",
  "metadata": {
    "currentConfigurationVersions": [
      "1.0.4",
      "1.23"
    ],
    "clusterVersion": "1.192.1",
    "configurationVersions": [
      4,
      2
    ]
  }
}

Ответ

Коды ответов

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

Тело ответа

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

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

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

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

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

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

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

Ответ

Коды ответов

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

Тело ответа

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