쿼리 기록 API

중요

이 기능은 공개 미리 보기 상태입니다.

중요

Databricks REST API에 액세스하려면 인증해야 합니다.

목록

엔드포인트 HTTP 메서드
2.0/sql/history/queries GET

SQL 엔드포인트를통한 쿼리 기록을 나열합니다. 사용자 ID, 엔드포인트 ID, 상태 및 시간 범위를 기준으로 필터링할 수 있습니다.

요청

필드 이름 Type 설명
filter_by QueryFilter 쿼리 기록 결과를 제한하는 필터입니다. 이 필드는 선택 항목입니다.
max_results INT32 한 페이지에서 반환된 결과 수를 제한합니다. 기본값은 100입니다.
page_token STRING 결과의 다음 페이지를 얻는 데 사용되는 불투명 토큰입니다. 이 필드는 선택 항목입니다.

응답

필드 이름 Type Description
next_page_token STRING 다음 페이지를 얻는 데 사용되는 불투명 토큰입니다.
has_next_page BOOLEAN 결과의 다른 페이지가 있는지 여부입니다.
res QueryInfo의 배열 쿼리 결과

요청 예

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

데이터 구조

QueryFilter

필드 이름 Type Description
statuses QueryStatus의 배열 쿼리의 상태입니다.
user_ids INT64의 배열 쿼리를 실행한 사용자의 ID입니다.
endpoint_ids STRING의 배열 쿼리가 실행된 엔드포인트의 ID입니다.
query_start_time_range TimeRange 쿼리가 시작된 시간의 범위입니다.

QueryInfo

필드 이름 Type Description
query_id INT64 쿼리 ID입니다.
상태 QueryStatus 쿼리 상태입니다.
query_text STRING 쿼리 텍스트입니다.
query_start_time_ms INT64 쿼리가 시작된 시간입니다.
execution_end_time_ms INT64 쿼리 실행이 종료된 시간입니다.
query_end_time_ms INT64 쿼리가 종료된 시간입니다.
user_id INT64 쿼리를 실행한 사용자의 ID입니다.
사용자_이름 STRING 쿼리를 실행한 사용자의 이메일 주소입니다.
spark_ui_url STRING 쿼리 계획에 대한 URL입니다.
endpoint_id STRING 엔드포인트 ID입니다.
error_message STRING 쿼리를 완료할 수 없는 이유를 설명하는 메시지입니다.
rows_produced INT32 쿼리에서 반환된 결과 수입니다.

QueryStatus

상태 설명
QUEUED 쿼리가 수신되고 큐에 대기되었습니다.
RUNNING 쿼리 실행이 시작되었습니다.
CANCELED 사용자가 쿼리를 취소했습니다.
FAILED 쿼리를 실행하지 못했습니다.
FINISHED 쿼리 실행이 완료되었습니다.

TimeRange

필드 이름 Type 설명
start_time_ms INT64 이 시간 이후에 시작된 쿼리로 결과를 제한합니다.
end_time_ms INT64 이 시간 전에 시작된 쿼리로 결과를 제한합니다.