PUT конфигурации среды: различия между версиями
Материал из Документация Ключ-АСТРОМ
ENetrebin (обсуждение | вклад) (Новая страница: «'''''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|Эндп...») |
ENetrebin (обсуждение | вклад) |
||
| Строка 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.A0.D0.B0.D0.B7.D0.B2.D1.91.D1.80.D1.82.D1.8B.D0.B2.D0.B0.D0.BD.D0.B8.D0.B5|Развёртывание]] / Расширения 2.0 / PUT конфигурации среды''''' | '''''[[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.A0.D0.B0.D0.B7.D0.B2.D1.91.D1.80.D1.82.D1.8B.D0.B2.D0.B0.D0.BD.D0.B8.D0.B5|Развёртывание]] / Расширения 2.0 / Конфигурации среды / PUT конфигурации среды''''' | ||
Функция активирует указанную версию расширения Extensions 2.0. | Функция активирует указанную версию расширения Extensions 2.0. | ||
Текущая версия на 19:29, 17 июня 2024
API Ключ-АСТРОМ / Эндпойнты среды / Развёртывание / Расширения 2.0 / Конфигурации среды / PUT конфигурации среды
Функция активирует указанную версию расширения Extensions 2.0.
Запрос потребляет и создает application/jsonполезную нагрузку.
| PUT | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/environmentConfiguration
|
| Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/environmentConfiguration
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Запись конфигураций среды расширения ( extensionEnvironment.write) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Конфигурация мониторинга
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| extensionName | string | Имя запрошенного расширения 2.0. | path | требуется |
| body | ExtensionEnvironmentConfigurationVersion | Версия запрошенной конфигурации среды. | body | требуется |
Объекты тела запроса
Объект RequestBody
| Элемент | Тип | Описание |
|---|---|---|
| version | string | Версия расширения |
JSON-модель тела запроса
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
{
"version": "1.2.3"
}
Схемы расширения
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | ExtensionEnvironmentConfigurationVersion | Успех. Обновлена конфигурация среды. |
| 400 | ErrorEnvelope | Не удалось. Ввод недействителен. |
| 404 | ErrorEnvelope | Не удалось. Запрошенный ресурс не существует. |
Объекты тела ответа
Объект ResponseBody
| Элемент | Тип | Описание |
|---|---|---|
| version | string | Версия расширения |
JSON-модель тела ответа
{
"version": "1.2.3"
}
