Редактировать глобальную конфигурацию: различия между версиями
ENetrebin (обсуждение | вклад) (Новая страница: «Редактирует глобальную конфигурацию автообновления Environment ActiveGates. Запрос потребляет <cod...») |
ENetrebin (обсуждение | вклад) |
||
(не показаны 4 промежуточные версии этого же участника) | |||
Строка 1: | Строка 1: | ||
Редактирует глобальную конфигурацию автообновления Environment | '''''[[API Ключ-АСТРОМ]] / [[API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндпойнты среды]] / [[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|АктивныеШлюзы]] / Конфигурация автообновления / Редактировать глобальную конфигурацию''''' | ||
Редактирует глобальную конфигурацию автообновления Environment АктивногоШлюза. | |||
Запрос потребляет <code>application/json</code>полезную нагрузку. | Запрос потребляет <code>application/json</code>полезную нагрузку. | ||
{| class="wikitable" | {| class="wikitable" | ||
| | |PUT | ||
| | | | ||
* | * Managed https: // {ваш-домен} / e / {ваш-идентификатор-среды} / api / v2 / activeGates / autoUpdate | ||
* Среда АктивногоШлюза https: // {ваш-activegate-domain} / e / {your-environment-id} / api / v2 / activeGates / autoUpdate | |||
* Среда | |||
|} | |} | ||
== Аутентификация == | == Аутентификация == | ||
Для выполнения этого запроса вам необходимо разрешение Write | Для выполнения этого запроса вам необходимо разрешение Write АктивныеШлюзы ( <code>activeGates.write</code>), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация . | ||
== Параметры == | == Параметры == | ||
Строка 18: | Строка 19: | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !In | ||
! | !необходимость | ||
|- | |- | ||
| | |body | ||
|Конфигурация глобального автоматического обновления | |Конфигурация глобального автоматического обновления АктивногоШлюза | ||
|Тело запроса в формате JSON, содержащее глобальные параметры автообновления. | |Тело запроса в формате JSON, содержащее глобальные параметры автообновления. | ||
| | |body | ||
|по желанию | |по желанию | ||
|} | |} | ||
Строка 33: | Строка 34: | ||
==== ActiveGateGlobalAutoUpdateConfig объект ==== | ==== ActiveGateGlobalAutoUpdateConfig объект ==== | ||
Глобальная конфигурация автообновления | Глобальная конфигурация автообновления АктивныхШлюзов. | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
Строка 41: | Строка 42: | ||
|- | |- | ||
|глобальные настройки | |глобальные настройки | ||
| | |string | ||
|Состояние автообновлений для всех | |Состояние автообновлений для всех АктивныхШлюзов, подключенных к среде или управляемому кластеру. | ||
Этот параметр наследуется всеми | Этот параметр наследуется всеми АктивныхШлюзов, у которых есть этот <code>INHERITED</code>параметр. | ||
Элемент может содержать эти значения | Элемент может содержать эти значения | ||
* ВКЛЮЧЕНО | * ВКЛЮЧЕНО | ||
* | * INVALID | ||
|обязательный | |обязательный | ||
|} | |} | ||
Строка 93: | Строка 94: | ||
Запрос потребляет <code>application/json</code>полезную нагрузку. | Запрос потребляет <code>application/json</code>полезную нагрузку. | ||
{| class="wikitable" | {| class="wikitable" | ||
| | |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 | Для выполнения этого запроса вам необходимо разрешение Write АктивныеШлюзы ( <code>activeGates.write</code>), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация . | ||
=== Ответ === | === Ответ === |
Текущая версия на 17:34, 2 июня 2024
API Ключ-АСТРОМ / Эндпойнты среды / АктивныеШлюзы / Конфигурация автообновления / Редактировать глобальную конфигурацию
Редактирует глобальную конфигурацию автообновления Environment АктивногоШлюза.
Запрос потребляет application/json
полезную нагрузку.
PUT |
|
Аутентификация
Для выполнения этого запроса вам необходимо разрешение Write АктивныеШлюзы ( activeGates.write
), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .
Параметры
Параметр | Тип | Описание | In | необходимость |
---|---|---|---|---|
body | Конфигурация глобального автоматического обновления АктивногоШлюза | Тело запроса в формате JSON, содержащее глобальные параметры автообновления. | body | по желанию |
Формат тела
- Параметры запроса
ActiveGateGlobalAutoUpdateConfig объект
Глобальная конфигурация автообновления АктивныхШлюзов.
Элемент | Тип | Описание | необходимые |
---|---|---|---|
глобальные настройки | string | Состояние автообновлений для всех АктивныхШлюзов, подключенных к среде или управляемому кластеру.
Этот параметр наследуется всеми АктивныхШлюзов, у которых есть этот Элемент может содержать эти значения
|
обязательный |
- Модель JSON
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
{
"globalSetting": "ENABLED",
"metadata": {
"currentConfigurationVersions": [
"1.0.4",
"1.23"
],
"clusterVersion": "1.192.1",
"configurationVersions": [
4,
2
]
}
}
Ответ
Коды ответов
Код | Описание |
---|---|
204 | Успех. Конфигурация глобального автообновления обновлена. У ответа нет тела. |
400 | Не удалось. Введены неверные данные. |
Тело ответа
Успешный запрос не возвращает никакого содержания.
Проверить полезную нагрузку
Мы рекомендуем вам проверить полезную нагрузку, прежде чем отправлять ее с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку.
Запрос потребляет application/json
полезную нагрузку.
POST |
|
Аутентификация
Для выполнения этого запроса вам необходимо разрешение Write АктивныеШлюзы ( activeGates.write
), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .
Ответ
Коды ответов
Код | Описание |
---|---|
204 | Подтверждено. Представленная конфигурация действительна. У ответа нет тела. |
400 | Не удалось. Введены неверные данные. |
Тело ответа
Успешный запрос не возвращает никакого содержания.