GET все выполнения по требованию
Материал из Документация Ключ-АСТРОМ
Получает список всех исполнений синтетических мониторов по требованию.
Запрос создает в качестве полезной нагрузки application/json формат.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/executions
|
| Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/synthetic/executions
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью Чтение результатов выполнения синтетического монитора ( syntheticExecutions.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| executionStage | string | Фильтрует результирующий набор исполнений по их стадии.
Элемент может содержать эти значения
|
query | по желанию |
| schedulingFrom | string | Начало запрошенного периода времени для планирования временных меток.
Вы можете использовать один из следующих форматов:
Если не установлено, используется максимальный относительный таймфрейм в шесть часов ( |
query | по желанию |
| schedulingTo | string | Конец запрошенного периода времени для планирования меток времени.
Вы можете использовать один из следующих форматов:
Если не установлено, используется текущая метка времени. |
query | по желанию |
| executionFrom | string | Начало запрошенного таймфрейма для временных меток выполнения.
Вы можете использовать один из следующих форматов:
Если не установлено, используется максимальный относительный таймфрейм в шесть часов ( |
query | по желанию |
| executionTo | string | Конец запрошенного периода времени для временных меток выполнения.
Вы можете использовать один из следующих форматов:
Если не установлено, используется текущая метка времени. |
query | по желанию |
| dataDeliveryFrom | string | Начало запрошенного таймфрейма для временных меток доставки данных.
Вы можете использовать один из следующих форматов:
Если не установлено, используется максимальный относительный таймфрейм в шесть часов ( |
query | по желанию |
| dataDeliveryTo | string | Конец запрошенного периода времени для доставки данных с метками времени.
Вы можете использовать один из следующих форматов:
Если не установлено, используется текущая метка времени. |
query | по желанию |
| batchId | integer | Фильтрует результирующий набор выполнений по пакету. Укажите идентификатор пакета. | query | по желанию |
| monitorId | string | Фильтрует результирующий набор исполнений по монитору синтетического монитора. Показывает идентификатор монитора. | query | по желанию |
| locationId | string | Фильтрует результирующий набор исполнений по синтетическому местоположению. Показывает идентификатор местоположения. | query | по желанию |
| userId | string | Фильтрует результирующий набор выполнений по запланированному пользователю. | query | по желанию |
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | SyntheticOnDemandExecutions | Успех |
Объекты тела ответа
Объект SyntheticOnDemandExecutions
Содержит список синтетических исполнений по запросу.
| Элемент | Тип | Описание |
|---|---|---|
| executions | SyntheticOnDemandExecution[] | Список выполнений |
Объект SyntheticOnDemandExecution
Описывает состояние выполнения по запросу.
| Элемент | Тип | Описание |
|---|---|---|
| batchId | string | Идентификатор пакета. |
| executionId | string | Идентификатор выполнения. |
| executionStage | string | Этап выполнения.
Элемент может содержать эти значения
|
| 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 | Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
Элемент может содержать эти значения
|
JSON-модель тела ответа
{
"executions": [
{
"executionId": "7002396514015719218",
"schedulingTimestamp": "1629891686877",
"executionTimestamp": "1629891695487",
"monitorId": "HTTP_CHECK-6349B98E1CD87352",
"locationId": "SYNTHETIC_LOCATION-9BB04DAEBA71B8CA",
"executionStage": "EXECUTED",
"userId": "someUserIdentifier"
}
]
}
