GET сводка о пакетном выполнении: различия между версиями

Текущая версия от 17:23, 2 января 2025

API АппОптима / Эндпойнты среды / Развёртывание / Синтетика v2 / Отслеживание выполнения / GET сводка о пакетном выполнении

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

Запрос создает в качестве полезной нагрузки application/json формат.

GET	АппОптима	`https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/executions/batch/{batchId}`
GET	Среда АктивногоШлюза	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/synthetic/executions/batch/{batchId}`

Аутентификация

Чтобы выполнить этот запрос, вам нужен токен доступа с областью Чтение результатов выполнения синтетического монитора ( syntheticExecutions.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Параметр	Тип	Описание	In	Необходимость
batchId	integer	Идентификатор пакета выполнений.	path	требуется

Ответ

Коды ответов

Код	Тип	Описание
200	SyntheticOnDemandBatchStatus	Успех

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

Объект `SyntheticOnDemandBatchStatus`

Содержит информацию о запусках по требованию, запущенных в пакете.

Элемент	Тип	Описание
batchId	integer	Идентификатор пакета.
userId	string	Имя пользователя, инициировавшего выполнение пакета.
batchStatus	string	Статус партии. Элемент может содержать эти значения `FAILED` `FAILED_TO_EXECUTE` `NOT_TRIGGERED` `RUNNING` `SUCCESS`
triggeredCount	integer	Количество инициированных исполнений в пакете.
executedCount	integer	Количество запусков с результатом SUCCESS или FAILED.
failedCount	integer	Количество запусков с результатом FAILED.
failedExecutions	SyntheticOnDemandFailedExecutionStatus[]	-
failedToExecuteCount	integer	Количество выполнений, которые были запущены и истекли по тайм-ауту из-за проблемы с синтетическим движком.
failedToExecute	SyntheticOnDemandFailedExecutionStatus[]	-
triggeringProblemsCount	integer	Количество выполнений, которые не были запущены из-за некоторых проблем.
triggeringProblems	SyntheticOnDemandTriggeringProblemDetails[]	-

Объект `SyntheticOnDemandFailedExecutionStatus`

Содержит информацию о запусках по запросу, которые не удалось выполнить или которые не удалось выполнить.

Элемент	Тип	Описание
executionId	string	Идентификатор выполнения.
executionStage	string	Этап выполнения. Элемент может содержать эти значения `DATA_RETRIEVED` `EXECUTED` `NOT_TRIGGERED` `TIMED_OUT` `TRIGGERED`
failureMessage	string	Сообщение об ошибке.
errorCode	string	Код ошибки.
executionTimestamp	integer	Отметка времени завершения выполнения в миллисекундах UTC.
monitorId	string	Идентификатор монитора.
locationId	string	Идентификатор места, откуда должен выполняться монитор.

Объект `SyntheticOnDemandTriggeringProblemDetails`

Содержит сведения о проблемах, возникших при запуске выполнения по требованию.

Элемент	Тип	Описание
entityId	string	Идентификатор объекта.
locationId	string	Идентификатор местоположения.
cause	string	Причина не запуска объекта.

JSON-модель тела ответа

<{
  "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"
    }
  ]
}

@@ Строка 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 сводка о пакетном выполнении'''''
 Получает сводку по пакетному выполнению синтетических мониторов.
@@ Строка 208: / Строка 210: @@
       }
     ]
-  }</code>
+  }