Установка конфигурации мониторинга: различия между версиями
Материал из Документация Ключ-АСТРОМ
ENetrebin (обсуждение | вклад) (Новая страница: « Обновляет указанную конфигурацию мониторинга расширения Extensions 2.0. Запрос потребляет и...») |
ENetrebin (обсуждение | вклад) |
||
| (не показана 1 промежуточная версия этого же участника) | |||
| Строка 5: | Строка 5: | ||
Запрос потребляет и создает <code>application/json</code>полезную нагрузку. | Запрос потребляет и создает <code>application/json</code>полезную нагрузку. | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan="3" | | | rowspan="3" |PUT | ||
| | |Managed | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}</nowiki></code> | ||
|- | |- | ||
|SaaS | |SaaS | ||
|<code><nowiki>https://{your-environment-id}.live. | |<code><nowiki>https://{your-environment-id}.live.ruscomtech.ru/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}</nowiki></code> | ||
|- | |- | ||
|Окружающая среда | |Окружающая среда АктивногоШлюза | ||
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}</nowiki></code> | |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}</nowiki></code> | ||
|} | |} | ||
== Аутентификация == | == Аутентификация == | ||
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Запись конфигураций мониторинга расширений ( <code>extensionConfigurations.write</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация . | Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия '''Запись конфигураций мониторинга расширений''' ( <code>extensionConfigurations.write</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] . | ||
== Параметры == | == Параметры == | ||
| Строка 24: | Строка 24: | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !In | ||
!Необходимый | !Необходимый | ||
|- | |- | ||
| | |extensionName | ||
| | |string | ||
|Имя запрошенного расширения 2.0. | |Имя запрошенного расширения 2.0. | ||
| | |path | ||
|требуется | |требуется | ||
|- | |- | ||
| | |configurationId | ||
| | |string | ||
|Идентификатор запрошенной конфигурации мониторинга. | |Идентификатор запрошенной конфигурации мониторинга. | ||
| | |path | ||
|требуется | |требуется | ||
|- | |- | ||
| | |body | ||
| | |MonitoringConfigurationUpdateDto | ||
|Тело запроса в формате JSON, содержащее параметры конфигурации мониторинга. | |Тело запроса в формате JSON, содержащее параметры конфигурации мониторинга. | ||
| | |body | ||
|требуется | |требуется | ||
|} | |} | ||
| Строка 48: | Строка 48: | ||
=== Объекты тела запроса === | === Объекты тела запроса === | ||
==== Объект | ==== Объект <code>MonitoringConfigurationUpdateDto</code> ==== | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !Необходимость | ||
|- | |- | ||
| | |value | ||
| | |JsonNode | ||
|Конфигурация мониторинга | |Конфигурация мониторинга | ||
|по желанию | |по желанию | ||
|} | |} | ||
==== Объект | ==== Объект <code>JsonNode</code> ==== | ||
Конфигурация мониторинга | Конфигурация мониторинга | ||
| Строка 81: | Строка 81: | ||
|- | |- | ||
|200 | |200 | ||
| | |MonitoringConfigurationResponse | ||
|Успех | |Успех | ||
|- | |- | ||
| Строка 95: | Строка 95: | ||
=== Объекты тела ответа === | === Объекты тела ответа === | ||
==== Объект | ==== Объект <code>MonitoringConfigurationResponse</code> ==== | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
| Строка 101: | Строка 101: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |objectId | ||
| | |string | ||
|Идентификатор новой конфигурации | |Идентификатор новой конфигурации | ||
|- | |- | ||
| | |code | ||
| | |integer | ||
|Код состояния HTTP | |Код состояния HTTP | ||
|} | |} | ||
Текущая версия на 10:11, 7 октября 2022
Обновляет указанную конфигурацию мониторинга расширения Extensions 2.0.
Запрос потребляет и создает application/jsonполезную нагрузку.
| PUT | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}
|
| SaaS | https://{your-environment-id}.live.ruscomtech.ru/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}
| |
| Окружающая среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Запись конфигураций мониторинга расширений ( extensionConfigurations.write) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимый |
|---|---|---|---|---|
| extensionName | string | Имя запрошенного расширения 2.0. | path | требуется |
| configurationId | string | Идентификатор запрошенной конфигурации мониторинга. | path | требуется |
| body | MonitoringConfigurationUpdateDto | Тело запроса в формате JSON, содержащее параметры конфигурации мониторинга. | body | требуется |
Объекты тела запроса
Объект MonitoringConfigurationUpdateDto
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| value | JsonNode | Конфигурация мониторинга | по желанию |
Объект JsonNode
Конфигурация мониторинга
Объект не предоставляет никаких параметров.
JSON-модель тела запроса
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
{
"value": {}
}
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | MonitoringConfigurationResponse | Успех |
| 400 | ErrorEnvelope | Не удалось. Ввод недействителен. |
| 404 | ErrorEnvelope | Не удалось. Запрошенный ресурс не существует. |
Объекты тела ответа
Объект MonitoringConfigurationResponse
| Элемент | Тип | Описание |
|---|---|---|
| objectId | string | Идентификатор новой конфигурации |
| code | integer | Код состояния HTTP |
JSON-модель тела ответа
{
"objectId": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
"code": 1
}
