Реализация активации конфигурации
Материал из Документация Ключ-АСТРОМ
Функция включает указанное расширение Extensions 2.0 и одновременно активирует указанную версию конфигурации среды.
Запрос потребляет и создает application/json
полезную нагрузку.
POST | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/environmentConfiguration
|
SaaS | https://{your-environment-id}.live.ruscomtech.ru/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"
}