API журнала запросов

Важно!

Эта функция предоставляется в режиме общедоступной предварительной версии. Чтобы запросить доступ, свяжитесь со своим представителем Azure Databricks.

Важно!

Чтобы получить доступ к REST API Databricks, необходимо пройти проверку подлинности.

Список

Конечная точка Метод HTTP
2.0/sql/history/queries GET

Вывод журнала запросов с помощью конечных точек SQL. Можно выполнить фильтрацию по ИДЕНТИФИКАТОРу пользователя, ИДЕНТИФИКАТОРу конечной точки, состоянию и диапазону времени.

Запрос

Имя поля Тип Описание
filter_by PrincipalSearcher Фильтр для ограничения результатов журнала запросов. Это поле является необязательным.
max_results INT32 Ограничьте число результатов, возвращаемых на одной странице. Значение по умолчанию — 100.
page_token STRING Непрозрачный токен, используемый для получения следующей страницы результатов. Это поле является необязательным.

Ответ

Имя поля Тип Описание
next_page_token STRING Непрозрачный токен, используемый для получения следующей страницы.
has_next_page BOOLEAN Существует ли другая страница результатов.
res Массив куеринфо Результаты запроса.

Пример запроса

{
  "filter_by": {
    "statuses": ["RUNNING"],
    "user_ids": [12345],
    "endpoint_ids": ["1234567890abcdef"],
  },
  "max_results": 100
}

Пример ответа

{
  "next_page_token": "Ci0KJDU4NjEwZjY5LTgzNzUtNDdiMS04YTg1LWYxNTU5ODI5MDYyMhDdobu YuS4SABhk",
  "has_next_page": true,
  "res": [
    {
      "query_id": "26b5c452-1dff-429e-9b55-7c16131c89ee",
      "status": "FINISHED",
      "query_text": "select 1 + 1",
      "query_start_time_ms": 1595357086200,
      "execution_end_time_ms": 1595357086373,
      "query_end_time_ms": 1595357087200,
      "user_id": [12345],
      "user_name": "user@example.com",
      "spark_ui_url":"https://<databricks-instance>/sparkui/0710-201419-test887/driver-8401376710892156045/SQL/execution/?id=0",
      "endpoint_id": "1234567890abcdef",
      "rows_produced": 100,
    },
    {
      "query_id": "26b5c452-1dff-429e-9b55-7c16131c89ee",
      "status": "FAILED",
      "query_text": "select 1 + 1",
      "query_start_time_ms": 1595357196200,
      "user_id": [12345],
      "user_name": "user@example.com",
      "endpoint_id": "1234567890abcdef",
      "error_message": "Query failed because ...",
    }
  ]
}

Структуры данных

PrincipalSearcher

Имя поля Тип Описание
statuses Массив QueryStatus Состояния запросов.
user_ids Массив INT64 Идентификаторы пользователей, которые запустили запросы.
endpoint_ids Массив STRING Идентификаторы конечных точек, на которых выполнялись запросы.
query_start_time_range Диапазон времени Диапазон времени, в течение которого запущены запросы.

куеринфо

Имя поля Тип Описание
query_id INT64 Идентификатор запроса.
status QueryStatus Состояние запроса.
query_text STRING Текст запроса.
query_start_time_ms INT64 Время начала запроса.
execution_end_time_ms INT64 Время выполнения запроса завершено.
query_end_time_ms INT64 Время окончания запроса.
user_id INT64 Идентификатор пользователя, выполнившего запрос.
имя_пользователя STRING Адрес электронной почты пользователя, выполнившего запрос.
spark_ui_url STRING URL-адрес плана запроса.
endpoint_id STRING Идентификатор конечной точки.
error_message STRING Сообщение, описывающее причину невозможности выполнения запроса.
rows_produced INT32 Число результатов, возвращенных запросом.

QueryStatus

Состояние Описание
QUEUED Запрос получен и поставлен в очередь.
RUNNING Выполнение запроса начато.
CANCELED Запрос отменен пользователем.
FAILED Сбой выполнения запроса.
FINISHED Выполнение запроса завершено.

Диапазон времени

Имя поля Тип Описание
start_time_ms INT64 Ограничить результаты запросами, которые были запущены после этого времени.
end_time_ms INT64 Ограничьте результаты запросами, которые были запущены до этого времени.