Получает записи лога, соответствующие указанным критериям. Совпадающие записи лога сортируются по критериям, указанным в параметре запроса sort , а затем возвращаются первые X записей (как указано в параметре запроса limit ). Чтобы выполнить запрос без ограничения размера, используйте запрос GET на экспорт журналов .
Если полученный журнал слишком велик, он делится на слайсы. В таких случаях первый ответ содержит nextSliceKey для второго слайса. Используйте его в параметре запроса nextSliceKey для получения второго слайса, который, в свою очередь, содержит nextSliceKey для третьего слайса и так далее.
Результаты могут быть неравномерно распределены между срезами, а некоторые срезы могут быть пустыми.
Запрос создает application/jsonполезную нагрузку.
| GET |
|
Аутентификация
Чтобы выполнить этот запрос, вам необходимо разрешение на Чтение логов( logs.read), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| from | string | Начало запрошенного таймфрейма.
Вы можете использовать один из следующих форматов:
Если не задано, используется относительный двухнедельный таймфрейм ( |
запрос | по желанию |
| to | string | Конец запрошенного периода времени.
Вы можете использовать один из следующих форматов:
Если не установлено, используется текущая метка времени. |
запрос | по желанию |
| limit | integer | Желаемое количество записей журнала.
Максимально допустимый лимит составляет 1000. Если не установлено, используется 1000. |
запрос | по желанию |
| query | string | Поисковый запрос журнала.
Запрос должен использовать язык поисковых запросов Ключ-АСТРОМ . Запрос имеет ограничение в 20 отношений (логические операторы между простыми выражениями ( |
запрос | по желанию |
| sort | string | Определяет порядок записей журнала.
Каждое поле имеет префикс знака (+/-) для порядка сортировки. Если префикс знака не установлен, В настоящее время упорядочивание доступно только для временной метки (+timestamp для самых старых записей первыми или -timestamp для самых новых записей). Если разрешения в миллисекундах, предоставляемого отметкой времени, недостаточно, записи журнала сортируются в соответствии с порядком, в котором они появляются в источнике журнала (удаленный процесс, записывающий в конечную точку REST API, или удаленный процесс, из которого собираются журналы). |
запрос | по желанию |
| nextSliceKey | string | Курсор для следующего фрагмента результатов. Вы можете найти его в поле nextSliceKey предыдущего ответа.
Первый срез всегда возвращается, если вы не укажете этот параметр. Если этот параметр установлен, все остальные параметры запроса игнорируются. |
запрос | по желанию |
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | Список записей журнала | Успех |
| 400 | ErrorEnvelope | Не удалось. Ввод недействителен. |
Объекты тела ответа
Объект _ LogRecordsList
Список извлеченных записей лога.
| Элемент | Тип | Описание |
|---|---|---|
| results | LogRecord[] | Список извлеченных записей журнала. |
| nextSliceKey | string | Курсор для следующего фрагмента записей журнала. |
| sliceSize | integer | Общее количество записей в срезе. |
Объект _ LogRecord
Единая запись журнала.
| Элемент | Тип | Описание |
|---|---|---|
| additionalColumns | object | Дополнительные столбцы записи журнала. |
| content | string | Содержимое записи журнала. |
| timestamp | integer | Временная метка записи журнала в миллисекундах UTC. |
| eventType | string | Тип события
Элемент может содержать эти значения |
| status | string | Состояние журнала (на основе уровня журнала).
Элемент может содержать эти значения
|
JSON-модель тела ответа
{
"results": [
{
"timestamp": "1631193089000",
"status": "ERROR",
"content": "example log content",
"event.type": "LOG",
"additionalColumns": {
"custom.attribute": [
"value1",
"value2"
],
"loglevel": [
"SEVERE"
]
}
}
],
"sliceSize": 100,
"nextSliceKey": "___-2hI03q0AAAAAAAAAAAAAA-gAAAAAAAAH0P____8AAABkAAAACXRpbWVzdGFtcAD___7aEjTerQ"
}