GET основная информация о выполнении

Материал из Документация Ключ-АСТРОМ
Версия от 12:16, 21 октября 2022; ENetrebin (обсуждение | вклад) (Новая страница: «Получает основные результаты выполнения синтетического монитора по запросу. Запрос со...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Получает основные результаты выполнения синтетического монитора по запросу.

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

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

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

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

Параметры

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

Ответ

Коды ответов

Код Тип Описание
200 SyntheticOnDemandExecution Успех. Ответ содержит основную информацию о выполнении по запросу.

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

Объект SyntheticOnDemandExecution

Описывает состояние выполнения по запросу.

Элемент Тип Описание
batchId string Идентификатор пакета.
executionId string Идентификатор выполнения.
executionStage string Этап выполнения.

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

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

Объект ExecutionSimpleResults

Содержит основные результаты выполнения монитора по запросу.

Элемент Тип Описание
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 Отметка времени начала.

Объект ExecutionFullResults

Содержит подробные сведения о выполнении расширенного монитора.

Элемент Тип Описание
status string Статус выполнения.
failureMessage string Сообщение об ошибке.
errorCode string Код ошибки.
executionStepCount integer Количество выполненных шагов.
executionSteps ExecutionStep[] Подробная информация о выполнении шага монитора.

Объект ExecutionStep

Содержит подробную информацию о выполнении шага монитора.

Элемент Тип Описание
monitorType string Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
  • BROWSER-> BMAction
  • HTTP-> MonitorRequestExecutionResult

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

  • BROWSER
  • HTTP

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

{
  "batchId": "22396514015719218",
  "executionId": "7002396514015719218",
  "executionStage": "DATA_RETRIEVED",
  "schedulingTime": "1629891686877",
  "executionTimestamp": "1629891695487",
  "dataDeliveryTimestamp": "1629891701171",
  "monitorId": "HTTP_CHECK-6349B98E1CD87352",
  "locationId": "SYNTHETIC_LOCATION-9BB04DAEBA71B8CA",
  "userId": "someUserIdentifier",
  "simpleResults": [
    {
      "startTimestamp": "1629891693487",
      "engineId": "1993198092",
      "executedSteps": "1",
      "totalTime": "955",
      "publicLocation": "false",
      "tlsHandshakeTime": "167",
      "tcpConnectTime": "127",
      "hostNameResolutionTime": "50",
      "redirectionTime": "576",
      "responseBodySizeLimitExceeded": "false",
      "peerCertificateExpiryDate": "0",
      "responseStatusCode": "200",
      "healthStatus": "HEALTHY",
      "responseSize": "1530652"
    }
  ]
}