Просмотр кода страницы GET сводка о пакетном выполнении

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

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

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

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|batchId
|integer
|Идентификатор пакета выполнений.
|path
|требуется
|}

== Ответ ==

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

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

==== Объект <code>SyntheticOnDemandBatchStatus</code> ====
Содержит информацию о запусках по требованию, запущенных в пакете.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|batchId
|integer
|Идентификатор пакета.
|-
|userId
|string
|Имя пользователя, инициировавшего выполнение пакета.
|-
|batchStatus
|string
|Статус партии.

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

* <code>FAILED</code>
* <code>FAILED_TO_EXECUTE</code>
* <code>NOT_TRIGGERED</code>
* <code>RUNNING</code>
* <code>SUCCESS</code>
|-
|triggeredCount
|integer
|Количество инициированных исполнений в пакете.
|-
|executedCount
|integer
|Количество запусков с результатом SUCCESS или FAILED.
|-
|failedCount
|integer
|Количество запусков с результатом FAILED.
|-
|failedExecutions
|SyntheticOnDemandFailedExecutionStatus[]
| -
|-
|failedToExecuteCount
|integer
|Количество выполнений, которые были запущены и истекли по тайм-ауту из-за проблемы с синтетическим движком.
|-
|failedToExecute
|SyntheticOnDemandFailedExecutionStatus[]
| -
|-
|triggeringProblemsCount
|integer
|Количество выполнений, которые не были запущены из-за некоторых проблем.
|-
|triggeringProblems
|SyntheticOnDemandTriggeringProblemDetails[]
| -
|}

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

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

* <code>DATA_RETRIEVED</code>
* <code>EXECUTED</code>
* <code>NOT_TRIGGERED</code>
* <code>TIMED_OUT</code>
* <code>TRIGGERED</code>
|-
|failureMessage
|string
|Сообщение об ошибке.
|-
|errorCode
|string
|Код ошибки.
|-
|executionTimestamp
|integer
|Отметка времени завершения выполнения в миллисекундах UTC.
|-
|monitorId
|string
|Идентификатор монитора.
|-
|locationId
|string
|Идентификатор места, откуда должен выполняться монитор.
|}

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

=== JSON-модель тела ответа ===
 <code>{
   "batchId": "22396514015719218",
   "userId": "admin",
   "batchStatus": "FAILED_TO_EXECUTE",
   "triggeredCount": "3",
   "executedCount": "1",
   "failedCount": "1",
   "failedExecutions": [
     {
       "executionId": "1629891693487",
       "executionStage": "EXECUTED",
       "failureMessage": "Validate text match failed",
       "errorCode": "CONSTRAINT_VIOLATED(3)",
       "executionTimestamp": "1629891695487",
       "monitorId": "HTTP_CHECK-6349B98E1CD87352",
       "locationId": "SYNTHETIC_LOCATION-9BB04DAEBA71B8CA"
     }
   ],
   "failedToExecuteCount": "1",
   "failedToExecute": [
     {
       "executionId": "478437504",
       "executionStage": "TIMED_OUT",
       "monitorId": "SYNTHETIC_TEST-027011D7D27CC892",
       "locationId": "SYNTHETIC_LOCATION-90380DA8A44C74BD"
     }
   ],
   "triggeringProblemsCount": "2",
   "triggeringProblems": [
     {
       "entityId": "HTTP_CHECK-6349B98E1CD87352",
       "locationId": "SYNTHETIC_LOCAT-9BB04DAEBA71B8CA",
       "cause": "Location not found"
     },
     {
       "entityId": "APPLICATION-WRONG",
       "cause": "Incorrect application identifier format"
     }
   ]
 }</code>