Редактировать АктивныйШлюз: различия между версиями
ENetrebin (обсуждение | вклад) |
ENetrebin (обсуждение | вклад) |
||
| (не показаны 2 промежуточные версии этого же участника) | |||
| Строка 1: | Строка 1: | ||
'''''[[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|АктивныеШлюзы]] / Конфигурация автообновления / Редактировать АктивныйШлюз''''' | |||
Редактирует конфигурацию автообновления указанной среды АктивногоШлюза. | Редактирует конфигурацию автообновления указанной среды АктивногоШлюза. | ||
Запрос потребляет <code>application/json</code>полезную нагрузку. | Запрос потребляет <code>application/json</code>полезную нагрузку. | ||
{| class="wikitable" | {| class="wikitable" | ||
| | |PUT | ||
| | | | ||
* Managed https: // {ваш-домен} / e / {ваш-идентификатор-среды} / api / v2 / activeGates / {agId} / autoUpdate | * Managed https: // {ваш-домен} / e / {ваш-идентификатор-среды} / api / v2 / activeGates / {agId} / autoUpdate | ||
* Среда АктивногоШлюза https: // {your-activegate-domain} / e / {your-environment-id} / api / v2 / activeGates / {agId} / autoUpdate | * Среда АктивногоШлюза https: // {your-activegate-domain} / e / {your-environment-id} / api / v2 / activeGates / {agId} / autoUpdate | ||
|} | |} | ||
| Строка 18: | Строка 19: | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !In | ||
! | !необходимость | ||
|- | |- | ||
| | |старение | ||
| | |string | ||
|ID необходимого АктивногоШлюза. | |ID необходимого АктивногоШлюза. | ||
| | |path | ||
|обязательный | |обязательный | ||
|- | |- | ||
| | |body | ||
| | |АктивныйШлюз Auto Update Config | ||
|Тело запроса в формате JSON, содержащее параметры автообновления. | |Тело запроса в формате JSON, содержащее параметры автообновления. | ||
| | |body | ||
|по желанию | |по желанию | ||
|} | |} | ||
| Строка 47: | Строка 48: | ||
|- | |- | ||
|параметр | |параметр | ||
| | |string | ||
|Состояние автообновления АктивногоШлюза: включено, отключено или унаследовано. | |Состояние автообновления АктивногоШлюза: включено, отключено или унаследовано. | ||
| Строка 90: | Строка 91: | ||
Запрос потребляет <code>application/json</code>полезную нагрузку. | Запрос потребляет <code>application/json</code>полезную нагрузку. | ||
{| class="wikitable" | {| class="wikitable" | ||
| | |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 | * Среда АктивногоШлюза https: // {your-activegate-domain} / e / {your-environment-id} / api / v2 / activeGates / {agId} / autoUpdate / validator | ||
|} | |} | ||
Текущая версия на 18:14, 2 июня 2024
API Ключ-АСТРОМ / Эндпойнты среды / АктивныеШлюзы / Конфигурация автообновления / Редактировать АктивныйШлюз
Редактирует конфигурацию автообновления указанной среды АктивногоШлюза.
Запрос потребляет application/jsonполезную нагрузку.
| PUT |
|
Аутентификация
Для выполнения этого запроса вам необходимо разрешение Write АктивныхШлюзов( activeGates.write), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | необходимость |
|---|---|---|---|---|
| старение | string | ID необходимого АктивногоШлюза. | path | обязательный |
| body | АктивныйШлюз Auto Update Config | Тело запроса в формате JSON, содержащее параметры автообновления. | body | по желанию |
Формат тела
- Параметры запроса
ActiveGateAutoUpdateConfig объект
Настройка автообновлений АктивногоШлюза.
| Элемент | Тип | Описание | необходимые |
|---|---|---|---|
| параметр | string | Состояние автообновления АктивногоШлюза: включено, отключено или унаследовано.
Если установлено значение Элемент может содержать эти значения
|
обязательный |
- Модель JSON
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
{
"setting": "INHERITED",
"effectiveSetting": "ENABLED"
}
Ответ
Коды ответов
| Код | Описание |
|---|---|
| 204 | Успех. Конфигурация автообновления обновлена. У ответа нет тела. |
| 400 | Не удалось. Введены неверные данные. |
Тело ответа
Успешный запрос не возвращает никакого содержания.
Проверить полезную нагрузку
Мы рекомендуем вам проверить полезную нагрузку, прежде чем отправлять ее с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку.
Запрос потребляет application/jsonполезную нагрузку.
| POST |
|
Аутентификация
Для выполнения этого запроса вам необходимо разрешение Write АктивныхШлюзов( activeGates.write), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .
Ответ
Коды ответов
| Код | Описание |
|---|---|
| 204 | Подтверждено. Представленная конфигурация автообновления действительна. У ответа нет тела. |
| 400 | Не удалось. Введены неверные данные. |
Тело ответа
Успешный запрос не возвращает никакого содержания.
