API de Histórico de Consultas

Importante

Esta funcionalidade está em Pré-visualização Pública. Para pedir acesso, contacte o seu representante do Azure Databricks.

Importante

Para aceder às APIs REST do Databricks, tem de se autenticar.

Lista

Ponto final Método HTTP
2.0/sql/history/queries GET

Listar a história das consultas através dos pontos finais SQL. Pode filtrar por ID do utilizador, ID de ponto final, estado e intervalo de tempo.

Pedir

Nome do Campo Tipo Descrição
filter_by Filtro de consulta Um filtro para limitar os resultados da história da consulta. Este campo é opcional.
max_results INT32 Limite o número de resultados devolvidos numa página. A predefinição é 100.
page_token STRING Token opaco usado para obter a próxima página de resultados. Este campo é opcional.

Resposta

Nome do Campo Tipo Descrição
next_page_token STRING Ficha opaca usada para obter a próxima página.
has_next_page BOOLEAN Se há outra página de resultados.
res Matriz de ConsultaInfo Resultados da consulta.

Pedido de exemplo

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

Resposta de exemplo

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

Estruturas de dados

Filtro de consulta

Nome do Campo Tipo Descrição
estatutos Matriz de QueryStatus Estados de consultas.
user_ids Matriz de INT64 IDs dos utilizadores que faziam as consultas.
endpoint_ids Matriz de STRING IDs de pontos finais sobre os quais as consultas correram.
query_start_time_range Intervalo de Tempo Intervalo de tempo de quando as consultas começaram.

QueryInfo

Nome do Campo Tipo Descrição
query_id INT64 Identificação de consulta.
status QueriaStatus Estado de consulta.
query_text STRING O texto da consulta.
query_start_time_ms INT64 A hora da consulta começar.
execution_end_time_ms INT64 A execução do tempo da consulta terminou.
query_end_time_ms INT64 A hora da consulta ter terminado.
user_id INT64 Identificação do utilizador que fez a consulta.
user_name STRING Endereço de e-mail do utilizador que executou a consulta.
spark_ui_url STRING URL para o plano de consulta.
endpoint_id STRING Identificação de ponto final.
error_message STRING Mensagem descrevendo por que a consulta não podia ser completada.
rows_produced INT32 O número de resultados devolvidos pela consulta.

QueriaStatus

Estado Descrição
QUEUED A consulta foi recebida e a pedido de uma fila.
RUNNING A execução de consultas começou.
CANCELED A consulta foi cancelada pelo utilizador.
FAILED A execução de consultas falhou.
FINISHED A execução de consultas terminou.

Intervalo de Tempo

Nome do Campo Tipo Descrição
start_time_ms INT64 Limite os resultados às consultas que começaram depois deste tempo.
end_time_ms INT64 Limite os resultados às consultas que começaram antes desta altura.