GET конфигурация

Материал из Документация Ключ-АСТРОМ
Версия от 13:07, 21 октября 2022; ENetrebin (обсуждение | вклад) (Новая страница: «Получает конфигурацию синтетического мониторинга в вашей среде. Запрос создает в качес...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Получает конфигурацию синтетического мониторинга в вашей среде.

Запрос создает в качестве полезной нагрузки application/json формат.

GET Managed https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/config
Среда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/v2/synthetic/config

Аутентификация

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение синтетических местоположений ( syntheticLocations.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Запрос не предоставляет никаких настраиваемых параметров.

Ответ

Коды ответов

Код Тип Описание
200 SyntheticConfigDto Успех. Ответ содержит синтетические связанные параметры, определенные для всего арендатора.

Объекты тела ответа

Объект SyntheticConfigDto

DTO для синтетической конфигурации.

Элемент Тип Описание
bmMonitorTimeout integer bmMonitorTimeout - время ожидания выполнения монитора браузера (мс)
bmStepTimeout integer bmStepTimeout - время ожидания выполнения одного шага монитора браузера (мс)

JSON-модель тела ответа

{
  "bmMonitorTimeout": 1,
  "bmStepTimeout": 1
}

Пример

В этом примере в запросе указана текущая конфигурация синтетического мониторинга.

Маркер API передается в заголовке авторизации .

Curl

curl --request GET \
  --url 'https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/config' \
  --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

URL-адрес запроса

https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/config

Тело ответа

{
  "browserMonitorTimeout": 600000,
  "browserMonitorStepTimeout": 60000
}

Код ответа

200