Freigeben über

api-Befehlsgruppe

  • Artikel

Hinweis

Diese Informationen gelten für die Databricks-CLI-Version 0.205 und höher, die als Public Preview verfügbar sind. Führen Sie databricks -v aus, um die Version Ihrer Databricks CLI zu ermitteln.

Mit der Befehlsgruppe api innerhalb der Databricks CLI können Sie jede verfügbare Databricks-REST-API aufrufen.

Sie sollten den Befehl api nur für erweiterte Szenarien verwenden, z. B. Vorschauversionen bestimmter Databricks-REST-APIs, für die die Databricks CLI die Databricks-Ziel-REST-API nicht bereits in einen zugehörigen Befehl umschließt. Eine Liste der umschlossenen Befehlsgruppen finden Sie unter Databricks-CLI-Befehle.

Wichtig

Informationen zum Installieren der Databricks CLI finden Sie unter Installieren oder Aktualisieren der Databricks CLI. Informationen zum Konfigurieren der Authentifizierung für die Databricks CLI finden Sie unter Authentifizierung für die Databricks CLI.

Ausführen von api-Befehlen (nur für erweiterte Szenarien)

Sie führen api-Befehle aus, indem Sie sie an databricks api anfügen. Führen Sie databricks api -h aus, um Hilfe zum api-Befehl anzuzeigen.

Verwenden Sie zum Aufrufen des Befehls api das folgende Format:

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

Im vorherigen Aufruf:

  • Ersetzen Sie <http-method> durch die HTTP-Methode für die Databricks-REST-API, die Sie aufrufen möchten, z. B. delete, get, head, path, post oder put. Verwenden Sie beispielsweise get, um die Liste der verfügbaren Cluster für einen Arbeitsbereich zurückzugeben. Informationen zum Abrufen der richtigen HTTP-Methode für die Databricks-REST-API, die Sie aufrufen möchten, finden Sie in der Dokumentation zur Databricks-REST-API.
  • Ersetzen Sie <rest-api-path> durch den Pfad zur Databricks-REST-API, die Sie aufrufen möchten. Schließen Sie https:// oder den Instanznamen des Arbeitsbereichs nicht ein. Verwenden Sie beispielsweise /api/2.0/clusters/list, um die Liste der verfügbaren Cluster für einen Arbeitsbereich zurückzugeben. Informationen zum Abrufen der richtigen Syntax für die Databricks-REST-API, die Sie aufrufen möchten, finden Sie in der Dokumentation zur Databricks-REST-API.
  • Wenn die aufzurufende Databricks-REST-API einen Anforderungstext erfordert, schließen Sie --json und <request-body> ein, und ersetzen Sie <request-body> durch den Anforderungstext im JSON-Format. Alternativ können Sie den Anforderungstext in einer separaten JSON-Datei speichern. Schließen Sie dazu --json und @<filename> ein, und ersetzen Sie <filename> durch den Namen der JSON-Datei. Informationen zum Abrufen der richtigen Syntax für den Anforderungstext, den Sie einschließen möchten, finden Sie in der Dokumentation zur Databricks-REST-API.

Beispiele

Rufen Sie die Liste der verfügbaren Cluster im Arbeitsbereich ab.

databricks api get /api/2.0/clusters/list

Rufen Sie Informationen zum angegebenen Cluster im Arbeitsbereich ab.

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

Aktualisieren Sie die Einstellungen für den angegebenen Cluster im Arbeitsbereich.

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

Aktualisieren Sie die Einstellungen für den angegebenen Cluster im Arbeitsbereich. Rufen Sie den Anforderungstext aus einer Datei namens edit-cluster.json im aktuellen Arbeitsverzeichnis ab.

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