api مجموعة الأوامر

إشعار

تنطبق هذه المعلومات على إصدارات Databricks CLI 0.205 والإصدارات الأحدث، الموجودة في المعاينة العامة. للعثور على إصدار Databricks CLI الخاص بك، قم بتشغيل databricks -v.

api تمكنك مجموعة الأوامر داخل Databricks CLI من استدعاء أي واجهة برمجة تطبيقات Databricks REST متوفرة.

يجب تشغيل api الأمر فقط للسيناريوهات المتقدمة، مثل إصدارات المعاينة لواجهات برمجة تطبيقات REST الخاصة ب Databricks والتي لا يقوم Databricks CLI بتضمين واجهة برمجة تطبيقات Databricks REST الهدف لها ضمن أمر ذي صلة. للحصول على قائمة بمجموعات الأوامر الملتفة، راجع أوامر Databricks CLI.

هام

لتثبيت Databricks CLI، راجع تثبيت Databricks CLI أو تحديثه. لتكوين المصادقة ل Databricks CLI، راجع المصادقة ل Databricks CLI.

تشغيل api الأوامر (للسيناريوهات المتقدمة فقط)

يمكنك تشغيل api الأوامر عن طريق إلحاقها ب databricks api. لعرض تعليمات الأمر api ، قم بتشغيل databricks api -h.

لاستدعاء api الأمر، استخدم التنسيق التالي:

databricks api <http-method> <rest-api-path> [--json {<request-body> | @<filename>}]

في الاستدعاء السابق:

• استبدل <http-method> بأسلوب HTTP ل Databricks REST API التي تريد استدعاها، مثل deleteأو getأو headpathpostput. على سبيل المثال، لإرجاع قائمة المجموعات المتوفرة لمساحة عمل، استخدم get. للحصول على أسلوب HTTP الصحيح ل Databricks REST API التي تريد الاتصال بها، راجع وثائق Databricks REST API.
• استبدل <rest-api-path> بالمسار إلى Databricks REST API الذي تريد الاتصال به. لا تقم بتضمين https:// أو اسم مثيل مساحة العمل. على سبيل المثال، لإرجاع قائمة المجموعات المتوفرة لمساحة عمل، استخدم /api/2.0/clusters/list. للحصول على بناء الجملة الصحيح ل Databricks REST API التي تريد الاتصال بها، راجع وثائق Databricks REST API.
• إذا كانت Databricks REST API التي تريد الاتصال بها تتطلب نص طلب، فقم بتضمين --json و <request-body>، واستبدال مع <request-body> نص الطلب بتنسيق JSON. بدلا من ذلك، يمكنك تخزين نص الطلب في ملف JSON منفصل. للقيام بذلك، قم بتضمين --json و @<filename>، واستبدال <filename> باسم ملف JSON. للحصول على بناء الجملة الصحيح لنص الطلب الذي تريد تضمينه، راجع وثائق Databricks REST API.

الأمثلة

احصل على قائمة المجموعات المتوفرة في مساحة العمل.

databricks api get /api/2.0/clusters/list

الحصول على معلومات حول المجموعة المحددة في مساحة العمل.

databricks api post /api/2.0/clusters/get --json '{
   "cluster_id": "1234-567890-abcde123"
}'

تحديث الإعدادات لنظام المجموعة المحدد في مساحة العمل.

databricks api post /api/2.0/clusters/edit --json '{
  "cluster_id": "1234-567890-abcde123",
  "cluster_name": "my-changed-cluster",
  "num_workers": 1,
  "spark_version": "11.3.x-scala2.12",
  "node_type_id": "Standard_DS3_v2"
}'

تحديث الإعدادات لنظام المجموعة المحدد في مساحة العمل. احصل على نص الطلب من ملف مسمى edit-cluster.json داخل دليل العمل الحالي.

databricks api post /api/2.0/clusters/edit --json @edit-cluster.json

edit-cluster.json:

{
  "cluster_id": "1234-567890-abcde123",
  "cluster_name": "my-changed-cluster",
  "num_workers": 1,
  "spark_version": "11.3.x-scala2.12",
  "node_type_id": "Standard_DS3_v2"
}