Метод listLogs
Возвращает логи для указанного кластера SQL Server.
Для получения дополнительной информации о логах см. раздел Просмотр логов кластера" в документации.
HTTP-запрос
GET https://mdb.api.cloud.yandex.net/mdb/sqlserver/v1alpha/clusters/{clusterId}:logs
Path-параметры
| Параметр | Описание |
|---|---|
| clusterId | Обязательное поле. Идентификатор кластера SQL Server, для которого нужно получить логи. Чтобы получить идентификатор кластера SQL Server, используйте запрос list. Максимальная длина строки в символах — 50. |
Query-параметры
| Параметр | Описание |
|---|---|
| columnFilter | Столбцы, которые нужно запросить из лога. Если столбцы не указаны, записи логов возвращаются целиком. |
| serviceType | Тип сервиса, для которого следует запросить логи.
|
| fromTime | Временная метка, начиная с которой следует запросить логи. Строка в формате RFC3339. |
| toTime | Временная метка, до которой следует запросить логи. Строка в формате RFC3339. |
| pageSize | Максимальное количество результатов на одной странице в ответе. Если количество результатов больше чем page_size, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Допустимые значения — от 0 до 1000 включительно. |
| pageToken | Токен страницы. Установите значение page_token равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
| alwaysNextPageToken | Всегда возвращать next_page_token, даже если текущая страница пуста. |
| filter | Выражение, позволяющее отфильтровать информацию о ресурсах в ответе, оставив только нужную. В этом выражении должны быть указаны: 1. Имя поля, по которому нужно выполнить фильтрацию. В настоящее время фильтрацию можно использовать только по полю [LogRecord.logs.message.hostname]. 2. Условный оператор. Поддерживаются операторы = и != для одиночных значений, IN и NOT IN для списков значений. 3. Значение. Должно содержать от 1 до 63 символов и соответствовать регулярному выражению ^[a-z0-9.-]{1,61}$. Примеры фильтров: message.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, используйте |