Rozhraní API historie dotazů

Důležité

Tato funkce je ve verzi Public Preview. Pokud chcete požádat o přístup, obraťte se na zástupce Azure Databricks.

Důležité

Pokud chcete získat přístup k rozhraním REST API služby Databricks, musíte použít ověřování.

Seznam

Koncový bod HTTP – metoda
2.0/sql/history/queries GET

Vypíše historii dotazů prostřednictvím koncových bodů SQL. Můžete filtrovat podle ID uživatele, ID koncového bodu, stavu a časového rozsahu.

Žádost

Název pole Typ Popis
filter_by Atribut QueryFilter Filtr, který omezí výsledky historie dotazu. Toto pole je volitelné.
max_results INT32 Omezte počet výsledků vrácených na jedné stránce. Výchozí hodnota je 100.
page_token STRING Neprůhledný token, který se používá k získání další stránky výsledků. Toto pole je volitelné.

Odpověď

Název pole Typ Popis
next_page_token STRING Neprůhledný token, který slouží k získání další stránky.
has_next_page BOOLEAN Zda je k dispozici jiná stránka výsledků.
zdr Pole QueryInfo Výsledky dotazu.

Příklad požadavku

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

Příklad odpovědi

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

Datové struktury

Atribut QueryFilter

Název pole Typ Popis
stavy Pole QueryStatus Stavy dotazů.
user_ids Pole INT64 ID uživatelů, kteří spustili dotazy
endpoint_ids Pole STRING ID koncových bodů, na kterých byly dotazy spuštěny.
query_start_time_range Časový rozsah Časový rozsah, kdy byly dotazy zahájeny.

QueryInfo

Název pole Typ Popis
query_id INT64 ID dotazu
status QueryStatus Dotaz na stav.
query_text STRING Text dotazu
query_start_time_ms INT64 Čas spuštění dotazu.
execution_end_time_ms INT64 Čas, kdy bylo dokončeno zpracování dotazu.
query_end_time_ms INT64 Čas ukončení dotazu.
user_id INT64 ID uživatele, který spustil dotaz
user_name STRING E-mailová adresa uživatele, který spustil dotaz
spark_ui_url STRING Adresa URL plánu dotazu.
endpoint_id STRING ID koncového bodu
error_message STRING Zpráva s popisem, proč se dotaz nepodařilo dokončit.
rows_produced INT32 Počet výsledků vrácených dotazem.

QueryStatus

Status Popis
QUEUED Dotaz byl přijat a zařazen do fronty.
RUNNING Spuštění dotazu bylo spuštěno.
CANCELED Dotaz byl zrušen uživatelem.
FAILED Provádění dotazu se nezdařilo.
FINISHED Provádění dotazu bylo dokončeno.

Časový rozsah

Název pole Typ Popis
start_time_ms INT64 Omezí výsledky na dotazy, které byly zahájeny po tomto čase.
end_time_ms INT64 Omezí výsledky na dotazy, které začaly před tímto časem.