Sorgu Geçmişi API’si

Önemli

Bu özellik Genel Önizlemededir. Erişim isteğinde bulunmak için Azure Databricks temsilcinizle iletişime geçin.

Önemli

Databricks REST API’lerine erişmek için kimlik doğrulaması yapmanız gerekir.

Liste

Uç Nokta HTTP Yöntemi
2.0/sql/history/queries GET

SQL uç noktaları aracılığıyla sorguların geçmişini listele. Kullanıcı kimliğine, uç nokta kimliğine, durumuna ve zaman aralığına göre filtre kullanabilirsiniz.

İstek

Alan Adı Tür Açıklama
filter_by QueryFilter Sorgu geçmişi sonuçlarını sınırlamak için bir filtre. Bu alan isteğe bağlıdır.
max_results INT32 Bir sayfada döndürülen sonuç sayısını sınırla. Varsayılan değer 100'dür.
page_token STRING Sonuçların bir sonraki sayfasını almak için kullanılan opak belirteç. Bu alan isteğe bağlıdır.

Yanıt

Alan Adı Tür Açıklama
next_page_token STRING Sonraki sayfayı almak için kullanılan opak belirteç.
has_next_page BOOLEAN Başka bir sonuç sayfası olup olmadığı.
Res QueryInfo Dizisi Sorgu sonuçları.

Örnek istek

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

Örnek yanıt

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

Veri yapıları

QueryFilter

Alan Adı Tür Açıklama
Durum QueryStatus dizisi Sorguların durumları.
user_ids Dizisi: INT64 Sorguların içinde yer alan kullanıcıların kimlikleri.
endpoint_ids Dizisi: STRING Sorguların üzerinde olduğu uç noktaların kimlikleri.
query_start_time_range TimeRange Sorguların başladığı zaman aralığı.

QueryInfo

Alan Adı Tür Açıklama
query_id INT64 Sorgu Kimliği.
durum QueryStatus Sorgu durumu.
Query_text STRING Sorgunun metni.
query_start_time_ms INT64 Sorgunun başladığı zaman.
execution_end_time_ms INT64 Sorgunun yürütülmesinin sona erer.
query_end_time_ms INT64 Sorgunun sona er olduğu zaman.
user_id INT64 Sorguyu çalıştıran kullanıcının kimliği.
Kullanıcı_adı STRING Sorguyu çalıştıran kullanıcının e-posta adresi.
spark_ui_url STRING Sorgu planının URL'si.
endpoint_id STRING Uç nokta kimliği.
Error_message STRING Sorgunun neden tamamlanamay olduğunu açıklayan ileti.
rows_produced INT32 Sorgu tarafından döndürülen sonuç sayısı.

QueryStatus

Durum Açıklama
QUEUED Sorgu alındı ve kuyruğa alındı.
RUNNING Sorgu yürütme başlatıldı.
CANCELED Sorgu kullanıcı tarafından iptal edildi.
FAILED Sorgu yürütme başarısız oldu.
FINISHED Sorgu yürütme tamamlandı.

TimeRange

Alan Adı Tür Açıklama
start_time_ms INT64 Sonuçları bu sürenin ardından başlayan sorgular ile sınırla.
end_time_ms INT64 Sonuçları bu süre öncesinde başlayan sorgular ile sınırla.