Редактировать АктивныйШлюз: различия между версиями
Материал из Документация Ключ-АСТРОМ
ENetrebin (обсуждение | вклад) |
ENetrebin (обсуждение | вклад) |
||
| Строка 1: | Строка 1: | ||
Редактирует конфигурацию автообновления указанной среды | Редактирует конфигурацию автообновления указанной среды АктивногоШлюза. | ||
Запрос потребляет <code>application/json</code>полезную нагрузку. | Запрос потребляет <code>application/json</code>полезную нагрузку. | ||
| Строка 5: | Строка 5: | ||
|СТАВИТЬ | |СТАВИТЬ | ||
| | | | ||
* | * Managed https: // {ваш-домен} / e / {ваш-идентификатор-среды} / api / v2 / activeGates / {agId} / autoUpdate | ||
* SaaS https: // {ваш-идентификатор-среды} .live.dynatrace.com / api / v2 / activeGates / {agId} / autoUpdate | * SaaS https: // {ваш-идентификатор-среды} .live.dynatrace.com / 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. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация . | ||
== Параметры == | == Параметры == | ||
| Строка 23: | Строка 23: | ||
|стареть | |стареть | ||
|нить | |нить | ||
|ID необходимого | |ID необходимого АктивногоШлюза. | ||
|дорожка | |дорожка | ||
|обязательный | |обязательный | ||
| Строка 39: | Строка 39: | ||
==== ActiveGateAutoUpdateConfig объект ==== | ==== ActiveGateAutoUpdateConfig объект ==== | ||
Настройка автообновлений | Настройка автообновлений АктивногоШлюза. | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
| Строка 48: | Строка 48: | ||
|параметр | |параметр | ||
|нить | |нить | ||
|Состояние автообновления | |Состояние автообновления АктивногоШлюза: включено, отключено или унаследовано. | ||
Если установлено значение <code>INHERITED</code>, параметр наследуется из глобальной конфигурации, установленной на уровне среды или управляемого кластера. | Если установлено значение <code>INHERITED</code>, параметр наследуется из глобальной конфигурации, установленной на уровне среды или управляемого кластера. | ||
| Строка 54: | Строка 54: | ||
Элемент может содержать эти значения | Элемент может содержать эти значения | ||
* | * invalid | ||
* ВКЛЮЧЕНО | * ВКЛЮЧЕНО | ||
* Унаследованный | * Унаследованный | ||
| Строка 94: | Строка 94: | ||
* Удалось https: // {ваш-домен} / e / {your-environment-id} / api / v2 / activeGates / {agId} / autoUpdate / validator | * Удалось https: // {ваш-домен} / e / {your-environment-id} / api / v2 / activeGates / {agId} / autoUpdate / validator | ||
* SaaS https: // {your-environment-id} .live.dynatrace.com / api / v2 / activeGates / {agId} / autoUpdate / validator. | * SaaS https: // {your-environment-id} .live.dynatrace.com / 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. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация . | ||
=== Ответ === | === Ответ === | ||
Версия 17:54, 21 сентября 2023
Редактирует конфигурацию автообновления указанной среды АктивногоШлюза.
Запрос потребляет application/jsonполезную нагрузку.
| СТАВИТЬ |
|
Аутентификация
Для выполнения этого запроса вам необходимо разрешение Write АктивныхШлюзов( activeGates.write), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | В | необходимые |
|---|---|---|---|---|
| стареть | нить | ID необходимого АктивногоШлюза. | дорожка | обязательный |
| тело | Активный Gate Auto Update Config | Тело запроса в формате JSON, содержащее параметры автообновления. | тело | по желанию |
Формат тела
- Параметры запроса
ActiveGateAutoUpdateConfig объект
Настройка автообновлений АктивногоШлюза.
| Элемент | Тип | Описание | необходимые |
|---|---|---|---|
| параметр | нить | Состояние автообновления АктивногоШлюза: включено, отключено или унаследовано.
Если установлено значение Элемент может содержать эти значения
|
обязательный |
- Модель JSON
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
{
"setting": "INHERITED",
"effectiveSetting": "ENABLED"
}
Ответ
Коды ответов
| Код | Описание |
|---|---|
| 204 | Успех. Конфигурация автообновления обновлена. У ответа нет тела. |
| 400 | Не удалось. Введены неверные данные. |
Тело ответа
Успешный запрос не возвращает никакого содержания.
Проверить полезную нагрузку
Мы рекомендуем вам проверить полезную нагрузку, прежде чем отправлять ее с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку.
Запрос потребляет application/jsonполезную нагрузку.
| ПОЧТА |
|
Аутентификация
Для выполнения этого запроса вам необходимо разрешение Write АктивныхШлюзов( activeGates.write), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .
Ответ
Коды ответов
| Код | Описание |
|---|---|
| 204 | Подтверждено. Представленная конфигурация автообновления действительна. У ответа нет тела. |
| 400 | Не удалось. Введены неверные данные. |
Тело ответа
Успешный запрос не возвращает никакого содержания.
