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

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

2025-01-02T16:55:16Z

← Предыдущая версия		Версия от 16:55, 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 Синтетические мониторы] / POST монитор'''''

	Создает новый синтетический монитор.		Создает новый синтетический монитор.

Строка 358:		Строка 360:
	],		],
	"events": []		"events": []
	}~~</code>~~		}

	== Ответ ==		== Ответ ==
Строка 390:		Строка 392:
	<{		<{
	"entityId": "string"		"entityId": "string"
	}~~</code>~~		}

	== Пример ==		== Пример ==
Строка 408:		Строка 410:
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
	-H 'Content-Type: application/json' \		-H 'Content-Type: application/json' \
	-d '{<truncated - see the Request body section >}'~~</code>~~		-d '{<truncated - see the Request body section >}'

	==== URL-адрес запроса ====		==== URL-адрес запроса ====
Строка 460:		Строка 462:
	},		},
	"tags": ["restExample"]		"tags": ["restExample"]
	}~~</code>~~		}

	==== Тело ответа ====		==== Тело ответа ====
	<{		<{
	"entityId": "SYNTHETIC_TEST-00000000000254E2"		"entityId": "SYNTHETIC_TEST-00000000000254E2"
	}~~</code>~~		}

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

IKuznetsov в 10:38, 26 декабря 2024

2024-12-26T10:38:03Z

← Предыдущая версия		Версия от 10:38, 26 декабря 2024
Строка 4:		Строка 4:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|POST		\| rowspan="2" \|POST
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/monitors</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/monitors</nowiki></code>
	\|-		\|-
Строка 246:		Строка 246:

	==== Объект <code>TagWithSourceInfo</code> ====		==== Объект <code>TagWithSourceInfo</code> ====
	Тег с источником объекта ~~Ключ-АСТРОМ~~.		Тег с источником объекта АппОптима.
	{\| class="wikitable"		{\| class="wikitable"
	!Элемент		!Элемент
Строка 299:		Строка 299:
	=== JSON-модель тела запроса ===		=== JSON-модель тела запроса ===
	Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.		Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
	<~~code>~~{		<{
	"frequencyMin": 5,		"frequencyMin": 5,
	"anomalyDetection": {		"anomalyDetection": {
Строка 370:		Строка 370:
	\|200		\|200
	\|EntityIdDto		\|EntityIdDto
	\|Успех. Создан новый синтетический монитор. Ответ содержит идентификатор объекта ~~Ключ-АСТРОМ~~ для нового монитора.		\|Успех. Создан новый синтетический монитор. Ответ содержит идентификатор объекта АппОптима для нового монитора.
	\|}		\|}

Строка 388:		Строка 388:

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"entityId": "string"		"entityId": "string"
	}</code>		}</code>
Строка 404:		Строка 404:

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

	==== Тело запроса ====		==== Тело запроса ====
	<~~code>~~{		<{
	"frequencyMin": 10,		"frequencyMin": 10,
	"anomalyDetection": {		"anomalyDetection": {
Строка 463:		Строка 463:

	==== Тело ответа ====		==== Тело ответа ====
	<~~code>~~{		<{
	"entityId": "SYNTHETIC_TEST-00000000000254E2"		"entityId": "SYNTHETIC_TEST-00000000000254E2"
	}</code>		}</code>

ENetrebin: Новая страница: «Создает новый синтетический монитор. Конфигурация нового монитора передается через ег...»

2022-10-21T16:33:01Z

Новая страница: «Создает новый синтетический монитор. Конфигурация нового монитора передается через ег...»

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

Создает новый синтетический монитор.

Конфигурация нового монитора передается через его сценарий JSON.
{| class="wikitable"
| rowspan="2" |POST
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/monitors</nowiki></code>
|-
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/synthetic/monitors</nowiki></code>
|}

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

== Параметры ==
Чтобы найти все варианты моделей, зависящие от типа модели, см. раздел модели JSON .
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|body
|SyntheticMonitorUpdate
|Тело запроса JSON, содержащее параметры нового синтетического монитора.
|body
|по желанию
|}

=== Объекты тела запроса ===

==== Объект <code>SyntheticMonitorUpdate</code> ====
Синтетическое обновление монитора.

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

Вы можете использовать одно из следующих значений: <code>5</code>, <code>10</code>, <code>15</code>, <code>30</code>и <code>60</code>.
|требуется
|-
|anomalyDetection
|AnomalyDetection
|Конфигурация обнаружения аномалий.
|по желанию
|-
|type
|string
|Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:

* <code>BROWSER</code>-> BrowserSyntheticMonitorUpdate
* <code>HTTP</code>-> HttpSyntheticMonitorUpdate

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

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

Чтобы указать местоположение, используйте его идентификатор объекта.
|требуется
|-
|enabled
|boolean
|Монитор включен ( <code>true</code>) или отключен ( <code>false</code>).
|требуется
|-
|script
|object
|Скрипт браузера или HTTP-монитора.
|требуется
|-
|tags
|TagWithSourceInfo[]
|Набор тегов, присвоенных монитору.

Здесь вы можете указать только значение тега, а <code>CONTEXTLESS</code>контекст и источник «ПОЛЬЗОВАТЕЛЬ» будут добавлены автоматически. Но предпочтительным вариантом является использование модели TagWithSourceDto.
|требуется
|-
|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> ====
Конфигурация локальной обработки сбоев.

Предупреждать, если affectedLocations местоположений не могут получить доступ к веб-приложению последовательно Запускается несколько раз подряд.
{| 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
|Значение тега.

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

=== JSON-модель тела запроса ===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<code>{
"frequencyMin": 5,
"anomalyDetection": {
"outageHandling": {
"globalOutage": true,
"localOutage": true,
"localOutagePolicy": {
"affectedLocations": 1,
"consecutiveRuns": 3
}
},
"loadingTimeThresholds": {
"enabled": true,
"thresholds": [
{
"type": "TOTAL",
"valueMs": 100,
"requestIndex": 1
}
]
}
},
"type": "BROWSER",
"name": "Browser Monitor Example",
"locations": [
"GEOLOCATION-9999453BE4BDB3CD"
],
"enabled": true,
"script": {
"type": "availability",
"version": "1.0",
"configuration": {
"device": {
"deviceName": "Desktop",
"orientation": "landscape"
}
},
"events": [
{
"type": "navigate",
"description": "Loading of \"example.com\"",
"url": "<nowiki>http://example.com</nowiki>",
"wait": {
"waitFor": "page_complete"
}
}
]
},
"keyPerformanceMetrics": {
"loadActionKpm": "VISUALLY_COMPLETE",
"xhrActionKpm": "VISUALLY_COMPLETE"
},
"tags": [
"example"
],
"manuallyAssignedApps": [
"APPLICATION-4ADF0EF407C7C545"
],
"events": []
}</code>

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|EntityIdDto
|Успех. Создан новый синтетический монитор. Ответ содержит идентификатор объекта Ключ-АСТРОМ для нового монитора.
|}

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

==== Объект <code>EntityIdDto</code> ====
DTO для идентификатора объекта.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|entityId
|string
|Идентификатор объекта для передачи
|}

=== JSON-модель тела ответа ===
<code>{
"entityId": "string"
}</code>

== Пример ==
В этом примере запрос создает простой монитор браузера, который переходит на ruscomtech.ru .

Мониторинг выполняется каждые 10 минут из одного местоположения с идентификатором GEOLOCATION-0A41430434C388A9 . Проблема возникнет, если веб-сайт будет недоступен в течение трех последовательных запусков . Уведомление отправляется, если загрузка веб-сайта занимает более 500 миллисекунд .

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

Ответ содержит идентификатор объекта только что созданного монитора.

Поскольку тело запроса длинное, оно усечено в этом примере раздела Curl . Полное тело см. в разделе Тело запроса . Вы можете скачать или скопировать образец тела запроса, чтобы попробовать его самостоятельно. Прежде чем использовать его, убедитесь, что местоположение из примера доступно в вашей среде. Вы можете получить список доступных местоположений с помощью вызова GET для всех искусственных местоположений . Если местоположение недоступно, замените его любым используемым местоположением.

==== Curl ====
<code>curl -X POST \
<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/monitors</nowiki> \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
-d '{<truncated - see the Request body section >}'</code>

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

==== Тело запроса ====
<code>{
"frequencyMin": 10,
"anomalyDetection": {
"outageHandling": {
"globalOutage": true,
"localOutage": false,
"localOutagePolicy": {
"affectedLocations": 1,
"consecutiveRuns": 3
}
},
"loadingTimeThresholds": {
"enabled": true,
"thresholds": [
{
"type": "total",
"valueMs": 500
}
]
}
},
"type": "BROWSER",
"name": "restExample",
"locations": ["GEOLOCATION-0A41430434C388A9"],
"enabled": true,
"script": {
"configuration": {
"device": {
"orientation": "landscape",
"deviceName": "Desktop"
}
},
"type": "clickpath",
"version": "1.0",
"events": [
{
"type": "navigate",
"wait": {
"waitFor": "page_complete"
},
"description": "navigate to main page ",
"url": "<nowiki>https://www.ruscomtech.ru</nowiki>"
}
]
},
"tags": ["restExample"]
}</code>

==== Тело ответа ====
<code>{
"entityId": "SYNTHETIC_TEST-00000000000254E2"
}</code>

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