واجهة برمجة تطبيقات سجل الاستعلام

هام

هذه الميزة في المعاينة العامة.

هام

للوصول إلى واجهات برمجة التطبيقات Rest Databricks، يجب عليك المصادقة.

قائمة

نقطة النهاية أسلوب HTTP
2.0/sql/history/queries GET

سرد محفوظات الاستعلامات من خلال نقاط النهاية SQL. يمكنك التصفية حسب معرف المستخدم، معرف نقطة النهاية، الحالة، والنطاق الزمني.

طلب

اسم الحقل النوع الوصف
filter_by تصفية الاستعلام عامل تصفية للحد من نتائج سجل الاستعلام. هذا الحقل اختياري.
max_results INT32 حدد عدد النتائج التي تم إرجاعها في صفحة واحدة. الوضع الافتراضي هو 100.
page_token STRING رمز مميز مبهم يستخدم للحصول على الصفحة التالية من النتائج. هذا الحقل اختياري.

الاستجابة

اسم الحقل النوع الوصف
next_page_token STRING رمز مميز معتم يستخدم للحصول على الصفحة التالية.
has_next_page BOOLEAN ما إذا كان هناك صفحة أخرى من النتائج.
القرار صفيف الاستعلامInfo نتائج الاستعلام.

أمثلة على الطلب

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

هياكل البيانات

تصفية الاستعلام

اسم الحقل النوع الوصف
حالات صفيف من الاستعلاماستات حالات الاستعلامات.
user_ids صفيف من INT64 معرفات المستخدمين الذين قاموا بتشغيل الاستعلامات.
endpoint_ids صفيف من STRING معرفات نقاط النهاية التي تم تشغيل الاستعلامات عليها.
query_start_time_range المدى الزمني نطاق الوقت عند بدء تشغيل الاستعلامات.

الاستعلامInfo

اسم الحقل النوع الوصف
query_id INT64 معرف الاستعلام.
الحالة الاستعلاماستات حالة الاستعلام.
query_text STRING نص الاستعلام.
query_start_time_ms INT64 الوقت الذي بدأ فيه الاستعلام.
execution_end_time_ms INT64 انتهى تنفيذ الوقت للاستعلام.
query_end_time_ms INT64 الوقت الذي انتهى الاستعلام.
خاصية «user_id» INT64 معرف المستخدم الذي قام بتشغيل الاستعلام.
user_name STRING عنوان البريد الإلكتروني للمستخدم الذي قام بتشغيل الاستعلام.
spark_ui_url STRING URL لخطة الاستعلام.
endpoint_id STRING معرف نقطة النهاية.
error_message STRING رسالة تصف سبب تعذر إكمال الاستعلام.
rows_produced INT32 عدد النتائج التي تم إرجاعها بواسطة الاستعلام.

الاستعلاماستات

الحالة الوصف
QUEUED تم تلقي الاستعلام ووضعه في قائمة الانتظار.
RUNNING تم بدء تنفيذ الاستعلام.
CANCELED تم إلغاء الاستعلام من قبل المستخدم.
FAILED فشل تنفيذ الاستعلام.
FINISHED تم إكمال تنفيذ الاستعلام.

المدى الزمني

اسم الحقل النوع الوصف
start_time_ms INT64 قصر النتائج على الاستعلامات التي بدأت بعد هذا الوقت.
end_time_ms INT64 قصر النتائج على الاستعلامات التي بدأت قبل هذا الوقت.