ENetrebin (обсуждение | вклад) (Новая страница: «Обновляет конфигурацию синтетического мониторинга в вашей среде. Запрос использует в к...») |
Нет описания правки |
||
| (не показана 1 промежуточная версия этого же участника) | |||
| Строка 1: | Строка 1: | ||
'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%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,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D1%81%D0%BE%D1%81%D1%82%D0%BE%D1%8F%D0%BD%D0%B8%D1%8F%20%D0%BF%D1%80%D0%BE%D1%87%D0%B8%D1%85%20%D0%BC%D0%BE%D0%BD%D0%B8%D1%82%D0%BE%D1%80%D0%BE%D0%B2-,%D0%A1%D0%B8%D0%BD%D1%82%D0%B5%D1%82%D0%B8%D0%BA%D0%B0%20v2,-%D0%A1%D0%B8%D0%BD%D1%82%D0%B5%D1%82%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%B8%D0%B5%20%D0%BB%D0%BE%D0%BA%D0%B0%D1%86%D0%B8%D0%B8 Синтетика v2] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%BE%20%D0%BF%D0%B0%D0%BA%D0%B5%D1%82%D0%BD%D0%BE%D0%BC%20%D0%B2%D1%8B%D0%BF%D0%BE%D0%BB%D0%BD%D0%B5%D0%BD%D0%B8%D0%B8-,%D0%9A%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B0%D1%86%D0%B8%D1%8F,-GET%20%D0%BA%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B0%D1%86%D0%B8%D1%8F Конфигурация] / PUT конфигурация''''' | |||
Обновляет конфигурацию синтетического мониторинга в вашей среде. | Обновляет конфигурацию синтетического мониторинга в вашей среде. | ||
| Строка 4: | Строка 6: | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan="2" |PUT | | rowspan="2" |PUT | ||
| | |АппОптима | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/config</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/config</nowiki></code> | ||
|- | |- | ||
| Строка 52: | Строка 54: | ||
=== JSON-модель тела запроса === | === JSON-модель тела запроса === | ||
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе. | Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе. | ||
< | <{ | ||
"bmMonitorTimeout": 1, | "bmMonitorTimeout": 1, | ||
"bmStepTimeout": 1 | "bmStepTimeout": 1 | ||
} | } | ||
== Ответ == | == Ответ == | ||
| Строка 78: | Строка 80: | ||
==== Curl ==== | ==== Curl ==== | ||
< | <curl --request PUT \ | ||
--url <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/config</nowiki> \ | --url <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/config</nowiki> \ | ||
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \ | --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \ | ||
| Строка 85: | Строка 87: | ||
"bmMonitorTimeout": 300000, | "bmMonitorTimeout": 300000, | ||
"bmMonitorTimeout": 30000 | "bmMonitorTimeout": 30000 | ||
}' | }' | ||
==== URL-адрес запроса ==== | ==== URL-адрес запроса ==== | ||
| Строка 91: | Строка 93: | ||
==== Тело запроса ==== | ==== Тело запроса ==== | ||
< | <{ | ||
"bmMonitorTimeout": 300000, | "bmMonitorTimeout": 300000, | ||
"bmMonitorTimeout": 30000 | "bmMonitorTimeout": 30000 | ||
} | } | ||
==== Код ответа ==== | ==== Код ответа ==== | ||
204 | 204 | ||
Текущая версия от 17:24, 2 января 2025
API АппОптима / Эндпойнты среды / Развёртывание / Синтетика v2 / Конфигурация / PUT конфигурация
Обновляет конфигурацию синтетического мониторинга в вашей среде.
Запрос использует в качестве полезной нагрузки application/json формат.
| PUT | АппОптима | https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/config
|
| Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/synthetic/config
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Запись синтетических местоположений ( syntheticLocations.write) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| body | SyntheticConfigDto | DTO для синтетической конфигурации. | body | по желанию |
Объекты тела запроса
Объект SyntheticConfigDto
DTO для синтетической конфигурации.
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| bmMonitorTimeout | integer | bmMonitorTimeout - время ожидания выполнения монитора браузера (мс) | требуется |
| bmStepTimeout | integer | bmStepTimeout - время ожидания выполнения одного шага монитора браузера (мс) | требуется |
JSON-модель тела запроса
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<{
"bmMonitorTimeout": 1,
"bmStepTimeout": 1
}
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 204 | SyntheticConfigDto | Успех. Обновлен набор синтетических параметров. Ответ не имеет тела. |
Пример
В этом примере запрос обновляет конфигурацию синтетического мониторинга из примера запроса GET . Он вдвое сокращает время ожидания для монитора браузера и шагов монитора браузера, устанавливая для них значения 300,000и 30,000соответственно.
Маркер API передается в заголовке авторизации .
Вы можете скачать или скопировать образец тела запроса, чтобы попробовать его самостоятельно. Обязательно создайте резервную копию текущей конфигурации с помощью вызова синтетической конфигурации GET .
Curl
<curl --request PUT \
--url https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/config \
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
--header 'Content-Type: application/json' \
--data '{
"bmMonitorTimeout": 300000,
"bmMonitorTimeout": 30000
}'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/config
Тело запроса
<{
"bmMonitorTimeout": 300000,
"bmMonitorTimeout": 30000
}
Код ответа
204