IKuznetsov в 16:54, 2 января 2025

2025-01-02T16:54:51Z

← Предыдущая версия		Версия от 16:54, 2 января 2025
Строка 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=GET%20%D1%81%D1%85%D0%B5%D0%BC%D0%B0-,%D0%A1%D0%B8%D0%BD%D1%82%D0%B5%D1%82%D0%B8%D0%BA%D0%B0%20v1,-%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%BC%D0%BE%D0%BD%D0%B8%D1%82%D0%BE%D1%80%D1%8B Синтетика v1] / [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%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%BC%D0%BE%D0%BD%D0%B8%D1%82%D0%BE%D1%80%D1%8B Синтетические мониторы] / GET монитор'''''

	Получает свойства указанного монитора, включая его сценарий JSON.		Получает свойства указанного монитора, включая его сценарий JSON.
	{\| class="wikitable"		{\| class="wikitable"
Строка 244:		Строка 246:

	==== Объект <code>TagWithSourceInfo</code> ====		==== Объект <code>TagWithSourceInfo</code> ====
	Тег с источником объекта ~~Ключ-АСТРОМ~~.		Тег с источником объекта АппОптима.
	{\| class="wikitable"		{\| class="wikitable"
	!Элемент		!Элемент
Строка 307:		Строка 309:

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"entityId": "string",		"entityId": "string",
	"name": "string",		"name": "string",
Строка 371:		Строка 373:

	==== Curl ====		==== Curl ====
	<~~code>~~curl -X GET \		<curl -X GET \
	<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/monitors/SYNTHETIC_TEST-0000000000025434</nowiki> \		<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/monitors/SYNTHETIC_TEST-0000000000025434</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
Строка 379:		Строка 381:

	==== Тело ответа ====		==== Тело ответа ====
	<~~code>~~{		<{
	"entityId": "SYNTHETIC_TEST-0000000000025434",		"entityId": "SYNTHETIC_TEST-0000000000025434",
	"name": "ruscomtech.ru",		"name": "ruscomtech.ru",

ENetrebin в 16:08, 21 октября 2022

2022-10-21T16:08:19Z

← Предыдущая версия		Версия от 16:08, 21 октября 2022
Строка 5:		Строка 5:
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/monitors/{monitorId}</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/monitors/{monitorId}</nowiki></code>
	\|-		\|-
	\|~~Окружающая среда ActiveGate~~		\|Cреда АктивногоШлюза
	\|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/synthetic/monitors/{monitorId}</nowiki></code>		\|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/synthetic/monitors/{monitorId}</nowiki></code>
	\|}		\|}

ENetrebin: Новая страница: «Получает свойства указанного монитора, включая его сценарий JSON. {| class="wikitable" | rowspan="2" |GET |У...»

2022-10-21T16:07:21Z

Новая страница: «Получает свойства указанного монитора, включая его сценарий JSON. {| class="wikitable" | rowspan="2" |GET |У...»

Новая страница

Получает свойства указанного монитора, включая его сценарий JSON.
{| class="wikitable"
| rowspan="2" |GET
|Удалось
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/monitors/{monitorId}</nowiki></code>
|-
|Окружающая среда ActiveGate
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/synthetic/monitors/{monitorId}</nowiki></code>
|}

== Аутентификация ==
Чтобы выполнить этот запрос, вам нужен токен доступа с областью создания и чтения синтетических мониторов, местоположений и узлов ( <code>ExternalSyntheticIntegration</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|monitorId
|string
|ID требуемого синтетического монитора
|path
|требуется
|}

== Ответ ==
Чтобы найти все варианты моделей, зависящие от типа модели, см. раздел модели JSON .

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|SyntheticMonitor
|Успех
|}

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

==== Объект <code>SyntheticMonitor</code> ====
Синтетический монитор.

Фактический набор полей зависит от типа монитора. Список актуальных объектов ищите в описании поля типа или смотрите Синтетические мониторы API-модели JSON .
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|entityId
|string
|Идентификатор объекта монитора.
|-
|name
|string
|Название монитора.
|-
|frequencyMin
|integer
|Частота монитора в минутах.

Вы можете использовать одно из следующих значений: <code>5</code>, <code>10</code>, <code>15</code>, <code>30</code>и <code>60</code>.
|-
|enabled
|boolean
|Монитор включен ( <code>true</code>) или отключен ( <code>false</code>).
|-
|type
|string
|Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:

* <code>BROWSER</code>-> BrowserSyntheticMonitor
* <code>HTTP</code>-> HttpSyntheticMonitor

Элемент может содержать эти значения

* <code>BROWSER</code>
* <code>HTTP</code>
|-
|createdFrom
|string
|Происхождение монитора

Элемент может содержать эти значения

* <code>API</code>
* <code>GUI</code>
|-
|script
|object
|Скрипт браузера или HTTP-монитора.
|-
|locations
|string[]
|Список местоположений, из которых выполняется монитор.

Чтобы указать местоположение, используйте его идентификатор объекта.
|-
|anomalyDetection
|AnomalyDetection
|Конфигурация обнаружения аномалий.
|-
|tags
|TagWithSourceInfo[]
|Набор тегов, присвоенных монитору.
|-
|managementZones
|ManagementZone[]
|Набор зон управления, к которым принадлежит монитор.
|-
|automaticallyAssignedApps
|string[]
|Набор автоматически назначаемых приложений.
|-
|manuallyAssignedApps
|string[]
|Набор назначенных вручную приложений.
|}

==== Объект <code>AnomalyDetection</code> ====
Конфигурация обнаружения аномалий.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|outageHandling
|OutageHandlingPolicy
|Конфигурация обработки сбоев.
|-
|loadingTimeThresholds
|LoadingTimeThresholdsPolicyDto
|Настройка порогов производительности.
|}

==== Объект <code>OutageHandlingPolicy</code> ====
Конфигурация обработки сбоев.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|globalOutage
|boolean
|Когда включено ( <code>true</code>), генерирует проблему и отправляет оповещение, когда монитор недоступен во всех настроенных местоположениях.
|-
|globalOutagePolicy
|GlobalOutagePolicy
|Конфигурация глобальной обработки сбоев.
|-
|localOutage
|boolean
|Если этот параметр включен ( <code>true</code>), генерирует проблему и отправляет оповещение, когда монитор недоступен для одного или нескольких последовательных запусков в любом месте.
|-
|localOutagePolicy
|LocalOutagePolicy
|Конфигурация локальной обработки сбоев.

Предупреждать, если затронутые местоположения местоположений не могут получить доступ к веб-приложению последовательно Запускается несколько раз подряд.
|-
|retryOnError
|boolean
|Запланируйте повторную попытку, если выполнение монитора браузера приведет к сбою. Для HTTP-мониторов это свойство игнорируется.
|}

==== Объект <code>GlobalOutagePolicy</code> ====
Конфигурация глобальной обработки сбоев.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|consecutiveRuns
|integer
|Оповещение, если все местоположения не могут получить доступ к веб-приложению ''X'' раз подряд.
|}

==== Объект <code>LocalOutagePolicy</code> ====
Конфигурация локальной обработки сбоев.

Предупреждать, если затронутые местоположения местоположений не могут получить доступ к веб-приложению последовательно Запускается несколько раз подряд.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|affectedLocations
|integer
|Количество затронутых местоположений, для которых выдается оповещение.
|-
|consecutiveRuns
|integer
|Количество последовательных неудачных попыток вызвать оповещение.
|}

==== Объект <code>LoadingTimeThresholdsPolicyDto</code> ====
Настройка порогов производительности.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|enabled
|boolean
|Порог производительности включен ( <code>true</code>) или отключен ( <code>false</code>).
|-
|thresholds
|LoadingTimeThreshold[]
|Список правил порога производительности.
|}

==== Объект <code>LoadingTimeThreshold</code> ====
Правило порога производительности.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|type
|string
|Тип порога: общее время загрузки или время загрузки действия.

Элемент может содержать эти значения

* <code>ACTION</code>
* <code>TOTAL</code>
|-
|valueMs
|integer
|Уведомлять, если загрузка монитора занимает больше ''X'' миллисекунд.
|-
|requestIndex
|integer
|Укажите запрос, к которому применяется порог ACTION.
|-
|eventIndex
|integer
|Укажите событие, к которому применяется порог ACTION.
|}

==== Объект <code>TagWithSourceInfo</code> ====
Тег с источником объекта Ключ-АСТРОМ.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|source
|string
|Источник тега, например USER, RULE_BASED или AUTO.

Элемент может содержать эти значения

* <code>AUTO</code>
* <code>RULE_BASED</code>
* <code>USER</code>
|-
|context
|string
|Происхождение тега, например AWS или Cloud Foundry.

Пользовательские теги используют это <code>CONTEXTLESS</code>значение.

Элемент может содержать эти значения

* <code>AWS</code>
* <code>AWS_GENERIC</code>
* <code>AZURE</code>
* <code>CLOUD_FOUNDRY</code>
* <code>CONTEXTLESS</code>
* <code>ENVIRONMENT</code>
* <code>GOOGLE_CLOUD</code>
* <code>KUBERNETES</code>
|-
|key
|string
|Ключ тега.

Пользовательские теги здесь имеют значение тега.
|-
|value
|string
|Значение тега.

Не применимо к пользовательским тегам.
|}

==== Объект <code>ManagementZone</code> ====
Конфигурация зоны управления.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|id
|string
|Идентификатор зоны управления.
|-
|name
|string
|Имя зоны управления.
|}

=== JSON-модель тела ответа ===
<code>{
"entityId": "string",
"name": "string",
"frequencyMin": 1,
"enabled": true,
"type": "BROWSER",
"createdFrom": "API",
"script": {},
"locations": [
"string"
],
"anomalyDetection": {
"outageHandling": {
"globalOutage": true,
"globalOutagePolicy": {
"consecutiveRuns": 1
},
"localOutage": true,
"localOutagePolicy": {
"affectedLocations": 1,
"consecutiveRuns": 1
},
"retryOnError": true
},
"loadingTimeThresholds": {
"enabled": true,
"thresholds": [
{
"type": "ACTION",
"valueMs": 1,
"requestIndex": 1,
"eventIndex": 1
}
]
}
},
"tags": [
{
"source": "AUTO",
"context": "AWS",
"key": "string",
"value": "string"
}
],
"managementZones": [
{
"id": "string",
"name": "string"
}
],
"automaticallyAssignedApps": [
"string"
],
"manuallyAssignedApps": [
"string"
]
}</code>

== Пример ==
В этом примере в запросе перечислены параметры монитора ruscomtech.ru , который представляет собой путь клика браузера , который ведет на <nowiki>https://www.ruscomtech.ru/</nowiki> и подписывается на бесплатную пробную версию.

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

==== Curl ====
<code>curl -X GET \
<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/monitors/SYNTHETIC_TEST-0000000000025434</nowiki> \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>

==== URL-адрес запроса ====
<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/monitors/SYNTHETIC_TEST-0000000000025434</nowiki></code>

==== Тело ответа ====
<code>{
"entityId": "SYNTHETIC_TEST-0000000000025434",
"name": "ruscomtech.ru",
"frequencyMin": 15,
"enabled": true,
"type": "browser",
"script": {
"type": "clickpath",
"version": "1.0",
"configuration": {
"device": {
"deviceName":"Desktop",
"orientation":"landscape"
}
},
"events": [
{
"type":"navigate",
"description":"Loading of \"<nowiki>http://www.ruscomtech.ru</nowiki>\"",
"url":"<nowiki>http://www.ruscomtech.ru</nowiki>",
"wait": {
"waitFor":"page_complete"
}
},
{
"type":"click",
"description":"click on \"Free trial\"",
"target": {
"locators": [
{
"type":"css",
"value":"a:contains(\"Free trial\"):eq(1)"
},
{
"type":"css",
"value":".btn:eq(1)"
},
{
"type":"css",
"value":"#content div div div div div div div p:nth-child(3) a"
},
{
"type":"css",
"value":"#content div.homepage-hero-wrapper div.gallery div.flickity-viewport div.flickity-slider div.gallery-cell div.section div.column p.cta--row a.btn:eq(0)"
}
]
},
"button": 0,
"wait": {
"waitFor":"page_complete"
}
}
{
"type":"click",
"description":"click on \"email\"",
"target": {
"locators": [
{
"type":"css",
"value":"input[type=\"email\"][name=\"email\"]:eq(0)"
},
{
"type":"dom",
"value":"document.forms[0][\"email\"]"
},
{
"type":"css",
"value":".inputfield:eq(0)"
},
{
"type":"css",
"value":"#content div div:nth-child(2) form:nth-child(9) input:nth-child(3)"
},
{
"type":"css",
"value":"#content div.section div.tile form.cta input.inputfield:eq(0)"
}
]
},
"button":0
},
{
"type":"keystrokes",
"description":"keystrokes on \"email\"",
"target":{
"locators":[
{
"type":"css",
"value":"input[type=\"email\"][name=\"email\"]:eq(0)"
},
{
"type":"dom",
"value":"document.forms[0][\"email\"]"
},
{
"type":"css",
"value":".inputfield:eq(0)"
},
{
"type":"css",
"value":"#content div div:nth-child(2) form:nth-child(9) input:nth-child(3)"
},
{
"type":"css",
"value":"#content div.section div.tile form.cta input.inputfield:eq(0)"
}
]
},
"textValue":"sample@sample.com",
"masked":false,
"simulateBlurEvent":true
},
{
"type":"click",
"description":"click on \"Start free trial\"",
"target":{
"locators":[
{
"type":"css",
"value":"input[type=\"submit\"]:eq(0)"
},
{
"type":"dom",
"value":"document.forms[0][19]"
},
{
"type":"css",
"value":".btn:eq(1)"
},
{
"type":"css",
"value":"#content div div:nth-child(2) form:nth-child(9) div:nth-child(22) input"
},
{
"type":"css",
"value":"#content div.section div.tile form.cta div.cta__formgroup input.btn:eq(0)"
}
]
},
"button":0,
"wait":{
"waitFor":"page_complete"
}
}
]
},
"locations": [
"GEOLOCATION-B69A5A40388CC698",
"GEOLOCATION-A9022AAFA0763F56"
],
"anomalyDetection": {
"outageHandling": {
"globalOutage": true,
"localOutage": false,
"localOutagePolicy": {
"affectedLocations": 1,
"consecutiveRuns": 3
}
},
"loadingTimeThresholds": {
"enabled": false,
"thresholds": []
}
},
"tags": [],
"managementZones": [
{
"id": "-7832237287622819191",
"name": "!!allSynthetic"
}
]
}</code>

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

GET монитор - История изменений

IKuznetsov в 16:54, 2 января 2025

ENetrebin в 16:08, 21 октября 2022

ENetrebin: Новая страница: «Получает свойства указанного монитора, включая его сценарий JSON. {| class="wikitable" | rowspan="2" |GET |У...»