ENetrebin (обсуждение | вклад) Нет описания правки |
Нет описания правки |
||
| (не показано 5 промежуточных версий 2 участников) | |||
| Строка 1: | Строка 1: | ||
Редактирует конфигурацию автообновления указанной среды | '''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C%20%D0%BA%D0%BE%D0%B4-,%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,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C АктивныеШлюзы] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%9A%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B0%D1%86%D0%B8%D1%8F%20%D0%B0%D0%B2%D1%82%D0%BE%D0%BE%D0%B1%D0%BD%D0%BE%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D1%8F Конфигурация автообновления] / Редактировать АктивныйШлюз''''' | ||
Редактирует конфигурацию автообновления указанной среды АктивногоШлюза. | |||
Запрос потребляет <code>application/json</code>полезную нагрузку. | Запрос потребляет <code>application/json</code>полезную нагрузку. | ||
{| class="wikitable" | {| class="wikitable" | ||
| | |PUT | ||
| | | | ||
* | * АппОптима https: // {ваш-домен} / e / {ваш-идентификатор-среды} / api / v2 / activeGates / {agId} / autoUpdate | ||
* Среда АктивногоШлюза https: // {your-activegate-domain} / e / {your-environment-id} / api / v2 / activeGates / {agId} / autoUpdate | |||
* Среда | |||
|} | |} | ||
== Аутентификация == | == Аутентификация == | ||
Для выполнения этого запроса вам необходимо разрешение Write | Для выполнения этого запроса вам необходимо разрешение Write АктивныхШлюзов( <code>activeGates.write</code>), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация . | ||
== Параметры == | == Параметры == | ||
| Строка 18: | Строка 19: | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !In | ||
! | !необходимость | ||
|- | |- | ||
| | |старение | ||
| | |string | ||
|ID необходимого | |ID необходимого АктивногоШлюза. | ||
| | |path | ||
|обязательный | |обязательный | ||
|- | |- | ||
| | |body | ||
| | |АктивныйШлюз Auto Update Config | ||
|Тело запроса в формате JSON, содержащее параметры автообновления. | |Тело запроса в формате JSON, содержащее параметры автообновления. | ||
| | |body | ||
|по желанию | |по желанию | ||
|} | |} | ||
| Строка 39: | Строка 40: | ||
==== ActiveGateAutoUpdateConfig объект ==== | ==== ActiveGateAutoUpdateConfig объект ==== | ||
Настройка автообновлений | Настройка автообновлений АктивногоШлюза. | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
| Строка 47: | Строка 48: | ||
|- | |- | ||
|параметр | |параметр | ||
| | |string | ||
|Состояние автообновления | |Состояние автообновления АктивногоШлюза: включено, отключено или унаследовано. | ||
Если установлено значение <code>INHERITED</code>, параметр наследуется из глобальной конфигурации, установленной на уровне среды или управляемого кластера. | Если установлено значение <code>INHERITED</code>, параметр наследуется из глобальной конфигурации, установленной на уровне среды или управляемого кластера. | ||
| Строка 54: | Строка 55: | ||
Элемент может содержать эти значения | Элемент может содержать эти значения | ||
* | * invalid | ||
* ВКЛЮЧЕНО | * ВКЛЮЧЕНО | ||
* Унаследованный | * Унаследованный | ||
| Строка 63: | Строка 64: | ||
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе. | Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе. | ||
< | <{ | ||
"setting": "INHERITED", | "setting": "INHERITED", | ||
"effectiveSetting": "ENABLED" | "effectiveSetting": "ENABLED" | ||
} | } | ||
== Ответ == | == Ответ == | ||
| Строка 90: | Строка 91: | ||
Запрос потребляет <code>application/json</code>полезную нагрузку. | Запрос потребляет <code>application/json</code>полезную нагрузку. | ||
{| class="wikitable" | {| class="wikitable" | ||
| | |POST | ||
| | | | ||
* | * АппОптима 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 | Для выполнения этого запроса вам необходимо разрешение Write АктивныхШлюзов( <code>activeGates.write</code>), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация . | ||
=== Ответ === | === Ответ === | ||
Текущая версия от 14:06, 24 декабря 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 | Не удалось. Введены неверные данные. |
Тело ответа
Успешный запрос не возвращает никакого содержания.