Размещение конфигурации среды: различия между версиями
Материал из Документация Ключ-АСТРОМ
ENetrebin (обсуждение | вклад) (Новая страница: «Функция активирует указанную версию расширения Extensions 2.0. Запрос потребляет и создает <cod...») |
ENetrebin (обсуждение | вклад) |
||
| (не показаны 3 промежуточные версии этого же участника) | |||
| Строка 8: | Строка 8: | ||
|- | |- | ||
|SaaS | |SaaS | ||
|<code><nowiki>https://{your-environment-id}.live. | |<code><nowiki>https://{your-environment-id}.live.ruscomtech.ru/api/v2/extensions/{extensionName}/environmentConfiguration</nowiki></code> | ||
|- | |- | ||
|Окружающая среда АктивногоШлюза | |Окружающая среда АктивногоШлюза | ||
| Строка 15: | Строка 15: | ||
== Аутентификация == | == Аутентификация == | ||
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Запись конфигураций среды расширения ( <code>extensionEnvironment.write</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация . | Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Запись конфигураций среды расширения ( <code>extensionEnvironment.write</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] . | ||
== Конфигурация мониторинга == | == Конфигурация мониторинга == | ||
| Строка 22: | Строка 22: | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !In | ||
! | !Необходимость | ||
|- | |- | ||
| | |extensionName | ||
| | |string | ||
|Имя запрошенного расширения 2.0. | |Имя запрошенного расширения 2.0. | ||
| | |path | ||
|требуется | |требуется | ||
|- | |- | ||
| | |body | ||
| | |ExtensionEnvironmentConfigurationVersion | ||
|Версия запрошенной конфигурации среды. | |Версия запрошенной конфигурации среды. | ||
| | |body | ||
|требуется | |требуется | ||
|} | |} | ||
| Строка 40: | Строка 40: | ||
=== Объекты тела запроса === | === Объекты тела запроса === | ||
==== Объект | ==== Объект <code>RequestBody</code> ==== | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
| Строка 46: | Строка 46: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |version | ||
| | |string | ||
|Версия расширения | |Версия расширения | ||
|} | |} | ||
| Строка 66: | Строка 66: | ||
|- | |- | ||
|200 | |200 | ||
| | |ExtensionEnvironmentConfigurationVersion | ||
|Успех. Обновлена конфигурация среды. | |Успех. Обновлена конфигурация среды. | ||
|- | |- | ||
|400 | |400 | ||
| | |ErrorEnvelope | ||
|Не удалось. Ввод недействителен. | |Не удалось. Ввод недействителен. | ||
|- | |- | ||
|404 | |404 | ||
| | |ErrorEnvelope | ||
|Не удалось. Запрошенный ресурс не существует. | |Не удалось. Запрошенный ресурс не существует. | ||
|} | |} | ||
| Строка 80: | Строка 80: | ||
=== Объекты тела ответа === | === Объекты тела ответа === | ||
==== Объект | ==== Объект <code>ResponseBody</code> ==== | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
| Строка 86: | Строка 86: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |version | ||
| | |string | ||
|Версия расширения | |Версия расширения | ||
|} | |} | ||
Текущая версия на 10:00, 7 октября 2022
Функция активирует указанную версию расширения Extensions 2.0.
Запрос потребляет и создает application/jsonполезную нагрузку.
| PUT | 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"
}
