GET HTTP монитор
Материал из Документация Ключ-АСТРОМ
Версия от 11:15, 21 октября 2022; ENetrebin (обсуждение | вклад) (Новая страница: «Получает результат самого последнего выполнения указанного монитора HTTP. Запрос создае...»)
Получает результат самого последнего выполнения указанного монитора HTTP.
Запрос создает в качестве полезной нагрузки application/json формат.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/execution/{monitorId}/{resultType}
|
| Cреда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/synthetic/execution/{monitorId}/{resultType}
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( DataExport) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| monitorId | string | Идентификатор HTTP-монитора, для которого возвращается последний результат выполнения. | path | требуется |
| resultType | string | Определяет тип результата выполнения последнего HTTP-монитора.
Элемент может содержать эти значения
|
path | требуется |
| locationId | string | Фильтрует результаты для тех, которые выполняются по указанному синтетическому местоположению. Требуется указать идентификатор местоположения. | query | по желанию |
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | MonitorExecutionResults | Успех. Ответ содержит подробные данные. |
Объекты тела ответа
Объект MonitorExecutionResults
Результаты выполнения всех запросов HTTP-монитора.
| Элемент | Тип | Описание |
|---|---|---|
| monitorId | string | Идентификатор монитора. |
| locationsExecutionResults | LocationExecutionResults[] | Список с результатами запросов, выполненных на заданных локациях. |
Объект LocationExecutionResults
Результаты выполнения запросов HTTP-монитора в заданном месте
| Элемент | Тип | Описание |
|---|---|---|
| locationId | string | Идентификатор местоположения. |
| executionId | string | Идентификатор исполнения. |
| requestResults | MonitorRequestExecutionResult[] | Список результатов запросов монитора, выполненных в этом расположении. |
Объект MonitorRequestExecutionResult
Результат выполнения запроса HTTP-монитора.
Объект не предоставляет никаких параметров.
Объект ExecutionStep
Содержит подробную информацию о выполнении шага монитора.
| Элемент | Тип | Описание |
|---|---|---|
| monitorType | string | Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
Элемент может содержать эти значения
|
Объект MonitorRequestHeader
Заголовок HTTP-запроса
| Элемент | Тип | Описание |
|---|---|---|
| name | string | Имя заголовка. |
| value | string | Значение заголовка. |
JSON-модель тела ответа
{
"monitorId": "HTTP_CHECK-12B428F6D37A9197",
"locationsExecutionResults": [
{
"locationId": "7804738439930364165",
"executionId": "6136172183050046113",
"requestResults": [
{
"requestId": "HTTP_CHECK_STEP-53071FC3C4F72E28",
"requestName": "Request name",
"sequenceNumber": 1,
"startTimestamp": 1615806570884,
"engineId": 338502283,
"publicLocation": false,
"url": "https://www.examplePage.com",
"method": "GET",
"requestBody": "",
"requestHeaders": [
{
"name": "User-Agent",
"value": "AstromkeySynthetic/1.215.1"
},
{
"name": "X-Astromkey-Visit",
"value": "6136172183050046113"
},
{
"name": "X-Astromkey-Test",
"value": "HTTP_CHECK-12B428F6D37A9197"
}
],
"responseStatusCode": 200,
"responseBody": "<html><head>Title</head><body>Main Page</body></html>",
"responseSize": 1112,
"responseBodySizeLimitExceeded": false,
"responseHeaders": [
{
"name": "Date",
"value": "Mon, 15 Mar 2021 11:09:30 GMT"
},
{
"name": "Content-Language",
"value": "en"
}
],
"resolvedIps": [
"80.252.0.145"
],
"errorCode": 0,
"responseMessage": "OK",
"peerCertificateExpiryDate": 1647302399000,
"peerCertificateDetails": "[Certificate details]",
"totalTime": 238,
"hostNameResolutionTime": 26,
"tcpConnectTime": 15,
"tlsHandshakeTime": 8,
"timeToFirstByte": 96,
"redirectionTime": 70,
"waitingTime": 47,
"redirectsCount": 1,
"failureMessage": ""
}
]
}
]
}
