API del historial de consultas

Importante

Esta característica está en versión preliminar pública. Para solicitar acceso, póngase en contacto con un representante de Azure Databricks.

Importante

Para acceder a las API REST de Databricks, es preciso autenticarse.

List

Punto de conexión Método HTTP
2.0/sql/history/queries GET

Enumera el historial de consultas a través de puntos de conexión de SQL. Puede filtrar por identificador de usuario, identificador de punto de conexión, estado e intervalo de tiempo.

Solicitud

Nombre del campo Tipo Descripción
filter_by QueryFilter Filtro para limitar los resultados del historial de consultas. Este campo es opcional.
max_results INT32 Limite el número de resultados devueltos en una página. El valor predeterminado es 100.
page_token STRING Token opaco que se usa para obtener la siguiente página de resultados. Este campo es opcional.

Response

Nombre del campo Tipo Descripción
next_page_token STRING Token opaco que se usa para obtener la página siguiente.
has_next_page BOOLEAN Si hay otra página de resultados.
res Matriz de QueryInfo Resultados de la consulta.

Solicitud de ejemplo

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

Respuesta de ejemplo

{
  "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 ...",
    }
  ]
}

Estructuras de datos

QueryFilter

Nombre del campo Tipo Descripción
statuses Matriz de QueryStatus Estados de las consultas.
user_ids Matriz de INT64 Los IDs de los usuarios que ejecutaron las consultas.
endpoint_ids Matriz de STRING Los IDs de los puntos de conexión en los que se ejecutaron las consultas.
query_start_time_range TimeRange Intervalo de tiempo de cuándo se iniciaron las consultas.

QueryInfo

Nombre del campo Tipo Descripción
query_id INT64 Id. de consulta.
status QueryStatus Estado de la consulta.
query_text STRING Texto de la consulta.
query_start_time_ms INT64 Hora a la que se inició la consulta.
execution_end_time_ms INT64 Hora a la que finalizó la ejecución de la consulta.
query_end_time_ms INT64 Hora a la que finalizó la consulta.
user_id INT64 Identificador del usuario que ejecutó la consulta.
nombre_de_usuario STRING Dirección de correo electrónico del usuario que ejecutó la consulta.
spark_ui_url STRING Dirección URL del plan de consulta.
endpoint_id STRING Id. de punto de conexión.
error_message STRING Mensaje que describe por qué no se pudo completar la consulta.
rows_produced INT32 Número de resultados devueltos por la consulta.

QueryStatus

Estado Descripción
QUEUED La consulta se ha recibido y puesto en cola.
RUNNING Se ha iniciado la ejecución de consultas.
CANCELED El usuario ha cancelado la consulta.
FAILED Error en la ejecución de la consulta.
FINISHED Se ha completado la ejecución de la consulta.

TimeRange

Nombre del campo Tipo Descripción
start_time_ms INT64 Limite los resultados a las consultas que se iniciaron después de este tiempo.
end_time_ms INT64 Limite los resultados a las consultas que se iniciaron antes de esta hora.