Метод listLogs
Получает логи для указанного кластера Apache Kafka®.
Дополнительные сведения о логах см. в разделе Logs документации.
HTTP-запрос
GET https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters/{clusterId}:logs
Path-параметры
Параметр | Описание |
---|---|
clusterId | Обязательное поле. Идентификатор кластера Apache Kafka®, для которого нужно получить логи. Чтобы получить идентификатор кластера Apache Kafka®, выполните запрос list. Максимальная длина строки в символах — 50. |
Query-параметры
Параметр | Описание |
---|---|
columnFilter | Столбцы, которые нужно запросить из лога. Если столбцы не указаны, записи логов возвращаются целиком. |
fromTime | Временная метка, начиная с которой следует запросить логи. Строка в формате RFC3339. |
toTime | Временная метка, до которой следует запросить логи. Строка в формате RFC3339. |
pageSize | Максимальное количество результатов на одной странице в ответе. Если количество результатов больше чем pageSize, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Максимальное значение — 1000. |
pageToken | Токен страницы. Установите значение pageToken равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
alwaysNextPageToken | Флаг, определяющий поведение при предоставлении маркера следующей страницы. Если этот флаг установлен в true , этот метод API всегда будет возвращать nextPageToken, даже если текущая страница пуста. |
filter | Выражение, позволяющее отфильтровать информацию о ресурсах в ответе, оставив только нужную. В этом выражении должны быть указаны: 1. Имя поля, по которому нужно выполнить фильтрацию. В настоящее время фильтрацию можно использовать только по полю hostname . 2. Условный оператор. Поддерживаются операторы = и != для одиночных значений, IN и NOT IN для списков значений. 3. Значение. Должно содержать от 1 до 63 символов и соответствовать регулярному выражению ^[a-z0-9.-]{1,61}$ . Пример фильтра: hostname='node1.db.cloud.yandex.net' Максимальная длина строки в символах — 1000. |
Ответ
HTTP Code: 200 - OK
{
"logs": [
{
"timestamp": "string",
"message": "object"
}
],
"nextPageToken": "string"
}
Поле | Описание |
---|---|
logs[] | object Записи в журнале. |
logs[]. timestamp |
string (date-time) Временная метка для записи в логе. Строка в формате RFC3339. |
logs[]. message |
object Содержимое записи в логе. |
nextPageToken | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов. Это значение взаимозаменяемо с |