Открыть меню
Открыть персональное меню
Вы не представились системе
Your IP address will be publicly visible if you make any edits.

GET конфигурация: различия между версиями

Материал из Документация АппОптима
(Новая страница: «Получает конфигурацию синтетического мониторинга в вашей среде. Запрос создает в качес...»)
 
Нет описания правки
 
(не показана 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 Конфигурация] / GET конфигурация'''''
Получает конфигурацию синтетического мониторинга в вашей среде.
Получает конфигурацию синтетического мониторинга в вашей среде.


Строка 4: Строка 6:
{| class="wikitable"
{| class="wikitable"
| rowspan="2" |GET
| rowspan="2" |GET
|Managed
|АппОптима
|<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>
|-
|-
Строка 49: Строка 51:


=== JSON-модель тела ответа ===
=== JSON-модель тела ответа ===
  <code>{
  <{
   "bmMonitorTimeout": 1,
   "bmMonitorTimeout": 1,
   "bmStepTimeout": 1
   "bmStepTimeout": 1
  }</code>
  }


== Пример ==
== Пример ==
Строка 60: Строка 62:


==== Curl ====
==== Curl ====
  <code>curl --request GET \
  <curl --request GET \
   --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'</code>
   --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'


==== URL-адрес запроса ====
==== URL-адрес запроса ====
Строка 68: Строка 70:


==== Тело ответа ====
==== Тело ответа ====
  <code>{
  <{
   "browserMonitorTimeout": 600000,
   "browserMonitorTimeout": 600000,
   "browserMonitorStepTimeout": 60000
   "browserMonitorStepTimeout": 60000
  }</code>
  }


==== Код ответа ====
==== Код ответа ====
200
200

Текущая версия от 17:24, 2 января 2025

API АппОптима / Эндпойнты среды / Развёртывание / Синтетика v2 / Конфигурация / GET конфигурация

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

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

GET АппОптима 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