IKuznetsov в 17:23, 2 января 2025

2025-01-02T17:23:10Z

← Предыдущая версия		Версия от 17:23, 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=%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%9E%D1%82%D1%81%D0%BB%D0%B5%D0%B6%D0%B8%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5%20%D0%B2%D1%8B%D0%BF%D0%BE%D0%BB%D0%BD%D0%B5%D0%BD%D0%B8%D1%8F Отслеживание выполнения] / POST пакетное выполнение'''''

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

Строка 147:		Строка 149:
	]		]
	}		}
	}~~</code>~~		}

	== Ответ ==		== Ответ ==
Строка 279:		Строка 281:
	}		}
	]		]
	}~~</code>~~		}

IKuznetsov в 09:15, 26 декабря 2024

2024-12-26T09:15:33Z

← Предыдущая версия		Версия от 09:15, 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/v2/synthetic/executions/batch</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/executions/batch</nowiki></code>
	\|-		\|-
Строка 121:		Строка 121:
	=== JSON-модель тела запроса ===		=== JSON-модель тела запроса ===
	Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.		Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
	<~~code>~~{		<{
	"processingMode": "EXECUTIONS_DETAILS_ONLY",		"processingMode": "EXECUTIONS_DETAILS_ONLY",
	"failOnPerformanceIssue": "false",		"failOnPerformanceIssue": "false",
Строка 245:		Строка 245:

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"batchId": "22396514015719218",		"batchId": "22396514015719218",
	"triggeringProblemsCount": 4,		"triggeringProblemsCount": 4,

ENetrebin: Новая страница: «Запускает пакетное выполнение синтетических мониторов. Запрос создает и использует в к...»

2022-10-21T12:50:16Z

Новая страница: «Запускает пакетное выполнение синтетических мониторов. Запрос создает и использует в к...»

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

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

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

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

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|body
|SyntheticOnDemandExecutionRequest
|Тело JSON запроса. Содержит параметры инициированного выполнения по требованию.
|body
|по желанию
|}

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

==== Объект <code>SyntheticOnDemandExecutionRequest</code> ====
Содержит параметры для запуска по запросу мониторов, идентифицированных тегами, приложениями или службами.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|processingMode
|string
|Режим обработки выполнения

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

* <code>STANDARD</code>
* <code>DISABLE_PROBLEM_DETECTION</code>
* <code>EXECUTIONS_DETAILS_ONLY</code>
|по желанию
|-
|failOnPerformanceIssue
|boolean
|Если true, статус будет FAILED в случае проблем с производительностью.
|по желанию
|-
|stopOnProblem
|boolean
|Если true, выполнение не будет запланировано в случае возникновения проблемы.
|по желанию
|-
|monitors
|SyntheticOnDemandExecutionRequestMonitor[]
|Список мониторов, которые будут активированы.
|по желанию
|-
|group
|SyntheticOnDemandExecutionRequestGroup
|Содержит параметры для запуска по запросу мониторов, идентифицированных тегами, приложениями или службами.
|по желанию
|}

==== Объект <code>SyntheticOnDemandExecutionRequestMonitor</code> ====
Содержит мониторы, запускаемые по запросу из указанных местоположений.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|monitorId
|string
|Идентификатор монитора
|требуется
|-
|locations
|string []
|Места, из которых должен выполняться монитор.
|по желанию
|}

==== Объект <code>SyntheticOnDemandExecutionRequestGroup</code> ====
Содержит параметры для запуска по запросу мониторов, идентифицированных тегами, приложениями или службами.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|tags
|string[]
|Список тегов. Будут выполняться только мониторы со всеми назначенными тегами.
|по желанию
|-
|applications
|string[]
|Список идентификаторов приложений. Будут выполняться только мониторы со всеми назначенными приложениями.
|по желанию
|-
|services
|string[]
|Список идентификаторов услуг. Будут выполняться только мониторы со всеми назначенными службами.
|по желанию
|-
|locations
|string[]
|Места, откуда должны выполняться мониторы.
|по желанию
|}

=== JSON-модель тела запроса ===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<code>{
"processingMode": "EXECUTIONS_DETAILS_ONLY",
"failOnPerformanceIssue": "false",
"stopOnProblem": "true",
"monitors": [
{
"monitorId": "HTTP_CHECK-6349B98E1CD87352",
"locations": [
"SYNTHETIC_LOCATION-9BB04DAEBA71B8CA",
"SYNTHETIC_LOCATION-ACCA399FAA1194DD"
]
}
],
"group": {
"applications": [
"APPLICATION-CD4BEF05FA9DD044"
],
"services": [
"SERVICE-01C6C1282960638B",
"SERVICE-B18840B4E3115C1A"
],
"tags": [
"tag-production",
"another-tag"
]
}
}</code>

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|201
|SyntheticOnDemandExecutionResult
|Успех. Детали ответа монитора на выполнение
|}

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

==== Объект <code>SyntheticOnDemandExecutionResult</code> ====
Результат выполнения синтетического монитора по требованию.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|batchId
|string
|Идентификатор пакета запущенных исполнений.
|-
|triggeringProblemsCount
|integer
|Общее количество проблем в пакете.
|-
|triggeringProblemsDetails
|SyntheticOnDemandTriggeringProblemDetails[]
|Список с объектами, для которых возникли проблемы с запуском.
|-
|triggeredCount
|integer
|Общее количество инициированных исполнений в пакете.
|-
|triggered
|SyntheticOnDemandTriggeredMonitor[]
|Мониторы, для которых были инициированы выполнения по требованию.
|}

==== Объект <code>SyntheticOnDemandTriggeringProblemDetails</code> ====
Содержит сведения о проблемах, возникших при запуске выполнения по требованию.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|entityId
|string
|Идентификатор объекта.
|-
|locationId
|string
|Идентификатор местоположения.
|-
|cause
|string
|Причина не запуска сущности.
|}

==== Объект <code>SyntheticOnDemandTriggeredMonitor</code> ====
Содержит список запусков монитора по запросу.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|monitorId
|string
|Идентификатор монитора.
|-
|executions
|SyntheticOnDemandTriggeredExecutionDetails[]
|Список инициированных выполнений.
|}

==== Объект <code>SyntheticOnDemandTriggeredExecutionDetails</code> ====
Содержит сведения о запущенном выполнении по требованию.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|executionId
|string
|Идентификатор выполнения.
|-
|locationId
|string
|Идентификатор места, из которого должен выполняться монитор.
|}

=== JSON-модель тела ответа ===
<code>{
"batchId": "22396514015719218",
"triggeringProblemsCount": 4,
"triggeringProblemsDetails": [
{
"entityId": "HTTP_CHECK-6349B98E1CD87352",
"locationId": "SYNTHETIC_LOCAT-9BB04DAEBA71B8CA",
"cause": "Location not found"
},
{
"entityId": "HTTP_CHECK-6349B98E1CD85432",
"cause": "Monitor not found"
},
{
"entityId": "HTTP_HACK-AAAAAAA",
"cause": "Incorrect monitor identifier format"
},
{
"entityId": "APPLICATION-WRONG",
"cause": "Incorrect application identifier format"
}
],
"triggeredCount": 1,
"triggered": [
{
"monitorId": "HTTP_CHECK-69A9B98E1CD87352",
"executions": [
{
"executionId": "1069999568093682590",
"locationId": "SYNTHETIC_LOCATION-9BB04DAE11123122"
}
]
}
]
}</code>

POST пакетное выполнение - История изменений

IKuznetsov в 17:23, 2 января 2025

IKuznetsov в 09:15, 26 декабря 2024

ENetrebin: Новая страница: «Запускает пакетное выполнение синтетических мониторов. Запрос создает и использует в к...»