Bagikan melalui

api grup perintah

  • Artikel

Catatan

Informasi ini berlaku untuk Databricks CLI versi 0.205 ke atas. Databricks CLI ada di Pratinjau Umum.

Penggunaan Databricks CLI tunduk pada Lisensi Databricks dan Pemberitahuan Privasi Databricks, termasuk ketentuan Data Penggunaan apa pun.

api Grup perintah dalam Databricks CLI memungkinkan Anda memanggil Rest API Databricks yang tersedia.

Anda harus menjalankan api perintah hanya untuk skenario lanjutan, seperti rilis pratinjau API REST Databricks tertentu yang databricks CLI-nya belum membungkus TARGET Databricks REST API dalam perintah terkait. Untuk daftar grup perintah yang dibungkus, lihat perintah CLI Databricks.

Untuk menginstal Databricks CLI, lihat Menginstal atau memperbarui Databricks CLI. Untuk mengonfigurasi autentikasi untuk Databricks CLI, lihat Autentikasi untuk Databricks CLI.

Jalankan api perintah (hanya untuk skenario tingkat lanjut)

Anda menjalankan api perintah dengan menambahkannya ke databricks api. Untuk menampilkan bantuan untuk perintah, jalankan apidatabricks api -h.

Untuk memanggil api perintah, gunakan format berikut:

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

Dalam panggilan sebelumnya:

  • Ganti <http-method> dengan metode HTTP untuk Databricks REST API yang ingin Anda panggil, seperti delete, , gethead, path, post, atau put. Misalnya, untuk mengembalikan daftar kluster yang tersedia untuk ruang kerja, gunakan get. Untuk mendapatkan metode HTTP yang benar untuk Databricks REST API yang ingin Anda panggil, lihat dokumentasi Databricks REST API.
  • Ganti <rest-api-path> dengan jalur ke Databricks REST API yang ingin Anda panggil. Jangan sertakan https:// atau nama instans ruang kerja. Misalnya, untuk mengembalikan daftar kluster yang tersedia untuk ruang kerja, gunakan /api/2.0/clusters/list. Untuk mendapatkan sintaks yang benar untuk Databricks REST API yang ingin Anda panggil, lihat dokumentasi Databricks REST API.
  • Jika Databricks REST API yang ingin Anda panggil memerlukan isi permintaan, sertakan --json dan <request-body>, mengganti dengan isi <request-body> permintaan dalam format JSON. Atau, Anda dapat menyimpan isi permintaan dalam file JSON terpisah. Untuk melakukannya, sertakan --json dan @<filename>, ganti <filename> dengan nama file JSON. Untuk mendapatkan sintaks yang benar untuk isi permintaan yang ingin Anda sertakan, lihat dokumentasi Databricks REST API.

Contoh

Dapatkan daftar kluster yang tersedia di ruang kerja.

databricks api get /api/2.0/clusters/list

Dapatkan informasi tentang kluster yang ditentukan di ruang kerja.

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

Perbarui pengaturan untuk kluster yang ditentukan di ruang kerja.

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"
}'

Perbarui pengaturan untuk kluster yang ditentukan di ruang kerja. Dapatkan isi permintaan dari file bernama edit-cluster.json dalam direktori kerja saat ini.

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"
}