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

2025-01-02T17:22:08Z

← Предыдущая версия		Версия от 17:22, 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 Отслеживание выполнения] / GET все выполнения по требованию'''''

	Получает список всех исполнений синтетических мониторов по требованию.		Получает список всех исполнений синтетических мониторов по требованию.

Строка 415:		Строка 417:
	}		}
	]		]
	}~~</code>~~		}

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

2024-12-26T09:37:50Z

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

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"executions": [		"executions": [
	{		{

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

2022-10-21T11:49:44Z

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

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

Получает список всех исполнений синтетических мониторов по требованию.

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

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

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|executionStage
|string
|Фильтрует результирующий набор исполнений по их стадии.

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

* <code>TRIGGERED</code>
* <code>EXECUTED</code>
* <code>DATA_RETRIEVED</code>
|query
|по желанию
|-
|schedulingFrom
|string
|Начало запрошенного периода времени для планирования временных меток.

Вы можете использовать один из следующих форматов:

* Отметка времени в миллисекундах UTC.
* Человекочитаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.
* Относительный таймфрейм, назад. Формат: <code>now-NU/A</code>, где <code>N</code>количество времени, <code>U</code>единица времени и <code>A</code>выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, <code>now-1y/w</code>это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: <code>now-NU</code>. Поддерживаемые единицы времени для относительного таймфрейма:
** <code>m</code>: минуты
** <code>h</code>: часы
** <code>d</code>: дни
** <code>w</code>: недели
** <code>M</code>: месяцы
** <code>y</code>: годы

Если не установлено, используется максимальный относительный таймфрейм в шесть часов ( <code>now-6h</code>).
|query
|по желанию
|-
|schedulingTo
|string
|Конец запрошенного периода времени для планирования меток времени.

Вы можете использовать один из следующих форматов:

* Отметка времени в миллисекундах UTC.
* Человекочитаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.
* Относительный таймфрейм, назад. Формат: <code>now-NU/A</code>, где <code>N</code>количество времени, <code>U</code>единица времени и <code>A</code>выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, <code>now-1y/w</code>это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: <code>now-NU</code>. Поддерживаемые единицы времени для относительного таймфрейма:
** <code>m</code>: минуты
** <code>h</code>: часы
** <code>d</code>: дни
** <code>w</code>: недели
** <code>M</code>: месяцы
** <code>y</code>: годы

Если не установлено, используется текущая метка времени.
|query
|по желанию
|-
|executionFrom
|string
|Начало запрошенного таймфрейма для временных меток выполнения.

Вы можете использовать один из следующих форматов:

* Отметка времени в миллисекундах UTC.
* Человекочитаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.
* Относительный таймфрейм, назад. Формат: <code>now-NU/A</code>, где <code>N</code>количество времени, <code>U</code>единица времени и <code>A</code>выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, <code>now-1y/w</code>это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: <code>now-NU</code>. Поддерживаемые единицы времени для относительного таймфрейма:
** <code>m</code>: минуты
** <code>h</code>: часы
** <code>d</code>: дни
** <code>w</code>: недели
** <code>M</code>: месяцы
** <code>y</code>: годы

Если не установлено, используется максимальный относительный таймфрейм в шесть часов ( <code>now-6h</code>).
|query
|по желанию
|-
|executionTo
|string
|Конец запрошенного периода времени для временных меток выполнения.

Вы можете использовать один из следующих форматов:

* Отметка времени в миллисекундах UTC.
* Человекочитаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.
* Относительный таймфрейм, назад. Формат: <code>now-NU/A</code>, где <code>N</code>количество времени, <code>U</code>единица времени и <code>A</code>выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, <code>now-1y/w</code>это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: <code>now-NU</code>. Поддерживаемые единицы времени для относительного таймфрейма:
** <code>m</code>: минуты
** <code>h</code>: часы
** <code>d</code>: дни
** <code>w</code>: недели
** <code>M</code>: месяцы
** <code>y</code>: годы

Если не установлено, используется текущая метка времени.
|query
|по желанию
|-
|dataDeliveryFrom
|string
|Начало запрошенного таймфрейма для временных меток доставки данных.

Вы можете использовать один из следующих форматов:

* Отметка времени в миллисекундах UTC.
* Человекочитаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.
* Относительный таймфрейм, назад. Формат: <code>now-NU/A</code>, где <code>N</code>количество времени, <code>U</code>единица времени и <code>A</code>выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, <code>now-1y/w</code>это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: <code>now-NU</code>. Поддерживаемые единицы времени для относительного таймфрейма:
** <code>m</code>: минуты
** <code>h</code>: часы
** <code>d</code>: дни
** <code>w</code>: недели
** <code>M</code>: месяцы
** <code>y</code>: годы

Если не установлено, используется максимальный относительный таймфрейм в шесть часов ( <code>now-6h</code>).
|query
|по желанию
|-
|dataDeliveryTo
|string
|Конец запрошенного периода времени для доставки данных с метками времени.

Вы можете использовать один из следующих форматов:

* Отметка времени в миллисекундах UTC.
* Человекочитаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.
* Относительный таймфрейм, назад. Формат: <code>now-NU/A</code>, где <code>N</code>количество времени, <code>U</code>единица времени и <code>A</code>выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, <code>now-1y/w</code>это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: <code>now-NU</code>. Поддерживаемые единицы времени для относительного таймфрейма:
** <code>m</code>: минуты
** <code>h</code>: часы
** <code>d</code>: дни
** <code>w</code>: недели
** <code>M</code>: месяцы
** <code>y</code>: годы

Если не установлено, используется текущая метка времени.
|query
|по желанию
|-
|batchId
|integer
|Фильтрует результирующий набор выполнений по пакету. Укажите идентификатор пакета.
|query
|по желанию
|-
|monitorId
|string
|Фильтрует результирующий набор исполнений по монитору синтетического монитора. Показывает идентификатор монитора.
|query
|по желанию
|-
|locationId
|string
|Фильтрует результирующий набор исполнений по синтетическому местоположению. Показывает идентификатор местоположения.
|query
|по желанию
|-
|userId
|string
|Фильтрует результирующий набор выполнений по запланированному пользователю.
|query
|по желанию
|}

== Ответ ==

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

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

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

==== Объект <code>SyntheticOnDemandExecution</code> ====
Описывает состояние выполнения по запросу.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|batchId
|string
|Идентификатор пакета.
|-
|executionId
|string
|Идентификатор выполнения.
|-
|executionStage
|string
|Этап выполнения.

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

* <code>DATA_RETRIEVED</code>
* <code>EXECUTED</code>
* <code>NOT_TRIGGERED</code>
* <code>TIMED_OUT</code>
* <code>TRIGGERED</code>
|-
|schedulingTimestamp
|integer
|Отметка времени планирования в миллисекундах UTC.
|-
|executionTimestamp
|integer
|Отметка времени завершения выполнения в миллисекундах UTC.
|-
|dataDeliveryTimestamp
|integer
|Отметка времени, когда весь набор данных был собран на сервере, в миллисекундах UTC.
|-
|monitorId
|string
|Идентификатор монитора.
|-
|locationId
|string
|Идентификатор места, откуда должен выполняться монитор.
|-
|userId
|string
|Имя пользователя, инициировавшего выполнение по требованию.
|-
|simpleResults
|ExecutionSimpleResults
|Содержит основные результаты выполнения монитора по запросу.
|-
|fullResults
|ExecutionFullResults
|Содержит подробные сведения о выполнении расширенного монитора.
|}

==== Объект <code>ExecutionSimpleResults</code> ====
Содержит основные результаты выполнения монитора по запросу.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|status
|string
|Статус выполнения.
|-
|failureMessage
|string
|Сообщение об ошибке.
|-
|errorCode
|string
|Код ошибки.
|-
|responseStatusCode
|integer
|Код статуса ответа.
|-
|executedSteps
|integer
|Количество выполненных шагов синтетическим движком
|-
|engineId
|integer
|Идентификатор синтетического движка, на котором выполнялся монитор.
|-
|httperror
|boolean
|Сообщает, есть ли ошибка HTTP.
|-
|chromeError
|boolean
|Сообщает, является ли ошибка Chrome.
|-
|hostNameResolutionTime
|integer
|Время разрешения имени хоста, измеряемое в миллисекундах.
|-
|tcpConnectTime
|integer
|Время соединения TCP, измеряемое в миллисекундах.
|-
|tlsHandshakeTime
|integer
|Время рукопожатия TLS, измеряемое в миллисекундах.
|-
|timeToFirstByte
|integer
|Время до первого байта, измеряемое в миллисекундах.
|-
|redirectionTime
|integer
|Общее количество миллисекунд, затраченное на обработку всех запросов перенаправления, измеряемое в миллисекундах.
|-
|redirectsCount
|integer
|Количество редиректов.
|-
|publicLocation
|boolean
|Флаг сообщает, был ли запрос выполнен в публичном месте.
|-
|responseSize
|integer
|Размер ответа на запрос в байтах.
|-
|responseBodySizeLimitExceeded
|boolean
|Флаг, указывающий, что превышен предельный размер полезной нагрузки ответа, равный 10 МБ.
|-
|peerCertificateExpiryDate
|integer
|Дата истечения срока действия первого SSL-сертификата из цепочки сертификатов.
|-
|totalTime
|integer
|Общее время измеряется в миллисекундах.
|-
|startTimestamp
|integer
|Отметка времени начала.
|}

==== Объект <code>ExecutionFullResults</code> ====
Содержит подробные сведения о выполнении расширенного монитора.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|status
|string
|Статус выполнения.
|-
|failureMessage
|string
|Сообщение об ошибке.
|-
|errorCode
|string
|Код ошибки.
|-
|executionStepCount
|integer
|Количество выполненных шагов.
|-
|executionSteps
|ExecutionStep[]
|Подробная информация о выполнении шага монитора.
|}

==== Объект <code>ExecutionStep</code> ====
Содержит подробную информацию о выполнении шага монитора.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|monitorType
|string
|Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:

* <code>BROWSER</code>-> BMAction
* <code>HTTP</code>-> MonitorRequestExecutionResult

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

* <code>BROWSER</code>
* <code>HTTP</code>
|}

=== JSON-модель тела ответа ===
<code>{
"executions": [
{
"executionId": "7002396514015719218",
"schedulingTimestamp": "1629891686877",
"executionTimestamp": "1629891695487",
"monitorId": "HTTP_CHECK-6349B98E1CD87352",
"locationId": "SYNTHETIC_LOCATION-9BB04DAEBA71B8CA",
"executionStage": "EXECUTED",
"userId": "someUserIdentifier"
}
]
}</code>

GET все выполнения по требованию - История изменений

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

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

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